sp_add_agent_parameter (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 は、スナップショット レプリケーション、トランザクション レプリケーション、およびマージ レプリケーションで使用します。

権限

sp_add_agent_parameter を実行できるのは、sysadmin 固定サーバー ロールのメンバだけです。

関連項目

タスク

参照