| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sp_help_agent_profile (Transact-SQL) |
Displays the profile of a specified agent. This stored procedure is executed at the Distributor on any database. |
markingmyname |
maghan |
randolphwest |
11/28/2023 |
sql |
replication |
reference |
|
|
|
[!INCLUDE SQL Server SQL MI]
Displays the profile of a specified agent. This stored procedure is executed at the Distributor on any database.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_help_agent_profile
[ [ @agent_type = ] agent_type ]
[ , [ @profile_id = ] profile_id ]
[ ; ]
The type of agent. @agent_type is int, and can be one of these values.
| Value | Description |
|---|---|
0 (default) |
All agent types |
1 |
Snapshot Agent |
2 |
Log Reader Agent |
3 |
Distribution Agent |
4 |
Merge Agent |
9 |
Queue Reader Agent |
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 name | Data type | Description |
|---|---|---|
profile_id |
int | ID of the profile. |
profile_name |
sysname | Unique for agent type. |
agent_type |
int | 1 = Snapshot Agent2 = Log Reader Agent3 = Distribution Agent4 = Merge Agent9 = Queue Reader Agent |
type |
int | 0 = System1 = Custom |
description |
varchar(3000) | Description of the profile. |
def_profile |
bit | Specifies 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.