Export (0) Print
Expand All
Expand Minimize

sp_add_agent_profile

SQL Server 2000

Creates a new profile for a replication agent. This stored procedure is executed at the Distributor on any database.

Syntax

sp_add_agent_profile [ [ @profile_id = ] profile_id OUTPUT ]
    { , [ @profile_name = ] 'profile_name' [ , [ @agent_type = ] 'agent_type' ] }
    [ , [ @profile_type = ] profile_type ]
    , [ @description = ] 'description'
    [ , [ @default = ] default ]

Arguments

[@profile_id = ] profile_id

Is the ID associated with the newly inserted profile. profile_id is int and is an optional OUTPUT parameter. If specified, the value is set to the new profile ID.

[@profile_name = ] 'profile_name'

Is the name of the profile. profile_name is sysname, with no default.

[@agent_type = ] 'agent_type'

Is the type of replication agent. agent_type is int, with no default, and can be one of these values.

Value Description
1 Snapshot Agent
2 Log Reader Agent
3 Distribution Agent
4 Merge Agent
9 Queue Reader Agent

[@profile_type = ] profile_type

Is the type of profile. profile_type is int, with a default of 1. 0 indicates a system profile. 1 indicates a custom profile. Only custom profiles can be created using this stored procedure. Only SQL Server creates system profiles.

[@description = ] 'description'

Is a description of the profile. description is nvarchar(3000), with no default.

[@default = ] default

Indicates whether the profile is the default for agent_type. default is bit, with a default of 0. 0 indicates that the profile is not a default. 1 indicates that the profile being added will become the new default profile for the agent specified by the @agent_type parameter.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_add_agent_profile is used in snapshot replication, transactional replication, and merge replication.

A row is added for the configuration in the MSagent_profiles table.

Permissions

Only members of the sysadmin fixed server role can execute sp_add_agent_profile.

See Also

sp_add_agent_parameter

sp_change_agent_parameter

sp_change_agent_profile

sp_drop_agent_parameter

sp_drop_agent_profile

sp_help_agent_parameter

sp_help_agent_profile

System Stored Procedures

Show:
© 2014 Microsoft