| title | sp_help_agent_parameter (Transact-SQL) | ||
|---|---|---|---|
| description | Returns all the parameters of a profile from the MSagent_parameters system table. | ||
| author | markingmyname | ||
| ms.author | maghan | ||
| ms.reviewer | randolphwest | ||
| ms.date | 06/23/2025 | ||
| ms.service | sql | ||
| ms.subservice | replication | ||
| ms.topic | reference | ||
| f1_keywords |
|
||
| helpviewer_keywords |
|
||
| dev_langs |
|
[!INCLUDE SQL Server SQL MI]
Returns all the parameters of a profile from the MSagent_parameters system table. This stored procedure is executed at the Distributor where the agent is running, on any database.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_help_agent_parameter [ [ @profile_id = ] profile_id ]
[ ; ]
The ID of the profile from the MSagent_parameters table. @profile_id is int, with a default of -1, which returns all parameters.
| Column name | Data type | Description |
|---|---|---|
profile_id |
int | ID of the agent profile. |
parameter_name |
sysname | Name of the parameter. |
value |
nvarchar(255) | Value of the parameter. |
0 (success) or 1 (failure).
sp_help_agent_parameter 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_parameter.