sp_help_agent_profile (Transact-SQL)


Applies To: SQL Server

Displays the profile of a specified agent. This stored procedure is executed at the Distributor on any database.

Topic link icon Transact-SQL Syntax Conventions

sp_help_agent_profile [ [ @agent_type = ] agent_type ]   
    [ , [ @profile_id = ] profile_id ]  

[ @agent_type=] agent_type
Is the type of agent. agent_type is int, with a default of 0, and can be one of these values.

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

[ @profile_id=] profile_id
Is the ID of the profile to be displayed. profile_id is int, with a default of -1, which returns all the profiles in the MSagent_profiles table.

Column nameData typeDescription
profile_idintID of the profile.
profile_namesysnameUnique for agent type.
agent_typeint1 = Snapshot Agent

 2 = Log Reader Agent

 3 = Distribution Agent

 4 = Merge Agent

 9 = Queue Reader Agent
Typeint0 = System

 1 = Custom
descriptionvarchar(3000)Description of the profile.
def_profilebitSpecifies whether this profile is the default for this agent type.

0 (success) or 1 (failure)

sp_help_agent_profile is used in all types of replication.

Only members of the sysadmin fixed server role or the replmonitor fixed database role can execute sp_help_agent_profile.

Work with Replication Agent Profiles
sp_add_agent_profile (Transact-SQL)
sp_drop_agent_profile (Transact-SQL)
sp_help_agent_parameter (Transact-SQL)

Community Additions