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-alert-by-description operation

The get-alert-by-description operation retrieves alerts that are identified by the specified description.

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

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

Element

Definition

Required

<operation-name>

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

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

Yes

<value>

Specifies the description that is associated with 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-description operation: 

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

<scom-request>
  <operation-name>get-alert-by-description</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <alert-search-criteria>
        <criteria-expression>
          <key>Description</key>
          <value>%jessica.neuron.com%</value>
          <operator>like</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-description 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 {Description LIKE '%jessica.neuron.com%'}</command>
        <execution-milliseconds>7515</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <Id>94f152ff-9238-4314-8b4c-44c4900729f9</Id>
          <Name>Computer Verification: Module Error</Name>
          <Description>Computer verification failure for Machine Name:
           jessica.neuron.com is 0x800706BA. The RPC server is unavailable.</Description>
          <MonitoringObjectId>adb901fe-08f4-490e-722f-d65430015064</MonitoringObjectId>
          <MonitoringClassId>ab4c891f-3359-3fb6-0704-075fbfe36710</MonitoringClassId>
          <MonitoringObjectDisplayName>win2stdvm.neuron.com</MonitoringObjectDisplayName>
          <MonitoringObjectName />
          <MonitoringObjectPath>win2stdvm.neuron.com</MonitoringObjectPath>
          <MonitoringObjectFullName>Microsoft.SystemCenter.HealthService:win2std
          vm.neuron.com</MonitoringObjectFullName>
          <IsMonitorAlert>False</IsMonitorAlert>
          <ProblemId>1589cca2-a049-3f33-0537-40254473669f</ProblemId>
          <MonitoringRuleId>80aa5832-77f3-153a-d2ad-44df9d48236b</MonitoringRuleId>
          <ResolutionState>0</ResolutionState>
          <Priority>Normal</Priority>
          <Severity>Warning</Severity>
          <Category>Alert</Category>
          <Owner />
          <ResolvedBy />
          <TimeRaised>2/4/2009 8:11:41 AM</TimeRaised>
          <TimeAdded>2/4/2009 8:11:41 AM</TimeAdded>
          <LastModified>2/4/2009 8:13:46 AM</LastModified>
          <LastModifiedBy>System</LastModifiedBy>
          <TimeResolved />
          <TimeResolutionStateLastModified>2/4/2009 8:11:41
           AM</TimeResolutionStateLastModified>
          <CustomField1 />
          <CustomField2 />
          <CustomField3 />
          <CustomField4 />
          <CustomField5 />
          <CustomField6 />
          <CustomField7 />
          <CustomField8 />
          <CustomField9 />
          <CustomField10 />
          <TicketId />
          <Context><DataItem type="Microsoft.Windows.EventData"time="2009-01-
          08T16:27:57.0001484+05:00" sourceHealthServiceId="ADB901FE-08F4-490E-
          722F-D65430015064"><EventOriginId>{767BDEC6-AE6B-4B40-AA3B-
                    91D8C23112D2}</EventOriginId><PublisherId>{2DFE7810-DE9F-
          785F-CD11-80E1C9EE8A67}</PublisherId><PublisherName>Health Service
           Modules</PublisherName><EventSourceName>Health Service
           Modules</EventSourceName><Channel>Operations
           Manager</Channel><LoggingComputer>WIN2STDVM</LoggingComputer><EventNumber>
            3221237023</EventNumber><EventCategory>0</EventCategory><EventLevel>1</EventLevel>
           <UserName>N/A</UserName><RawDescription><![CDATA[Compu
          ter verification failure for Machine Name: %1 is %2.%3]]></RawDescription>
           <LCID>1033</LCID><Params><Param>jessica.synapse.com</Param><Param>0x800706BA</Param>
          <Param>The RPC server is unavailable.</Param></Params><EventData/>
          <EventDisplayNumber>11551</EventDisplayNumber><EventDescription>
             <![CDATA[Computer verificationfailure for Machine Name:
           jessica.neuron.com is 0x800706BA. The RPC server is
            unavailable.]]></EventDescription></DataItem></Context>
          <ConnectorId />
          <LastModifiedByNonConnector>2/4/2009 8:11:41 AM</LastModifiedByNonConnector>
          <MonitoringObjectInMaintenanceMode>False</MonitoringObjectInMaintenanceMode>
          <MonitoringObjectHealthState>Success</MonitoringObjectHealthState>
          <ConnectorStatus>NotMarkedForForwarding</ConnectorStatus>
          <RepeatCount>1</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 12:33:15 PM</StateLastModified>
          <Parameters>{}</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