get-monitoringobject-by-monitoring-class operation

The get-monitoringobject-by-monitoring-class operation retrieves the details of all the monitoring objects associated with the specified monitoring class.

The following table describes the <items> XML and request elements for the get-monitoringobject-by-monitoring-class operation:

Adapter request elements for the get-monitoringobject-by-monitoring-class operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-monitoringobject-by-monitoring-class

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

<monitoringclass>

Specifies the parent element for the <monitoringclass-id> element

Yes

<monitoringclass-id>

Specifies the globally unique identifier (GUID) of the monitoring class

Yes

The following figure illustrates a sample adapter request for the get-monitoringobject-by-monitoring-class operation: 

Sample adapter request for the get-monitoringobject-by-monitoring-class operation

<scom-request>
  <operation-name>get-monitoringobject-by-monitoring-class</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <monitoringclass>
        <monitoringclass-id>1f06bba9-58a9-fd0b-d980-
        08d5af2e67d3</monitoringclass-id>
      </monitoringclass>
    </command-parameters>
  </command-request>
</scom-request>


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

Sample adapter response for the get-monitoringobject-by-monitoring-class operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command>./Microsoft.EnterpriseManagement.OperationsManager.ClientShell.
        Startup.ps1;get-monitoringobject -monitoringclass (get-monitoringclass -
        id 1f06bba9-58a9-fd0b-d980-08d5af2e67d3)</command>
        <execution-milliseconds>5656</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>21</count>
      </metadata>
      <output>
        <item>
          <Id>da705057-8cc6-16da-0830-00317bb23857</Id>
          <PathName>Microsoft.Office.2003.Outlook%003ad%002d13008.synapse.com</PathName>
          <DisplayName>Microsoft.Office.2003.Outlook</DisplayName>
          <ManagementMode />
          <ManagementGroup>CATNoida</ManagementGroup>
          <HealthState>Success</HealthState>
          <OperationalState />
        </item>
        ...
      </output>
    </command-output>
  </commands-output>
</scom-response>
Was this page helpful? Yes No Submitting... Thank you

Comments