wecutil
リモート コンピューターから転送されるイベントに対するサブスクリプションを作成して管理できます。 リモート コンピューターで WS-Management プロトコルがサポートされている必要があります。
重要
wecutil を実行しようとすると "RPC サーバーを使用できません" というメッセージが表示される場合は、Windows イベント コレクター サービス (wecsvc) を開始する必要があります。 wecsvc を開始するには、管理者特権でのコマンド プロンプトで「net start wecsvc
」と入力します。
wecutil [{es | enum-subscription}] [{gs | get-subscription} <Subid> [/f:<Format>] [/uni:<Unicode>]] [{gr | get-subscriptionruntimestatus} <Subid> [<Eventsource> …]] [{ss | set-subscription} [<Subid> [/e:[<Subenabled>]] [/esa:<Address>] [/ese:[<Srcenabled>]] [/aes] [/res] [/un:<Username>] [/up:<Password>] [/d:<Desc>] [/uri:<Uri>] [/cm:<Configmode>] [/ex:<Expires>] [/q:<Query>] [/dia:<Dialect>] [/tn:<Transportname>] [/tp:<Transportport>] [/dm:<Deliverymode>] [/dmi:<Deliverymax>] [/dmlt:<Deliverytime>] [/hi:<Heartbeat>] [/cf:<Content>] [/l:<Locale>] [/ree:[<Readexist>]] [/lf:<Logfile>] [/pn:<Publishername>] [/essp:<Enableport>] [/hn:<Hostname>] [/ct:<Type>]] [/c:<Configfile> [/cun:<Username> /cup:<Password>]]] [{cs | create-subscription} <Configfile> [/cun:<Username> /cup:<Password>]] [{ds | delete-subscription} <Subid>] [{rs | retry-subscription} <Subid> [<Eventsource>…]] [{qc | quick-config} [/q:[<quiet>]]]
パラメーター | 説明 |
---|---|
{es | enum-subscription} |
存在するすべてのリモート イベント サブスクリプションの名前を表示します。 |
{gs | get-subscription} <Subid> [/f:<Format>] [/uni:<Unicode>] |
リモート サブスクリプションの構成情報を表示します。 <Subid> は、サブスクリプションを一意に識別する文字列です。 これは、サブスクリプションの作成に使用した XML 構成ファイルの <SubscriptionId> タグで指定されている文字列と同じです。 |
{gr | get-subscriptionruntimestatus} <Subid> [<Eventsource> …] |
サブスクリプションの実行時の状態を表示します。 <Subid> は、サブスクリプションを一意に識別する文字列です。 これは、サブスクリプションの作成に使用した XML 構成ファイルの <SubscriptionId> タグで指定されている文字列と同じです。 <Eventsource> は、イベントのソースとして機能するコンピューターを識別する文字列です。 完全修飾ドメイン名、NetBIOS 名、または IP アドレスを指定する必要があります。 |
{ss | set-subscription} <Subid> [/e:[<Subenabled>]] [/esa:<Address>] [/ese:[<Srcenabled>]] [/aes] [/res] [/un:<Username>] [/up:<Password>] [/d:<Desc>] [/uri:<Uri>] [/cm:<Configmode>] [/ex:<Expires>] [/q:<Query>] [/dia:<Dialect>] [/tn:<Transportname>] [/tp:<Transportport>] [/dm:<Deliverymode>] [/dmi:<Deliverymax>] [/dmlt:<Deliverytime>] [/hi:<Heartbeat>] [/cf:<Content>] [/l:<Locale>] [/ree:[<Readexist>]] [/lf:<Logfile>] [/pn:<Publishername>] [/essp:<Enableport>] [/hn:<Hostname>] [/ct:<Type>] OR {ss | set-subscription /c:<Configfile> [/cun:<Comusername> /cup:<Compassword>] |
サブスクリプションの構成を変更します。 サブスクリプション ID と、サブスクリプションのパラメーターを変更するための適切なオプションを指定できます。または、XML 構成ファイルを指定してサブスクリプションのパラメーターを変更することもできます。 |
{cs | create-subscription} <Configfile> [/cun:<Username> /cup:<Password>] |
リモート サブスクリプションを作成します。 <Configfile> は、サブスクリプションの構成を含む XML ファイルへのパスを指定します。 絶対パスでも、現在のディレクトリを基準とする相対パスでもかまいません。 |
{ds | delete-subscription} <Subid> |
サブスクリプションを削除し、サブスクリプションのイベント ログにイベントを配信するすべてのイベント ソースからサブスクライブを解除します。 既に受信してログに記録されているイベントは削除されません。 <Subid> は、サブスクリプションを一意に識別する文字列です。 これは、サブスクリプションの作成に使用した XML 構成ファイルの <SubscriptionId> タグで指定されている文字列と同じです。 |
{rs | retry-subscription} <Subid> [<Eventsource>…] |
接続の確立と、アクティブでないサブスクリプションへのリモート サブスクリプション要求の送信を、もう一度試みます。 すべてのイベント ソースまたは指定したイベント ソースの再アクティブ化を試みます。 無効なソースは再試行されません。 <Subid> は、サブスクリプションを一意に識別する文字列です。 これは、サブスクリプションの作成に使用した XML 構成ファイルの <SubscriptionId> タグで指定されている文字列と同じです。 <Eventsource> は、イベントのソースとして機能するコンピューターを識別する文字列です。 完全修飾ドメイン名、NetBIOS 名、または IP アドレスを指定する必要があります。 |
{qc | quick-config} [/q:[<Quiet>]] |
サブスクリプションを作成し、再起動しても維持できるように、Windows イベント コレクター サービスを構成します。 これには、次の手順が含まれます。
|
オプション | 説明 |
---|---|
/f:<Format> |
表示される情報の形式を指定します。 <Format> では、XML または Terse を指定できます。 XML の場合、出力は XML 形式で表示されます。 Terse の場合、出力は名前と値のペアで表示されます。 既定値は Terse です。 |
/c:<Configfile> |
サブスクリプションの構成を含む XML ファイルへのパスを指定します。 絶対パスでも、現在のディレクトリを基準とする相対パスでもかまいません。 このオプションは /cun および /cup オプションとのみ併用でき、他のすべてのオプションとは併用できません。 |
/e:[<Subenabled> ] |
サブスクリプションを有効または無効にします。 <Subenabled> には、true または false を指定できます。 このオプションの既定値は true です。 |
/esa:<Address> |
イベント ソースのアドレスを指定します。 <Address> は文字列であり、イベントのソースとして機能するコンピューターを示す完全修飾ドメイン名、NetBIOS 名、または IP アドレスを含みます。 このオプションは、/ese、/aes、/res、または /un と /up オプションと共に使用する必要があります。 |
/ese:[<Srcenabled> ] |
イベント ソースを有効または無効にします。 <Srcenabled> には、true または false を指定できます。 このオプションは、/esa オプションを指定した場合にのみ使用できます。 このオプションの既定値は true です。 |
/aes | /esa オプションで指定したイベント ソースがまだサブスクリプションに含まれていない場合、それを追加します。 /esa オプションで指定したアドレスがサブスクリプションに既に含まれる場合は、エラーが報告されます。 このオプションは、/esa オプションを指定した場合にのみ使用できます。 |
/res | /esa オプションで指定したイベント ソースがサブスクリプションに既に含まれる場合、それを削除します。 /esa オプションで指定したアドレスがサブスクリプションに含まれない場合は、エラーが報告されます。 このオプションは、/esa オプションを指定した場合にのみ使用できます。 |
/un:<Username> |
/esa オプションで指定したイベント ソースで使用するユーザー資格情報を指定します。 このオプションは、/esa オプションを指定した場合にのみ使用できます。 |
/up:<Password> |
ユーザー資格情報に対応するパスワードを指定します。 このオプションは、/un オプションを指定した場合にのみ使用できます。 |
/d:<Desc> |
サブスクリプションの説明を指定します。 |
/uri:<Uri> |
サブスクリプションによって使用されるイベントの種類を指定します。 <Uri> には、イベントのソースを一意に識別するために、イベント ソース コンピューターのアドレスと組み合わせた URI 文字列を格納します。 この URI 文字列は、サブスクリプション内のすべてのイベント ソース アドレスに使用されます。 |
/cm:<Configmode> |
構成モードを設定します。 <Configmode> には、次のいずれかの文字列を指定できます: Normal、Custom、MinLatency、MinBandwidth。 Normal、MinLatency、MinBandwidth の各モードでは、配信モード、配信の最大項目数、ハートビート間隔、配信の最大待機時間が設定されます。 構成モードを Custom に設定した場合にのみ、/dm、/dmi、/hi、または /dmlt オプションを指定できます。 |
/ex:<Expires> |
サブスクリプションの有効期限が切れる日時を設定します。 <Expires> は、XML または ISO8601 の標準日時形式 yyyy-MM-ddThh:mm:ss[.sss][Z] で定義する必要があります。T は日時の区切り記号で、Z は UTC 時刻を示します。 |
/q:<Query> |
サブスクリプションのクエリ文字列を指定します。 <Query> の形式は、異なる URI 値では異なる場合があり、サブスクリプションのすべてのソースに適用されます。 |
/dia:<Dialect> |
クエリ文字列で使用する方言を定義します。 |
/tn:<Transportname> |
リモート イベント ソースへの接続に使用するトランスポートの名前を指定します。 |
/tp:<Transportport> |
リモート イベント ソースへの接続時にトランスポートによって使用されるポート番号を設定します。 |
/dm:<Deliverymode> |
配信モードを指定します。 <Deliverymode> では、pull または push のいずれかを指定できます。 このオプションは、/cm オプションが Custom に設定されている場合にのみ有効です。 |
/dmi:<Deliverymax> |
バッチ配信での項目の最大数を設定します。 このオプションは、/cm が Custom に設定されている場合にのみ有効です。 |
/dmlt:<Deliverytime> |
イベントのバッチ配信での最大待機時間を設定します。 <Deliverytime> はミリ秒数です。 このオプションは、/cm が Custom に設定されている場合にのみ有効です。 |
/hi:<Heartbeat> |
ハートビートの間隔を定義します。 <Heartbeat> はミリ秒数です。 このオプションは、/cm が Custom に設定されている場合にのみ有効です。 |
/cf:<Content> |
返されるイベントの形式を指定します。 <Content> では、Events または RenderedText を指定できます。 値が RenderedText の場合、イベントはローカライズされた文字列 (イベントの説明など) として添付されて返されます。 既定値は RenderedText です。 |
/l:<Locale> |
RenderedText 形式でのローカライズされた文字列の配信のロケールを指定します。 <Locale> は、言語と国や地域の ID です (例: EN-us)。 このオプションは、/cf オプションが RenderedText に設定されている場合にのみ有効です。 |
/ree:[<Readexist> ] |
サブスクリプションに対して配信されるイベントを示します。 <Readexist> には true または false を指定できます。 <Readexist> を true にすると、既存のすべてのイベントがサブスクリプションのイベント ソースから読み取られます。 <Readexist> を false にすると、それ以降の (到着した) イベントのみが配信されます。 /ree オプションで値が指定されていない場合の既定値は true です。 /ree オプションが指定されていない場合の既定値は false です。 |
/lf:<Logfile> |
イベント ソースから受信したイベントを格納するために使用されるローカル イベント ログを指定します。 |
/pn:<Publishername> |
パブリッシャーの名前を指定します。 /lf オプションで指定したログを所有またはインポートするパブリッシャーを指定する必要があります。 |
/essp:<Enableport> |
リモート サービスのサービス プリンシパル名の後にポート番号を追加する必要があることを指定します。 <Enableport> には、true または false を指定できます。 <Enableport> を true にすると、ポート番号が付加されます。 ポート番号を付加するときは、イベント ソースへのアクセスが拒否されるのを防ぐために、何らかの構成が必要になる場合があります。 |
/hn:<Hostname> |
ローカル コンピューターの DNS 名を指定します。 この名前は、イベントをプッシュするためにリモート イベント ソースによって使用され、プッシュ サブスクリプションの場合にのみ使用する必要があります。 |
/ct:<Type> |
リモート ソース アクセスの資格情報の種類を設定します。 <Type> は次のいずれかの値にする必要があります: default、negotiate、digest、basic、localmachine。 既定値は default です。 |
/cun:<Comusername> |
独自のユーザー資格情報を持たないイベント ソースに使用する共有ユーザー資格情報を設定します。 このオプションを /c オプションと共に指定した場合、構成ファイルから取得される個々のイベント ソースの UserName と UserPassword の設定は無視されます。 特定のイベント ソースで異なる資格情報を使いたい場合は、別の ss コマンドのコマンド ラインで特定のイベント ソースに対して /un と /up オプションを指定することによって、この値を上書きする必要があります。 |
/cup:<Compassword> |
共有ユーザー資格情報のユーザー パスワードを設定します。 <Compassword> を * (アスタリスク) に設定すると、パスワードはコンソールから読み取られます。 このオプションは、/cun オプションが指定されている場合にのみ有効です。 |
/q:[<Quiet> ] |
構成手順で確認を求めるメッセージを表示するかどうかを指定します。 <Quiet> には、true または false を指定できます。 <Quiet> を true にすると、構成手順で確認のプロンプトは表示されません。 このオプションの既定値は false です。 |
構成ファイルの内容を表示するには、次のように入力します。
<Subscription xmlns=https://schemas.microsoft.com/2006/03/windows/events/subscription>
<Uri>https://schemas.microsoft.com/wbem/wsman/1/windows/EventLog</Uri>
<!-- Use Normal (default), Custom, MinLatency, MinBandwidth -->
<ConfigurationMode>Normal</ConfigurationMode>
<Description>Forward Sample Subscription</Description>
<SubscriptionId>SampleSubscription</SubscriptionId>
<Query><![CDATA[
<QueryList>
<Query Path=Application>
<Select>*</Select>
</Query>
</QueryList>]]
</Query>
<EventSources>
<EventSource Enabled=true>
<Address>mySource.myDomain.com</Address>
<UserName>myUserName</UserName>
<Password>*</Password>
</EventSource>
</EventSources>
<CredentialsType>Default</CredentialsType>
<Locale Language=EN-US></Locale>
</Subscription>
sub1 という名前のサブスクリプションの出力構成情報を表示するには、次のように入力します。
wecutil gs sub1
出力例:
EventSource[0]:
Address: localhost
Enabled: true
Description: Subscription 1
Uri: wsman:microsoft/logrecord/sel
DeliveryMode: pull
DeliveryMaxSize: 16000
DeliveryMaxItems: 15
DeliveryMaxLatencyTime: 1000
HeartbeatInterval: 10000
Locale:
ContentFormat: renderedtext
LogFile: HardwareEvents
sub1 という名前のサブスクリプションの実行時状態を表示するには、次のように入力します。
wecutil gr sub1
sub1 という名前のサブスクリプション構成を、WsSelRg2.xml という名前の新しい XML ファイルから更新するには、次のように入力します。
wecutil ss sub1 /c:%Windir%system32WsSelRg2.xml
sub2 という名前のサブスクリプション構成を複数のパラメーターで更新するには、次のように入力します。
wecutil ss sub2 /esa:myComputer /ese /un:uname /up:* /cm:Normal
sub1 という名前のサブスクリプションを削除するには、次のように入力します。
wecutil ds sub1