sp_add_agent_parameter (Transact-SQL)

Adiciona um novo parâmetro e seu valor a um perfil de agente. Esse procedimento armazenado é executado no Distribuidor, em qualquer banco de dados.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name' 
        , [ @parameter_value = ] 'parameter_value' 

Argumentos

  • [ @profile_id= ] profile_id
    É a ID de perfil da tabela MSagent_profiles no banco de dados msdb. profile_id é int, sem padrão.

    Para descobrir que tipo de agente esse profile_id representa, localize o profile_id na tabela MSagent_profiles (Transact-SQL) e observe o valor de campo agent_type. Os valores são os seguintes:

    Valor

    Descrição

    1

    Snapshot Agent

    2

    Log Reader Agent

    3

    Distribution Agent

    4

    Merge Agent

    9

    Queue Reader Agent.

  • [ @parameter_name= ] 'parameter_name'
    É o nome do parâmetro. parameter_name é sysname, sem padrão. Para uma lista de parâmetros já definida em perfis de sistema, consulte Perfis do Replication Agent. Para uma lista completa de parâmetros válidos para cada agente, consulte os seguintes tópicos:

  • [ @parameter_value=] 'parameter_value'
    É o valor a ser atribuído ao parâmetro. parameter_value é nvarchar (255), sem padrão.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Comentários

sp_add_agent_parameter é usado em replicação de instantâneo, replicação transacional e replicação de mesclagem.

Permissões

Somente membros da função de servidor fixa sysadmin podem executar sp_add_agent_parameter.