リモート コンピューターから転送されるイベントのサブスクリプションを作成および管理できます。 リモート コンピューターは、WS-Management プロトコルをサポートする必要があります。
Important
メッセージが表示された場合は、"RPC サーバーは使用できませんか?wecutil を実行しようとすると、Windows イベント コレクター サービス (wecsvc) を開始する必要があります。 wecsvc を起動するには、管理者特権のコマンド プロンプトで「 net start wecsvc」と入力します。
Syntax
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>]]]
Parameters
| Parameter | Description |
|---|---|
{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 イベント コレクター サービスを構成します。 これには、次の手順が含まれます。
|
オプション
| Option | Description |
|---|---|
/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 モードでは、配信モード、配信最大項目数、ハートビート間隔、および配信最大遅延時間を設定します。
/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> はプルまたはプッシュのいずれかです。 このオプションは、 /cm オプションが [カスタム] に設定されている場合にのみ有効です。 |
/dmi:<Deliverymax> |
バッチ配信のアイテムの最大数を設定します。 このオプションは、 /cm が [カスタム] に設定されている場合にのみ有効です。 |
/dmlt:<Deliverytime> |
イベントのバッチ配信の最大待機時間を設定します。
<Deliverytime> はミリ秒単位です。 このオプションは、 /cm が [カスタム] に設定されている場合にのみ有効です。 |
/hi:<Heartbeat> |
ハートビート間隔を定義します。
<Heartbeat> はミリ秒単位です。 このオプションは、 /cm が [カスタム] に設定されている場合にのみ有効です。 |
/cf:<Content> |
返されるイベントの形式を指定します。
<Content> イベントまたは RenderedText を指定できます。 値が RenderedText の場合、イベントは、ローカライズされた文字列 (イベントの説明など) がイベントに添付された状態で返されます。 既定値は RenderedText です。 |
/l:<Locale> |
ローカライズされた文字列を RenderedText 形式で配信するためのロケールを指定します。
<Locale> は、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 です。 |
Examples
構成ファイルの内容を表示するには、次のように入力します。
<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
Example output:
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