get-monitoringobject-by-id operation

The get-monitoringobject-by-id operation retrieves the monitoring object that is identified by the specified globally unique identifier (GUID).

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

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

Element	Definition	Required
`<operation-name>`	Specifies the operation name: `get-monitoringobject-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
`<monitoringobject-id>`	Specifies the GUID of the monitoring object that you want to retrieve	Yes

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

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

<scom-request>
  <operation-name>get-monitoringobject-by-id</operation-name>
  <command-request>
    <timeout-secs>120</timeout-secs>
    <command-parameters>
      <monitoringobject-id>6c4bb046-82a8-ad78-0bc5-
      97aa4b8cc200</monitoringobject-id>
    </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-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-monitoringobject -id 6c4bb046-82a8-ad78-0bc5-
        97aa4b8cc200</command>
        <execution-milliseconds>4298</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <Id>6c4bb046-82a8-ad78-0bc5-97aa4b8cc200</Id>
          <PathName>Microsoft.Windows.Server.2000.ComputerGroup</PathName>
          <DisplayName>Windows Server 2000 Computer Group</DisplayName>
          <ManagementMode />
          <ManagementGroup>CATNoida</ManagementGroup>
          <HealthState>Uninitialized</HealthState>
          <OperationalState />
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>

get-monitoringobject-by-id operation

Comments