get-alert-by-ticketid operation

The get-alert-by-ticketid operation retrieves the alert that is identified by the specified ticket ID.

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

Adapter request elements for the get-alert-by-ticketid operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-alert-by-ticketid

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

<alert-search-criteria>

Specifies the parent element for defining the search criterion

Yes

<criteria-expression>

Specifies the parent element for a single search criterion

You can specify more than one filter criterion by using multiple <criteria-expression> elements.

Yes

<key>

Specifies the alert attribute used in the search

Valid value: TicketId

Yes

<value>

Specifies the ticket ID that identifies the alert

Yes

<operator>

Specifies an operator

  • If you specify this element under the <alert-search-criteria> element, it specifies the operator between multiple <criteria-expression> elements.

    Valid values: and, or
  • If you specify this element under the <criteria-expression> element, it specifies the operator for <key> and <value> elements.

    Valid values: equals, not equals, like, greater than, less than, in (to be used when the ID is used as a key)

Yes

The following figure illustrates a sample adapter request for the get-alert-by-ticketid operation:

Sample adapter request for the get-alert-by-ticketid operation

<scom-request>
  <operation-name>get-alert-by-ticketid</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <alert-search-criteria>
        <criteria-expression>
          <key>TicketId</key>
          <value>ABC-1001</value>
          <operator>equals</operator>
        </criteria-expression>
      </alert-search-criteria>
    </command-parameters>
  </command-request>
</scom-request>



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

Sample adapter response for the get-alert-by-ticketid operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command>./Microsoft.EnterpriseManagement.OperationsManager.ClientShell.
        Startup.ps1;get-alert -criteria {TicketId = 'ABC-1001'}</command>
        <execution-milliseconds>4625</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <Id>0991a3e7-285d-48e0-b7f7-7845cd8cf075</Id>
          <Name>Total Percentage Interrupt Time is too high</Name>
          <Description>The threshold for the Processor\% Interrupt Time\_Total
           performance counter has been exceeded. The value that exceeded the
           threshold is:10.542126083374.</Description>
          <MonitoringObjectId>b37fae0e-a654-3a8b-b6f1-139dbe05b573</MonitoringObjectId>
          <MonitoringClassId>66dd9b43-3dc1-3831-95d4-1b03b0a6ea13</MonitoringClassId>
          <MonitoringObjectDisplayName>Microsoft(R) Windows(R) Server 2003,
           StandardEdition</MonitoringObjectDisplayName>
          <MonitoringObjectName />
          <MonitoringObjectPath>win2stdvm.neuron.com</MonitoringObjectPath>
          <MonitoringObjectFullName>Microsoft.Windows.OperatingSystem:win2stdvm.
          neuron.com</MonitoringObjectFullName>
          <IsMonitorAlert>True</IsMonitorAlert>
          <ProblemId>35b08472-f25f-de2f-7158-0a98f6af4dd3</ProblemId>
          <MonitoringRuleId>35b08472-f25f-de2f-7158-0a98f6af4dd3</MonitoringRuleId>
          <ResolutionState>255</ResolutionState>
          <Priority>Normal</Priority>
          <Severity>Error</Severity>
          <Category>PerformanceHealth</Category>
          <Owner />
          <ResolvedBy>System</ResolvedBy>
          <TimeRaised>2/16/2009 6:35:52 AM</TimeRaised>
          <TimeAdded>2/16/2009 6:35:52 AM</TimeAdded>
          <LastModified>2/18/2009 5:25:21 AM</LastModified>
          <LastModifiedBy>WIN2STDVM\Administrator</LastModifiedBy>
          <TimeResolved>2/16/2009 6:41:52 AM</TimeResolved>
          <TimeResolutionStateLastModified>2/16/2009 6:41:52
           AM</TimeResolutionStateLastModified>
          <CustomField1 />
          <CustomField2 />
          <CustomField3 />
          <CustomField4 />
          <CustomField5 />
          <CustomField6 />
          <CustomField7 />
          <CustomField8 />
          <CustomField9 />
          <CustomField10 />
          <TicketId>ABC-1001</TicketId>
          <Context><DataItem type="System.Performance.Data" time="2009-02-
          16T11:41:52.3270000+05:00" sourceHealthServiceId="ADB901FE-08F4-490E-
          722F-D65430015064"><TimeSampled>2009-02-16T11:41:52.0000000+05:00</TimeSampled>
           <ObjectName>Processor</ObjectName><CounterName>% Interrupt Time</CounterName>
           <InstanceName>_Total</InstanceName><IsNull Type="Boolean">false</IsNull>
           <Value>7.87469159960747</Value></DataItem></Context>
          <ConnectorId />
          <LastModifiedByNonConnector>2/18/2009 5:25:21 AM</LastModifiedByNonConnector>
          <MonitoringObjectInMaintenanceMode>False</MonitoringObjectInMaintenanceMode>
          <MonitoringObjectHealthState>Success</MonitoringObjectHealthState>
          <ConnectorStatus>NotMarkedForForwarding</ConnectorStatus>
          <RepeatCount>0</RepeatCount>
          <NetbiosComputerName>win2stdvm</NetbiosComputerName>
          <NetbiosDomainName>SYNAPSE</NetbiosDomainName>
          <PrincipalName>win2stdvm.neuron.com</PrincipalName>
          <SiteName />
          <MaintenanceModeLastModified>1/1/1900 12:00:00 AM</MaintenanceModeLastModified>
          <StateLastModified>2/16/2009 6:41:52 AM</StateLastModified>
          <Parameters>{10.542126083374}</Parameters>
          <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