sp_add_agent_parameter (Transact-SQL)

将新参数及其值添加到代理配置文件中。 此存储过程在分发服务器的任何数据库中执行。

主题链接图标Transact-SQL 语法约定

语法

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

参数

  • [ @profile_id= ] profile_id
    来自 msdb 数据库中 MSagent_profiles 表的配置文件的 ID。profile_id 的数据类型为 int,无默认值。

    若要确定该 profile_id 表示什么代理类型,请查找 MSagent_profiles (Transact-SQL) 表中的 profile_id,并且注意 agent_type 字段值。值包括:

    说明

    1

    快照代理

    2

    日志读取器代理

    3

    分发代理

    4

    合并代理

    9

    队列读取器代理

  • [ @parameter_name=] 'parameter_name'
    参数的名称。parameter_name 的数据类型为 sysname,无默认值。 若要查看已在系统配置文件中定义的参数的列表,请参阅复制代理配置文件。 若要查看每个代理的有效参数的完整列表,请参阅下列主题:

  • [ @parameter_value=] 'parameter_value'
    赋给参数的值。parameter_value 的数据类型为 nvarchar(255),无默认值。

返回代码值

0(成功)或 1(失败)

注释

sp_add_agent_parameter 用于快照复制、事务复制和合并复制。

权限

只有 sysadmin 固定服务器角色的成员才能执行 sp_add_agent_parameter