Arguments

Is the name of the Publisher database. publisher_db is sysname, with no default.

[@publication= ] 'publication'

Is the name of the publication. publication is sysname, with no default.

[@subscriber= ] 'subscriber'

Is the name of the Subscriber. subscriber is sysname, with a default of NULL.

[@subscriber_db= ] 'subscriber_db'

Is the name of the subscription database. subscriber_db is sysname, with a default of NULL.

[@subscriber_security_mode= ] subscriber_security_mode

Is the security mode to use when connecting to a Subscriber when synchronizing. subscriber_security_mode is int, with a default of NULL. 0 specifies Microsoft SQL Server Authentication. 1 specifies Microsoft Windows Authentication.

[@subscriber_login = ]'subscriber_login'

Is the Subscriber login to use when connecting to a Subscriber when synchronizing. subscriber_login is sysname, with a default of NULL.

[@subscriber_password= ] 'subscriber_password'

Is the Subscriber password. subscriber_password is required if subscriber_security_mode is set to 0. subscriber_password is sysname, with a default of NULL. If a subscriber password is used, it is automatically encrypted.

Security Note NULL passwords are not recommended.

[@distributor= ] 'distributor'

Is the name of the Distributor. distributor is sysname, with a default of the value specified by publisher.

[@distribution_db=] 'distribution_db'

Is the name of the Distributor. distribution_db is sysname, with no default.

[@distributor_security_mode= ] distributor_security_mode

Is the security mode to use when connecting to a Distributor when synchronizing. distributor_security_mode is int, with a default of 0. 0 specifies Microsoft SQL Server Authentication. 1 specifies Microsoft Windows Authentication.

[@distributor_login= ] 'distributor_login'

Is the Distributor login to use when connecting to a Distributor when synchronizing. distributor_login is required if distributor_security_mode is set to 0.distributor_login is sysname, with a default of sa.

[@distributor_password = ] 'distributor_password'

Is the Distributor password. distributor_password is required if distributor_security_mode is set to 0. distributor_password is sysname, with a default of NULL.

[@optional_command_line= ] 'optional_command_line'

Is an optional command prompt supplied to the Distribution Agent. For example, -DefinitionFile C:\Distdef.txt or -CommitBatchSize 10. optional_command_line is nvarchar(4000), with a default of empty string.

[@frequency_type= ] frequency_type

Is the frequency with which to schedule the Distribution Agent. frequency_type is int, and can be one of these values.

Value

Description

1

One time

2 (default)

On demand

4

Daily

8

Weekly

16

Monthly

32

Monthly relative

64

Autostart

124

Recurring

[@frequency_interval= ] frequency_interval

Is the value to apply to the frequency set by frequency_type. frequency_interval is int, with a default of 1.

[@frequency_relative_interval= ] frequency_relative_interval

Is the date of the Distribution Agent. This parameter is used when frequency_type is set to 32 (monthly relative). frequency_relative_interval is int, and can be one of these values.

Value

Description

1 (default)

First

2

Second

4

Third

8

Fourth

16

Last

[@frequency_recurrence_factor= ] frequency_recurrence_factor

Is the recurrence factor used by frequency_type. frequency_recurrence_factor is int, with a default of 1.

[@frequency_subday= ] frequency_subday

Is how often to reschedule during the defined period. frequency_subday is int, and can be one of these values.

Value

Description

1 (default)

Once

2

Second

4

Minute

8

Hour

[@frequency_subday_interval= ] frequency_subday_interval

Is the interval for frequency_subday. frequency_subday_interval is int, with a default of 1.

[@active_start_time_of_day= ] active_start_time_of_day

Is the time of day when the Distribution Agent is first scheduled, formatted as HHMMSS. active_start_time_of_day is int, with a default of 0.

[@active_end_time_of_day= ] active_end_time_of_day

Is the time of day when the Distribution Agent stops being scheduled, formatted as HHMMSS. active_end_time_of_day is int, with a default of 0.

[@active_start_date= ] active_start_date

Is the date when the Distribution Agent is first scheduled, formatted as YYYYMMDD. active_start_date is int, with a default of 0.

[@active_end_date= ] active_end_date

Is the date when the Distribution Agent stops being scheduled, formatted as YYYYMMDD. active_end_date is int, with a default of 0.

[@distribution_jobid = ] distribution_jobid OUTPUT

Is the ID of the Distribution Agent for this job. distribution_jobid is binary(16), with a default of NULL, and it is an OUTPUT parameter.

[@encrypted_distributor_password= ] encrypted_distributor_password

For internal use only.

[@enabled_for_syncmgr= ] 'enabled_for_syncmgr'

Is whether the subscription can be synchronized through Microsoft Synchronization Manager. enabled_for_syncmgr is nvarchar(5), with a default of FALSE. If false, the subscription is not registered with Synchronization Manager. If true, the subscription is registered with Synchronization Manager and can be synchronized without starting SQL Server Enterprise Manager.

[@ftp_address= ] 'ftp_address'

For backward compatibility only.

[@ftp_port= ] ftp_port

For backward compatibility only.

[@ftp_login= ] 'ftp_login'

For backward compatibility only.

[@ftp_password= ] 'ftp_password'

For backward compatibility only.

[@alt_snapshot_folder= ] 'alternate_snapshot_folder'

Specifies the location of the alternate folder for the snapshot. alternate_snapshot_folder is nvarchar(255), with a default of NULL.

[@working_directory = ] 'working_director'

Is the name of the working directory used to store data and schema files for the publication. working_directory is nvarchar(255), with a default of NULL. The name should be specified in UNC format.

[@use_ftp = ] 'use_ftp'

Specifies the use of FTP instead of the regular protocol to retrieve snapshots. use_ftp is nvarchar(5), with a default of FALSE.

[@publication_type = ] publication_type

Specifies the replication type of the publication. publication_type is a tinyint with a default of 0. If 0, publication is a transaction type. If 1, publication is a snapshot type. If 2, publication is a merge type.

[@dts_package_name = ] 'dts_package_name'

Specifies the name of the DTS package. dts_package_name is a sysname with a default of NULL. For example, to specify a package of DTSPub_Package, the parameter would be @dts_package_name = N'DTSPub_Package'.

[@dts_package_password = ] 'dts_package_password'

Specifies the password on the package, if there is one. dts_package_password is sysname with a default of NULL, which means a password is not on the package.

[@dts_package_location = ] 'dts_package_location'

Specifies the package location. dts_package_location is a nvarchar(12), with a default of SUBSCRIBER. The location of the package can be distributor or subscriber.

[@reserved = ] 'reserved'

For internal use only.

[@offloadagent = ] 'remote_agent_activation'

Specifies that the agent can be activated remotely. remote_agent_activation is bit, with a default of 0. 0 specifies the agent cannot be activated remotely. 1 specifies the agent will be activated remotely, and on the remote computer specified by remote_agent_server_name.

[@offloadserver = ] 'remote_agent_server_name'

Specifies the network name of server to be used for remote activation. remote_agent_server_name is sysname, with a default of NULL.

[@job_name = ] 'job_name'

For internal use only.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_addpullsubscription_agent is used in snapshot replication and transactional replication.

Permissions

Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_addpullsubscription_agent.