Export (0) Print
Expand All
Expand Minimize

sp_help_agent_default (Transact-SQL)

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.

Value

Description

1

Snapshot Agent.

2

Log Reader Agent.

3

Distribution Agent.

4

Merge Agent.

9

Queue 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.

Community Additions

ADD
Show:
© 2014 Microsoft