Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

get-event-by-id operation

The get-event-by-id operation retrieves an event that is identified by the specified globally unique identifier (GUID).

The following table describes the <items> XML and request elements for the get-event-by-id operation:

Adapter request elements for the get-event-by-id operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-event-by-id

Yes

<command-request>

Specifies the parent element for the command elements

Yes

<timeout-secs>

Specifies the duration after which the operation times out

Default value: 60 seconds

No

<command-parameters>

Specifies the parent element for the command parameters

Yes

<event-id>

Specifies the GUID of the event whose details are retrieved

Yes

The following figure illustrates a sample adapter request for the get-event-by-id operation:

Sample adapter request for the get-event-by-id operation

<scom-request>
  <operation-name>get-event-by-id</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <event-id>425d013b-bf1d-4109-9c3a-f52bb863acbd</event-id>
    </command-parameters>
  </command-request>
</scom-request>



The following figure illustrates the adapter response for the sample request:

Sample adapter response for the get-event-by-id operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command>./Microsoft.EnterpriseManagement.OperationsManager.ClientShell.
        Startup.ps1;get-event -id 06b171ac-d83f-42fb-b484-03aecd66c599</command>
        <execution-milliseconds>4578</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <Id>06b171ac-d83f-42fb-b484-03aecd66c599</Id>
          <OriginalId>9922f350-f488-42f4-a4a6-fbc6b2ffd251</OriginalId>
          <MonitoringObjectId>adb901fe-08f4-490e-722f-d65430015064</MonitoringObjectId>
          <MonitoringClassId>ab4c891f-3359-3fb6-0704-075fbfe36710</MonitoringClassId>
          <MonitoringObjectName />
          <MonitoringObjectDisplayName>win2stdvm.neuron.com</MonitoringObjectDisplayName>
          <MonitoringObjectPath>win2stdvm.neuron.com</MonitoringObjectPath>
          <MonitoringObjectFullName>win2stdvm.neuron.com</MonitoringObjectFullName>
          <MonitoringRuleId>fe17ed88-9f59-8b80-b1a5-ee42b80b95c8</MonitoringRuleId>
          <MonitoringRuleDisplayName>Collect Distributed Workflow Test Event</MonitoringRuleDisplayName>
          <MonitoringRuleDescription>Collects events logged by the "Log
           Distributed Workflow Test Event" rule</MonitoringRuleDescription>
          <PublisherName>Health Service Script</PublisherName>
          <Number>6022</Number>
          <Description>LogEndToEndEvent.js : This event is logged to the Windows
           Event Log periodically to test a event collection.</Description>
          <CategoryId>0</CategoryId>
          <Category />
          <User>N/A</User>
          <Channel>Operations Manager</Channel>
          <LevelId>4</LevelId>
          <Level />
          <LoggingComputer>WIN2STDVM</LoggingComputer>
          <EventData />
          <Parameters>{LogEndToEndEvent.js, This event is logged to the Windows
           Event Log periodically to test a event collection.}</Parameters>
          <TimeGenerated>04/03/2009 10:00:00 AM</TimeGenerated>
          <TimeAdded>04/03/2009 10:00:14 AM</TimeAdded>
          <ManagementGroup>M1</ManagementGroup>
          <ManagementGroupId>ae1fcf8a-8088-31d8-93ec-90fe77a32d44</ManagementGroupId>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>
Was this page helpful? Yes No Submitting... Thank you

Comments