showeventsource

You can use the showeventsource command to display information about event sources.

Overview

Event sources are used by HCL Universal Orchestrator to receive events from specific event plug-ins. You can use the showeventsource command to display details about event sources.

Syntax and command line options

The showeventsource command supports the following arguments:

ocli plan showeventsource | se [[folder/]eventsource] ;events ;from ;to ;triggering ;untriggering
[folder/]eventsource
You can specify the name of the specific event source that you want display. You can also specify the folder in which the event source is defined, which is optional.

The details that are displayed are:

showeventsource
The result includes the following information:
  • EventSource

    The name of the event source.

  • Status
    The status of the event source. It can be either:
    • ONLINE
    • OFFLINE
  • ActualStatus
    The actual status of the event source:
    • LISTENING
    • CONNECTED
    • DISCONNECTED
    • ERROR
  • Message

    It displays the error message if the actual status of the event source is ERROR.

events
You can filter the events received by an event source using the following commands:
  • from=HHmm

    Filters all events received from a specific date and time.

  • to=HHmm

    Filters all events received until a specific date and time.

  • triggering

    Filters all events that match events defined in job streams.

    untriggering

    Filters all events that do not match any events defined in job streams.

If you add the events option to the command, the displayed results include the following information:

  • Plugin

    The plug-in type the event source receives events from.

  • EventType

    The event type of the events received by the event source.

  • Received Time

    The date and time the event source received the event.

  • Scope / Match

    Describes the event received by the related eventsource.

    This information is followed up by the name of the job streams that contains the event conditions that match the event received. If the received event does not match any job stream, no job streams are displayed.

Examples

  1. To display all event sources, run the following command:
    ocli plan se @
    A sample output for this command is as follows:
    
         EventSource       Status     ActualStatus     Message                     

         MY_SOURCE         ONLINE     LISTENING                                    

         NEW_EVENT_SOURCE  ONLINE     LISTENING                                    

         MY_SOURCE_OFFLINE OFFLINE    DISCONNECTED
  2. To display all the events received from all event sources in a specific date and time interval, run the following command:
    ocli plan se ;events ;from=1500 ;to=1520
    A sample output for this command is as follows:
    
         EventSource       EventType         Plugin            Received Time     Scope / Match

         /eventsource1     WebhookEvent      Webhook           02/01 15:13:09    PATCH
         /eventsource1     WebhookEvent      Webhook           02/01 15:13:49    PATCH - ContentType: application/json
         /eventsource1     WebhookEvent      Webhook           02/01 15:14:17    POST - ContentType: application/json
                                                                                  /WS_AGT_0#/JOBSTREAM2
         /eventsource1     WebhookEvent      Webhook           02/01 15:14:54    POST - ContentType: application/json 
                                                                                  /WS_AGT_0#/JOBSTREAM2 
         /eventsource1     WebhookEvent      Webhook           02/01 15:15:21    POST
                                                                                  /WS_AGT_0#/JOBSTREAM2
  3. To display all the received events from all event sources that match any job streams, run the following command:
    ocli plan se ;events ;triggering
    A sample output for this command is as follows:
    
         EventSource       EventType         Plugin            Received Time     Scope / Match

         /eventsource1     WebhookEvent      Webhook           02/01 15:14:17    POST - ContentType: application/json
                                                                                  /WS_AGT_0#/JOBSTREAM2
         /eventsource1     WebhookEvent      Webhook           02/01 15:14:54    POST - ContentType: application/json 
                                                                                  /WS_AGT_0#/JOBSTREAM2 
         /eventsource1     WebhookEvent      Webhook           02/01 15:15:21    POST
                                                                                  /WS_AGT_0#/JOBSTREAM2
  4. To display all the received events from all event sources that do not match any job streams, run the following command:
    ocli plan se ;events ;untriggering
    A sample output for this command is as follows:
    
         EventSource       EventType         Plugin            Received Time     Scope / Match

         /eventsource1     WebhookEvent      Webhook           02/01 15:13:09    PATCH
         /eventsource1     WebhookEvent      Webhook           02/01 15:13:49    PATCH - ContentType: application/json