sp_change_agent_profile (Transact-SQL)

Changes a parameter of a replication agent profile stored in the MSagent_profiles (Transact-SQL) table. This stored procedure is executed at the Distributor on any database.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_change_agent_profile [ @profile_id = ] profile_id 
        , [ @property = ] 'property' 
        , [ @value = ] 'value' 

Arguments

  • [ **@profile_id=** ] profile_id
    Is the ID of the profile. profile_id is int, with no default.

  • [ **@property=** ] 'property'
    Is the name of the property. property is sysname, with no default.

  • [ **@value=** ] 'value'
    Is the new value of the property. value is nvarchar(3000), with no default.

    This table describes the profile properties that can be changed.

    Property

    Description

    description

    Description for the profile.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_change_agent_profile is used in all types of replication.

Permissions

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