wecutil

Vous permet de créer et de gérer des abonnements aux événements qui sont transférés à partir d’ordinateurs distants. L’ordinateur distant doit prendre en charge le protocole WS-Management.

Important

Si vous recevez le message « Le serveur RPC n’est pas disponible » lorsque vous essayez d’exécuter wecutil, vous devez démarrer le service Collecteur d’événements Windows (wecsvc). Pour démarrer wecsvc, à une invite de commandes avec élévation de privilèges, saisissez net start wecsvc.

Syntaxe

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>]]]

Paramètres

Paramètre Description
{es | enum-subscription} Affiche les noms de tous les abonnements aux événements distants qui existent.
{gs | get-subscription} <Subid> [/f:<Format>] [/uni:<Unicode>] Affiche les informations de configuration de l’abonnement distant. <Subid> est une chaîne qui identifie un abonnement de manière unique. Elle est identique à la chaîne spécifiée dans la balise <SubscriptionId> du fichier de configuration XML, qui a été utilisée pour créer l’abonnement.
{gr | get-subscriptionruntimestatus} <Subid> [<Eventsource> …] Affiche l’état d’exécution d’un abonnement. <Subid> est une chaîne qui identifie un abonnement de manière unique. Elle est identique à la chaîne spécifiée dans la balise <SubscriptionId> du fichier de configuration XML, qui a été utilisée pour créer l’abonnement. <Eventsource> est une chaîne qui identifie un ordinateur qui sert de source d’événements. Il doit s’agir d’un nom de domaine complet, un nom NetBIOS ou une adresse 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>]
Modifie la configuration de l’abonnement. Vous pouvez spécifier l’ID d’abonnement et les options appropriées pour modifier les paramètres d’abonnement, ou vous pouvez spécifier un fichier de configuration XML pour modifier les paramètres d’abonnement.
{cs | create-subscription} <Configfile> [/cun:<Username> /cup:<Password>] Crée un abonnement distant. <Configfile> spécifie le chemin d’accès au fichier XML qui contient la configuration de l’abonnement. Le chemin d’accès peut être absolu ou relatif au répertoire actuel.
{ds | delete-subscription} <Subid> Supprime un abonnement et se désinscrit de toutes les sources d’événements qui fournissent des événements dans le journal des événements de l’abonnement. Tous les événements déjà reçus et enregistrés ne sont pas supprimés. <Subid> est une chaîne qui identifie un abonnement de manière unique. Elle est identique à la chaîne spécifiée dans la balise <SubscriptionId> du fichier de configuration XML, qui a été utilisée pour créer l’abonnement.
{rs | retry-subscription} <Subid> [<Eventsource>…] Réessayez d’établir une connexion et d’envoyer une requête d’abonnement à distance à un abonnement inactif. Tente de réactiver toutes les sources d’événements ou les sources d’événements spécifiées. Les sources désactivées ne sont pas retentées. <Subid> est une chaîne qui identifie un abonnement de manière unique. Elle est identique à la chaîne spécifiée dans la balise <SubscriptionId> du fichier de configuration XML, qui a été utilisée pour créer l’abonnement. <Eventsource> est une chaîne qui identifie un ordinateur qui sert de source d’événements. Il doit s’agir d’un nom de domaine complet, un nom NetBIOS ou une adresse IP.
{qc | quick-config} [/q:[<Quiet>]] Configure le service Collecteur d’événements Windows pour garantir la création et la maintenance d’un abonnement par le biais de redémarrages. Cela inclut les étapes suivantes :
  1. Activez le canal ForwardedEvents s’il est désactivé.
  2. Définissez le service Collecteur d’événements Windows pour retarder le démarrage.
  3. Démarrez le service Collecteur d’événements Windows s’il n’est pas en cours d’exécution.

Options

