text stringlengths 0 4.23k |
|---|
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} |
Displays the names of all remote event subscriptions that exist. |
{gs | get-subscription} <Subid> [/f:<Format>] [/uni:<Unicode>] |
Displays remote subscription configuration information. <Subid> is a string that uniquely identifies a subscription. It's the same as the string that was specified in the <SubscriptionId> tag of the XML configuration file, which was used to create the subscription. |
{gr | get-subscriptionruntimestatus} <Subid> [<Eventsource> …] |
Displays the runtime status of a subscription. <Subid> is a string that uniquely identifies a subscription. It's the same as the string that was specified in the <SubscriptionId> tag of the XML configuration file, which was used to create the subscription. <Eventsource> is a string that identifies a computer that serves as a source of events. It should be a fully qualified domain name, a NetBIOS name, or an IP address. |
{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>] |
Changes the subscription configuration. You can specify the subscription ID and the appropriate options to change subscription parameters, or you can specify an XML configuration file to change subscription parameters. |
{cs | create-subscription} <Configfile> [/cun:<Username> /cup:<Password>] |
Creates a remote subscription. <Configfile> specifies the path to the XML file that contains the subscription configuration. The path can be absolute or relative to the current directory. |
{ds | delete-subscription} <Subid> |
Deletes a subscription and unsubscribes from all event sources that deliver events into the event log for the subscription. Any events already received and logged are not deleted. <Subid> is a string that uniquely identifies a subscription. It's the same as the string that was specified in the <SubscriptionId> tag of the XML configuration file, which was used to create the subscription. |
{rs | retry-subscription} <Subid> [<Eventsource>…] |
Retries to establish a connection and send a remote subscription request to an inactive subscription. Attempts to reactivate all event sources or specified event sources. Disabled sources are not retried. <Subid> is a string that uniquely identifies a subscription. It's the same as the string that was specified in the <SubscriptionId> tag of the XML configuration file, which was used to create the subscription. <Eventsource> is a string that identifies a computer that serves as a source of events. It should be a fully qualified domain name, a NetBIOS name, or an IP address. |
{qc | quick-config} [/q:[<Quiet>]] |
Configures the Windows Event Collector service to ensure a subscription can be created and sustained through reboots. This includes the following steps:Enable the ForwardedEvents channel if it is disabled.Set the Windows Event Collector service to delay start.Start the Windows Event Collector service if it is not running. |
{es | enum-subscription} |
{gs | get-subscription} <Subid> [/f:<Format>] [/uni:<Unicode>] |
<Subid> |
<SubscriptionId> |
{gr | get-subscriptionruntimestatus} <Subid> [<Eventsource> …] |
<Subid> |
<SubscriptionId> |
<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>] |
{ss | set-subscription /c:<Configfile> [/cun:<Comusername> /cup:<Compassword>] |
{cs | create-subscription} <Configfile> [/cun:<Username> /cup:<Password>] |
<Configfile> |
{ds | delete-subscription} <Subid> |
<Subid> |
<SubscriptionId> |
{rs | retry-subscription} <Subid> [<Eventsource>…] |
<Subid> |
<SubscriptionId> |
<Eventsource> |
{qc | quick-config} [/q:[<Quiet>]] |
Options |
Option |
Description |
/f:<Format> |
Specifies the format of the information that is displayed. <Format> can be XML or Terse. If it's XML, the output is displayed in XML format. If it's Terse, the output is displayed in name-value pairs. The default is Terse. |
/c:<Configfile> |
Specifies the path to the XML file that contains a subscription configuration. The path can be absolute or relative to the current directory. This option can only be used with the /cun and /cup options and is mutually exclusive with all other options. |
/e:[<Subenabled>] |
Enables or disables a subscription. <Subenabled> can be true or false. The default value of this option is true. |
/esa:<Address> |
Specifies the address of an event source. <Address> is a string that contains a fully qualified domain name, a NetBIOS name, or an IP address, which identifies a computer that serves as a source of events. This option should be used with the /ese, /aes, /res, or /un and /up options. |
/ese:[<Srcenabled>] |
Enables or disables an event source. <Srcenabled> can be true or false. This option is allowed only if the /esa option is specified. The default value of this option is true. |
/aes |
Adds the event source that is specified by the /esa option if it is not already a part of the subscription. If the address specified by the /esa option is already a part of the subscription, an error is reported. This option is only allowed if the /esa option is specified. |
/res |
Removes the event source that is specified by the /esa option if it is already a part of the subscription. If the address specified by the /esa option is not a part of the subscription, an error is reported. This option is only allowed if /esa option is specified. |
/un:<Username> |
Specifies the user credential to use with the event source specified by the /esa option. This option is only allowed if the /esa option is specified. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.