sp_help_agent_default (Transact-SQL)

 

Applies To: SQL Server

Retrieves the ID of the default configuration for the agent type passed as parameter. This stored procedure is executed at Distributor on any database.

Topic link icon Transact-SQL Syntax Conventions

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

[ @profile_id=] profile_idOUTPUT
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.

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

0 (success) or 1 (failure)

sp_help_agent_default 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_default.

System Stored Procedures (Transact-SQL)

Community Additions

ADD
Show: