Edit

sp_MSchange_merge_agent_properties (Transact-SQL)

  • Article

Applies to: SQL Server

Changes the properties of a Merge Agent job that runs at a SQL Server 2005 (9.x) or later version Distributor. This stored procedure is used to change properties when the Publisher runs on an instance of SQL Server 2000 (8.x). This stored procedure is executed at the Distributor on the distribution database.

Transact-SQL syntax conventions

Syntax

sp_MSchange_merge_agent_properties
    [ @publisher = ] N'publisher'
    , [ @publisher_db = ] N'publisher_db'
    , [ @publication = ] N'publication'
    , [ @subscriber = ] N'subscriber'
    , [ @subscriber_db = ] N'subscriber_db'
    , [ @property = ] N'property'
    , [ @value = ] N'value'
[ ; ]

Arguments

[ @publisher = ] N'publisher'

The name of the Publisher. @publisher is sysname, with no default.

[ @publisher_db = ] N'publisher_db'

The name of the publication database. @publisher_db is sysname, with no default.

[ @publication = ] N'publication'

The name of the publication. @publication is sysname, with no default.

[ @subscriber = ] N'subscriber'

The name of the Subscriber. @subscriber is sysname, with no default.

[ @subscriber_db = ] N'subscriber_db'

The name of the subscription database. @subscriber_db is sysname, with no default.

[ @property = ] N'property'

The publication property to change. @property is sysname, with no default.

[ @value = ] N'value'

The new property value. @value is nvarchar(524), with no default.

This table describes the properties of the Merge Agent job that can be changed and restrictions on the values for those properties.

Property Value Description
description A brief description of the subscription.
merge_job_login Login for the Microsoft Windows account under which the agent runs.
merge_job_password Password for the Windows account under which the agent job runs.
publisher_login Login to use when connecting to a Publisher to synchronize the subscription.
publisher_password Publisher password.

Do not use a blank password. Use a strong password.
publisher_security_mode 1 Windows Authentication.

When possible, use Windows authentication.
0 SQL Server Authentication.
subscriber_login Login to use when connecting to a Subscriber to synchronize the subscription.
subscriber_password Subscriber password.

Do not use a blank password. Use a strong password.
subscriber_security_mode 1 Windows Authentication.

When possible, use Windows authentication.
0 SQL Server Authentication.

After changing an agent login or password, you must stop and restart the agent before the change takes effect.

Return code values

0 (success) or 1 (failure).

Remarks

sp_MSchange_merge_agent_properties is used in merge replication.

When the Publisher runs on an instance of SQL Server 2005 (9.x) or later version, you should use sp_changemergesubscription to change properties of a Merge Agent job that synchronizes a push subscription that runs at the Distributor.

Permissions

Only members of the sysadmin fixed server role at the Distributor can execute sp_MSchange_merge_agent_properties.

Related content