sp_help_agent_profile (Transact-SQL)
Displays the profile of a specified agent. This stored procedure is executed at the Distributor on any database.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
sp_help_agent_profile [ [ @agent_type = ] agent_type ]
[ , [ @profile_id = ] profile_id ]
Arguments
[ @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.Value Description 1
Snapshot Agent
2
Log Reader Agent
3
Distribution Agent
4
Merge Agent
9
Queue 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.
Return Code Values
0 (success) or 1 (failure)
Result Sets
| Column name | Data type | Description |
|---|---|---|
profile_id |
int |
ID of the profile. |
profile_name |
sysname |
Unique for agent type. |
agent_type |
int |
1 = Snapshot Agent 2 = Log Reader Agent 3 = Distribution Agent 4 = Merge Agent 9 = Queue Reader Agent |
Type |
int |
0 = System 1 = Custom |
description |
varchar(3000) |
Description of the profile. |
def_profile |
bit |
Specifies whether this profile is the default for this agent type. |
Remarks
sp_help_agent_profile is used in all types of replication.
Permissions
Only members of the sysadmin fixed server role or the replmonitor fixed database role can execute sp_help_agent_profile.
See Also
Reference
sp_add_agent_profile (Transact-SQL)
sp_drop_agent_profile (Transact-SQL)
sp_help_agent_parameter (Transact-SQL)
Other Resources
How to: Work with Replication Agent Profiles (Replication Transact-SQL Programming)