sp_syscollector_run_collection_set (Transact-SQL)
コレクタが既に有効になっており、コレクション セットが非キャッシュ コレクション モード用に構成されている場合、コレクション セットを開始します。
注意 |
---|
このプロシージャをキャッシュ コレクション モード用に構成されているコレクション セットに対して実行すると、失敗します。 |
sp_syscollector_run_collection_set を使用すると、ユーザーはオンデマンドのデータ スナップショットを取得できます。
構文
sp_syscollector_run_collection_set [[ @collection_set_id = ] collection_set_id ]
, [[ @name = ] 'name' ]
引数
[ @collection_set_id = ] collection_set_id
コレクション セットの一意なローカル識別子を指定します。collection_set_id のデータ型は int で、name が NULL の場合は必ず値を指定する必要があります。[ @name = ] 'name'
コレクション セットの名前を指定します。name のデータ型は sysname で、collection_set_id が NULL の場合は必ず値を指定する必要があります。
リターン コードの値
0 (成功) または 1 (失敗)
説明
collection_set_id または name のいずれかを指定する必要があります。両方を NULL にすることはできません。
このプロシージャは、コレクションを開始し、指定されたコレクション セットのジョブをアップロードして、コレクション セットの @collection_mode が非キャッシュ (1) に設定されている場合は、直ちにコレクション エージェント ジョブを開始します。詳細については、「sp_syscollector_create_collection_set (Transact-SQL)」を参照してください。
sp_sycollector_run_collection_set は、スケジュールを持たないコレクション セットの実行にも使用できます。
権限
このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_operator 固定データベース ロールのメンバシップが必要です。
使用例
対応する ID を使ってコレクション セットを開始します。
USE msdb;
GO
EXEC sp_syscollector_run_collection_set @collection_set_id = 1