Option Description
/f:<Format> Spécifie le format des informations affichées. <Format> peut être au format XML ou Terse. S’il s’agit de XML, la sortie s’affiche au format XML. S’il s’agit de Terse, la sortie s’affiche en paires nom-valeur. La valeur par défaut est Terse.
/c:<Configfile> Spécifie le chemin d’accès au fichier XML qui contient une configuration d’abonnement. Le chemin d’accès peut être absolu ou relatif au répertoire actuel. Cette option ne peut être utilisée qu’avec les options /cun et /cup et s’exclut mutuellement avec toutes les autres options.
/e:[<Subenabled>] Active ou désactive un abonnement. <Subenabled> peut avoir la valeur « true » ou « false ». La valeur par défaut de cette option est true.
/esa:<Address> Spécifie l’adresse d’une source d’événement. <Address> est une chaîne qui contient un nom de domaine complet, un nom NetBIOS ou une adresse IP, qui identifie un ordinateur qui sert de source d’événements. Cette option doit être utilisée avec les options /ese, /aes, /res ou /un et /up.
/ese:[<Srcenabled>] Active ou désactive une source d’événement. <Srcenabled> peut avoir la valeur « true » ou « false ». Cette option est autorisée uniquement si l’option /esa est spécifiée. La valeur par défaut de cette option est true.
/aes Ajoute la source d’événement spécifiée par l’option /esa, si elle ne fait pas déjà partie de l’abonnement. Si l’adresse spécifiée par l’option /esa fait déjà partie de l’abonnement, une erreur est signalée. Cette option est autorisée uniquement si l’option /esa est spécifiée.
/res Supprimer la source d’événement spécifiée par l’option /esa, si elle fait déjà partie de l’abonnement. Si l’adresse spécifiée par l’option /esa ne fait pas déjà partie de l’abonnement, une erreur est signalée. Cette option est autorisée uniquement si l’option /esa est spécifiée.
/un:<Username> Spécifie les informations d’identification utilisateur à utiliser avec la source d’événement spécifiée par l’option /esa. Cette option est autorisée uniquement si l’option /esa est spécifiée.
/up:<Password> Spécifie le mot de passe qui correspond aux informations d’identification de l’utilisateur. Cette option est autorisée uniquement si l’option /un est spécifiée.
/d:<Desc> Fournit une description de l’abonnement.
/uri:<Uri> Spécifie le type des événements consommés par l’abonnement. <Uri> contient une chaîne d’URI qui est combinée à l’adresse de l’ordinateur source d’événements pour identifier de manière unique la source des événements. La chaîne d’URI est utilisée pour toutes les adresses sources d’événements de l’abonnement.
/cm:<Configmode> Définit le mode de configuration. <Configmode> peut être l’une des chaînes suivantes : Normal, Custom, MinLatency ou MinBandwidth. Les modes Normal, MinLatency et MinBandwidth définissent le mode de livraison, le nombre maximal d’éléments de livraison, l’intervalle de pulsation et le temps de latence maximal de livraison. Les options /dm, /dmi, /hi ou /dmlt ne peuvent être spécifiées que si le mode de configuration est défini sur Custom.
/ex:<Expires> Définit l’heure d’expiration de l’abonnement. <Expires> doit être défini au format de date-heure standard XML ou ISO8601 : yyyy-MM-ddThh:mm:ss[.sss][Z], où T est le séparateur d’heure et Z indique l’heure UTC.
/q:<Query> Spécifie la chaîne de requête pour l’abonnement. Le format de <Query> peut être différent pour différentes valeurs d’URI et s’applique à toutes les sources de l’abonnement.
/dia:<Dialect> Définit le dialecte utilisé par la chaîne de requête.
/tn:<Transportname> Spécifie le nom du transport utilisé pour se connecter à une source d’événements distante.
/tp:<Transportport> Définit le numéro de port utilisé par le transport lors de la connexion à une source d’événements distante.
/dm:<Deliverymode> Spécifie le mode de livraison. <Deliverymode> peut être « pull » ou « push ». Cette option n’est valide que si l’option /cm est définie sur Custom.
/dmi:<Deliverymax> Définit le nombre maximal d’éléments pour la livraison par lots. Cette option est valide uniquement si /cm est défini sur Custom.
/dmlt:<Deliverytime> Définit la latence maximale lors de la livraison d’un lot d’événements. <Deliverytime> représente le nombre de millisecondes. Cette option est valide uniquement si /cm est défini sur Custom.
/hi:<Heartbeat> Définit l’intervalle de pulsation. <Heartbeat> représente le nombre de millisecondes. Cette option est valide uniquement si /cm est défini sur Custom.
/cf:<Content> Spécifie le format des événements retournés. <Content> peut être Events ou RenderedText. Lorsque la valeur est RenderedText, les événements sont retournés avec les chaînes localisées (telles que la description de l’événement) attachées à l’événement. La valeur par défaut est RenderedText.
/l:<Locale> Spécifie les paramètres régionaux pour la livraison des chaînes localisées au format RenderedText. <Locale> est un identificateur de langue et de pays/région, par exemple, EN-us. Cette option n’est valide que si l’option /cf est définie sur RenderedText.
/ree:[<Readexist>] Identifie les événements fournis pour l’abonnement. <Readexist> peut avoir la valeur « true » ou « false ». Lorsque la valeur <Readexist> est « true », tous les événements existants sont lus à partir des sources d’événements d’abonnement. Lorsque la valeur <Readexist> est « false », seuls les événements futurs (arrivants) sont livrés. La valeur par défaut est true pour une option /ree sans valeur. Si aucune option /ree n’est spécifiée, la valeur par défaut est false.
/lf:<Logfile> Spécifie le journal des événements local utilisé pour stocker les événements reçus des sources d’événements.
/pn:<Publishername> Spécifie le nom de l’éditeur. Il doit s’agir d’un éditeur qui possède ou importe le journal spécifié par l’option /lf.
/essp:<Enableport> Spécifie que le numéro de port doit être ajouté au nom du principal du service distant. <Enableport> peut avoir la valeur « true » ou « false ». Le numéro de port est ajouté quand la valeur de <Enableport> est « true ». Lorsque le numéro de port est ajouté, une configuration peut être nécessaire pour empêcher le refus de l’accès aux sources d’événements.
/hn:<Hostname> Spécifie le nom DNS de l’ordinateur local. Ce nom est utilisé par la source d’événements distante pour transmettre les événements et doit être utilisé uniquement pour un abonnement push.
/ct:<Type> Définit le type d’informations d’identification pour l’accès à la source distante. <Type> doit être l’une des valeurs suivantes : default, negotiate, digest, basic ou localmachine. La valeur par défaut est default.
/cun:<Comusername> Définit les informations d’identification utilisateur partagées à utiliser pour les sources d’événements qui n’ont pas leurs propres informations d’identification utilisateur. Si cette option est spécifiée avec l’option /c, les paramètres UserName et UserPassword pour les sources d’événements individuelles du fichier de configuration sont ignorés. Si vous souhaitez utiliser des informations d’identification différentes pour une source d’événement spécifique, vous devez remplacer cette valeur en spécifiant les options /un et /up pour une source d’événement spécifique sur la ligne de commande d’une autre commande ss.
/cup:<Compassword> Définit le mot de passe utilisateur pour les informations d’identification utilisateur partagées. Lorsque <Compassword> est défini sur * (astérisque), le mot de passe est lu à partir de la console. Cette option est uniquement applicable quand l’option /cun est spécifiée.
/q:[<Quiet>] Spécifie si la procédure de configuration demande une confirmation. <Quiet> peut avoir la valeur « true » ou « false ». Si <Quiet> a la valeur « true », la procédure de configuration n’invite pas à confirmer. La valeur par défaut de cette option est false.

Exemples

Pour afficher le contenu d’un fichier de configuration, saisissez :

<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>

Pour afficher les informations de configuration de sortie d’un abonnement nommé sub1, saisissez :

wecutil gs sub1

Exemple de sortie :

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

Pour afficher l’état d’exécution d’un abonnement nommé sub1, saisissez :

wecutil gr sub1

Pour mettre à jour la configuration de l’abonnement nommée sub1 à partir d’un nouveau fichier XML appelé WsSelRg2.xml, saisissez :

wecutil ss sub1 /c:%Windir%system32WsSelRg2.xml

Pour mettre à jour la configuration de l’abonnement nommée sub2 avec plusieurs paramètres, saisissez :

wecutil ss sub2 /esa:myComputer /ese /un:uname /up:* /cm:Normal

Pour supprimer un abonnement nommé sub1, saisissez :

wecutil ds sub1