Share via

  • Article

sp_getagentparameterlist (Transact-SQL)

Returns a list of all replication agent parameters that can be set in an agent profile for the specified agent type. This stored procedure is executed at the Distributor where the agent is running, on any database.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_getagentparameterlist [ @agent_type = ] 'agent_type'

Arguments

  • [ @agent_type = ] 'agent_type'
    Is the replication agent for which the parameter is being added. agent_type is int, and can be one of these values:

    Value

    Agent

    1

    Snapshot

    2

    Log Reader

    3

    Distribution

    4

    Merge

    9

    Queue Reader

Return Code Values

0 (success) or 1 (failure)

Permissions

Only members of the sysadmin fixed server role can execute sp_getagentparameter.