get-monitoringclass-by-name operation

The get-monitoringclass-by-name operation retrieves the monitoring class that is identified by the specified name.

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

Adapter request elements for the get-monitoringclass-by-name operation

Element	Definition	Required
`<operation-name>`	Specifies the operation name: `get-monitoringclass-by-name`	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-name>`	Specifies the name of the monitoring class that you want to retrieve	Yes

The following figure illustrates a sample adapter request for the get-monitoringclass-by-name operation:

Sample adapter request for the get-monitoringclass-by-name operation

<scom-request>
  <operation-name>get-monitoringclass-by-name</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <monitoringclass-name>System.Entity</monitoringclass-name>
    </command-parameters>
  </command-request>
</scom-request>

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

Sample adapter response for the get-monitoringclass-by-name operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command>./Microsoft.EnterpriseManagement.OperationsManager.ClientShell.
        Startup.ps1;get-monitoringclass -name 'System.Entity'</command>
        <execution-milliseconds>4125</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <ManagementGroup>CATNoida</ManagementGroup>
          <ManagementGroupId>ae1fcf8a-8088-31d8-93ec-
          90fe77a32d44</ManagementGroupId>
          <Abstract>True</Abstract>
          <Base />
          <Hosted>False</Hosted>
          <Singleton>False</Singleton>
          <PropertyCollection>{DisplayName}</PropertyCollection>
          <XmlTag>ClassType</XmlTag>
          <Accessibility>Public</Accessibility>
          <Name>System.Entity</Name>
          <Id>55270a70-ac47-c853-c617-236b0cff9b4c</Id>
          <DisplayName>Entity</DisplayName>
          <Description>All Entities</Description>
          <LanguageCode>ENU</LanguageCode>
          <Comment />
          <Status>Unchanged</Status>
          <LastModified>1/8/2009 10:11:45 AM</LastModified>
          <TimeAdded>1/8/2009 10:11:45 AM</TimeAdded>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>

get-monitoringclass-by-name operation

Comments