sp_help_agent_default (T-SQL)

Retrieves the ID of the default configuration for the agent type passed as parameter.

Syntax

sp_help_agent_default [@profile_id =] profile_id OUTPUT,
[@agent_type =] agent_type

Arguments

[@profile_id =] profile_id OUTPUT

Is the ID of the default configuration for the type of agent. profile_id is int, with no default. profile_id is also an OUTPUT parameter and returns the ID of the default configuration for the type of agent.

[@agent_type =] 'agent_type'

Is the type of agent. agent_type is int, with no default, and can be one of these values.

Value	Description
1	Snapshot Agent
2	Log Reader Agent
3	Distribution Agent
4	Merge Agent

Remarks

sp_help_agent_default is used in all types of replication.

Permissions

Execute permissions default to the public role.