Monitoring Class management operations for Microsoft System Center Operations Manager 2012

This topic describes the adapter requests and responses for the Monitoring Class operations.

Find Monitoring Class by ID operation

The Find Monitoring Class by ID operation retrieves all the monitoring classes that are filtered by the specified search criterion. 

The following table describes the adapter request elements for the Find Monitoring Class by ID operation.

Adapter request elements for the Find Monitoring Class by ID operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMClass

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>

Contains the <monitoringclass-ID> for which the monitoring object is returned

Yes

<monitoringclass-ID>

Specifies the ID of the monitoring class for which monitoring object is returned

Yes

The following figure shows the <items> XML for the Find Monitoring Class by ID operation.

<items> XML for the Find Monitoring Class by ID operation

<items>
	<item>
		<timeout-secs>120</timeout-secs>
		<command-parameters>
			<monitoringclass-id>e1ae9104-c9a3-467f-adba-33f801db7d37</monitoringclass-id>
		</command-parameters>
	</item>
</items> 

The following figure shows the sample adapter request.

Sample adapter request for the Find Monitoring Class by ID operation 

<request-data>
  <scom-request>
    <operation-name>Get-SCOMClass</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <monitoringclass-id>ab4c891f-3359-3fb6-0704-075fbfe36710</monitoringclass-id>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data>


The following figure shows the adapter response.

Adapter response for the Find Monitoring Class by ID operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMClass -id ab4c891f-3359-3fb6-0704-075fbfe36710 | format-list</command>
        <execution-milliseconds>50075</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <PropertyCollection><![CDATA[{AuthenticationName, MaximumQueueSize, ]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=0d026768-86be-77f5-b58e-7f07d3178cf8</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.HealthService||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.HealthService]]></Name>
          <Id><![CDATA[ab4c891f-3359-3fb6-0704-075fbfe36710]]></Id>
          <DisplayName><![CDATA[Health Service]]></DisplayName>
          <Description><![CDATA[This type represents the System Center Health Service.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>

Back to top

Find Monitoring Class by Management Pack operation

The Find Monitoring Class by Management Pack operation retrieves the monitoring classes associated with the specified management pack. 

The following table describes the adapter request elements for the Find Monitoring Class by Management Pack operation.

Adapter request elements for the Find Monitoring Class by Management Pack operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMClass

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

<managementpack>

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

Yes

<managementpack-id>

Specifies the globally unique identifier (GUID) of the management pack

Yes

The following figure shows the <items> XML for the Find Monitoring Class by Management Pack operation.

<items> XML for the Find Monitoring Class by Management Pack operation

<items>
	<item>
		<timeout-secs>120</timeout-secs>
		<command-parameters>
			<managementpack>
				<managementpack-id>1640cc66-2fa5-1ffb-33ee-231fa5a10cb8</managementpack-id>
			</managementpack>
		</command-parameters>
	</item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Find Monitoring Class by Management Pack operation

<request-data>
  <scom-request>
    <operation-name>Get-SCOMClass</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <managementpack>
          <managementpack-id>7cfc5cc0-ae0a-da4f-5ac2-d64540141a55</managementpack-id>
        </managementpack>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data> 

The following figure shows the adapter response.

Adapter response for the Find Monitoring Class by Management Pack operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMClass -managementpack (Get-SCOMManagementPack -id 7cfc5cc0-ae0a-da4f-5ac2-d64540141a55) | format-list</command>
        <execution-milliseconds>120043</execution-milliseconds>
        <exit-code>9999</exit-code>
        <status>success</status>
        <count>3</count>
      </metadata>
      <output>
        <item>
          <PropertyCollection><![CDATA[{WebConsoleUrl}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=176ced55-7556-a619-717c-b59ae14e756f</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.WebConsoleWatcher||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.WebConsoleWatcher]]></Name>
          <Id><![CDATA[c0c6f9db-a3a3-90f9-66a2-022903228e36]]></Id>
          <DisplayName><![CDATA[Web Console Watcher]]></DisplayName>
          <Description>This class represents an Operations Manager Web Console Watcher.</Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection>{AuthenticationName, MaximumQueueSize, MaximumSizeOfAllTransferredFiles, RequestCompression...}</PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=0d026768-86be-77f5-b58e-7f07d3178cf8</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.HealthService||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.HealthService]]></Name>
          <Id><![CDATA[ab4c891f-3359-3fb6-0704-075fbfe36710]]></Id>
          <DisplayName><![CDATA[Health Service]]></DisplayName>
          <Description><![CDATA[This type represents the System Center Health Service.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection><![CDATA[{MainDatabaseServerName, MainDatabaseName}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=885bc562-ed36-c548-b938-44ce5ba7ba2b</Base>
          <Hosted><![CDATA[False]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[True]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.Database.AppMonitoring||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.Database.AppMonitoring]]></Name>
          <Id><![CDATA[20b8de87-7599-2dc7-dba8-0a823bff157c]]></Id>
          <DisplayName><![CDATA[App Monitoring DB]]></DisplayName>
          <Description><![CDATA[App Monitoring DB]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>


Back to top

Find Monitoring Class by Monitoring Object operation

The Find Monitoring Class by Monitoring Object operation retrieves the monitoring class associated with the specified monitoring object. 

The following table describes the adapter request elements for the Find Monitoring Class by Monitoring Object operation.

Adapter request elements for the Find Monitoring Class by Monitoring Object operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMClass

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>

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

Yes

<monitoringobject-id>

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

Yes

The following figure shows the <items> XML for the Find Monitoring Class by Monitoring Object operation.

<items> XML for the Find Monitoring Class by Monitoring Object operation

<items>
	<item>
		<timeout-secs>120</timeout-secs>
		<command-parameters>
			<monitoringobject>
				<monitoringobject-id>9f1c5d29-a352-e425-250b-e2e351b170e7</monitoringobject-id>
			</monitoringobject>
		</command-parameters>
	</item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Find Monitoring Class by Monitoring Object operation

<request-data>
  <scom-request>
    <operation-name>Get-SCOMClass</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <monitoringobject>
          <monitoringobject-id>a0d974ba-e24b-10b1-b6ab-a05af10234d3</monitoringobject-id>
        </monitoringobject>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data>

The following figure shows the adapter response. 

Adapter response for the Find Monitoring Class by Monitoring Object operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMClass -instance (Get-SCOMClassInstance -id a0d974ba-e24b-10b1-b6ab-a05af10234d3) | format-list</command>
        <execution-milliseconds>118471</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>6</count>
      </metadata>
      <output>
        <item>
          <PropertyCollection><![CDATA[{AuthenticationName, MaximumQueueSize, ]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=0d026768-86be-77f5-b58e-7f07d3178cf8</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.HealthService||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.HealthService]]></Name>
          <Id><![CDATA[ab4c891f-3359-3fb6-0704-075fbfe36710]]></Id>
          <DisplayName><![CDATA[Health Service]]></DisplayName>
          <Description><![CDATA[This type represents the System Center Health Service.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection>{ManagementServerSCP, AutoApproveManuallyInstalledAgents, NumberOfMissingHeartBeatsToMarkMachineDown, ProxyAddress...}</PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=ab4c891f-3359-3fb6-0704-075fbfe36710</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.ManagementServer||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.ManagementServer]]></Name>
          <Id><![CDATA[9189a49e-b2de-cab0-2e4f-4925b68e335d]]></Id>
          <DisplayName><![CDATA[Management Server]]></DisplayName>
          <Description><![CDATA[This class represents the Management Server.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection><![CDATA[{}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=9189a49e-b2de-cab0-2e4f-4925b68e335d</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.DataWarehouse.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.DataWarehouseConnectorServer||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.DataWarehouseConnectorServer]]></Name>
          <Id><![CDATA[0d828c27-f087-5562-3644-4e35484a7083]]></Id>
          <DisplayName><![CDATA[Data Warehouse Connection Server]]></DisplayName>
          <Description>All Management Servers capable of sending data to the System Center Data Warehouse</Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:37 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:37 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.DataWarehouse.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection><![CDATA[{}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=7b11b1b9-3462-c54f-9f10-943cabb9d26e</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.RootManagementServer||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.RootManagementServer]]></Name>
          <Id><![CDATA[1a9387f0-6fe5-5527-a2cb-73f2f6be6bc7]]></Id>
          <DisplayName><![CDATA[Root Management Server Emulator]]></DisplayName>
          <Description>This class represents a Root Management Server Emulator.</Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection><![CDATA[{}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=9189a49e-b2de-cab0-2e4f-4925b68e335d</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.CollectionManagementServer||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.CollectionManagementServer]]></Name>
          <Id><![CDATA[7b11b1b9-3462-c54f-9f10-943cabb9d26e]]></Id>
          <DisplayName><![CDATA[Collection Server]]></DisplayName>
          <Description><![CDATA[This class represents an Collection Management Server.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
        <item>
          <PropertyCollection><![CDATA[{WebConsoleUrl}]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=9189a49e-b2de-cab0-2e4f-4925b68e335d</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Notifications.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.NotificationSubscriptionServer||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.NotificationSubscriptionServer]]></Name>
          <Id><![CDATA[f9069ca9-a790-e274-0c2c-de210e57f67c]]></Id>
          <DisplayName><![CDATA[Notification Subscription Server]]></DisplayName>
          <Description>Management Server running notification subscription workflows</Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:19:25 AM</LastModified>
          <TimeAdded>12/14/2016 11:19:25 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Notifications.Library]]></ManagementPackName>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>

Back to top

Find Monitoring Class by Name operation

The Find Monitoring Class by Name operation retrieves the monitoring class that is identified by the specified name. 

The following table describes the adapter request elements for the Find Monitoring Class by Name operation.

Adapter request elements for the Find Monitoring Class by Name operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-SCOMClass

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 shows the <items> XML for the Find Monitoring Class by Name operation.

<items> XML for the Find Monitoring Class by Name operation

<items>
	<item>
		<timeout-secs>120</timeout-secs>
		<command-parameters>
			<monitoringclass-name>Microsoft.SystemCenter.ManagedComputerServer</monitoringclass-name>
		</command-parameters>
	</item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Find Monitoring Class by Name operation

<request-data>
  <scom-request>
    <operation-name>Get-SCOMClass</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <monitoringclass-name>Microsoft.SystemCenter.HealthService</monitoringclass-name>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data> 

The following figure shows the adapter response. 

Adapter response for the Find Monitoring Class by Name operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMClass -name 'Microsoft.SystemCenter.HealthService' | format-list</command>
        <execution-milliseconds>52775</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <PropertyCollection><![CDATA[{AuthenticationName, MaximumQueueSize, ]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=0d026768-86be-77f5-b58e-7f07d3178cf8</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.HealthService||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.HealthService]]></Name>
          <Id><![CDATA[ab4c891f-3359-3fb6-0704-075fbfe36710]]></Id>
          <DisplayName><![CDATA[Health Service]]></DisplayName>
          <Description><![CDATA[This type represents the System Center Health Service.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>

Back to top

Find Monitoring Class operation

The Find Monitoring Class operation retrieves all the monitoring classes that are filtered by the specified search criterion. 

The following table describes the adapter request elements for the Find Monitoring Class operation.

Adapter request elements for the Find Monitoring Class operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-SCOMClass

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

<filters>

Specifies the parent element that contains the search criterion

No

<filter>

Specifies a particular filter criterion 

You can specify more than one search criterion by using multiple <filter> elements.

Conditional; required if <filters> is specified

<monitoringclass-key>

Specifies the name of the monitoring class property used in the search

Conditional; required if the <filters> element is specified

<monitoringclass-val>

Specifies the value of the property specified in the <monitoringclass-key> element

Conditional; required if the <filters> element is specified

<operand>

Specifies the operation that is performed by using the values specified in the <monitoringclass-key> and <monitoringclass-val> elements 

Valid values:

  • equals
  • not equals
  • matches

Conditional; required if the <filters> element is specified

 

The following figure shows the <items> XML for the Find Monitoring Class operation. 

<items> XML for the Find Monitoring Class operation

<items>
  <item>
  <timeout-secs>120</timeout-secs>
<command-parameters>
<filters>
  <filter>
    <monitoringclass-key>Description</monitoringclass-key>
    <monitoringclass-val>Windows</monitoringclass-val>
    <operand>matches</operand>
  </filter>
  <filter>
    <monitoringclass-key>DisplayName</monitoringclass-key>
    <monitoringclass-val>System Center</monitoringclass-val>
    <operand>matches</operand>
  </filter>
</filters>
</command-parameters>
  </item>
</items>

The following figure shows the sample adapter request. 

Sample adapter request for the Find Monitoring Class operation

<request-data>
  <scom-request>
    <operation-name>Get-SCOMClass</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <filters>
          <filter>
            <monitoringclass-key>Description</monitoringclass-key>
            <monitoringclass-val>This type represents the System Center Health Service.</monitoringclass-val>
            <operand>matches</operand>
          </filter>
          <filter>
            <monitoringclass-key>DisplayName</monitoringclass-key>
            <monitoringclass-val>Health Service</monitoringclass-val>
            <operand>matches</operand>
          </filter>
        </filters>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data>
</request-data>

The following figure shows the adapter response. 

Adapter response for the Find Monitoring Class operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMClass | where-object {$_.Description -match 'This type represents the System Center Health Service.'} | where-object {$_.DisplayName -match 'Health Service'} | format-list</command>
        <execution-milliseconds>51399</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <PropertyCollection><![CDATA[{AuthenticationName, MaximumQueueSize, ]]></PropertyCollection>
          <Base>ManagementPackElementUniqueIdentifier=0d026768-86be-77f5-b58e-7f07d3178cf8</Base>
          <Hosted><![CDATA[True]]></Hosted>
          <Singleton><![CDATA[False]]></Singleton>
          <Extension><![CDATA[False]]></Extension>
          <OptimizationCollection><![CDATA[{}]]></OptimizationCollection>
          <FullTextSearchable></FullTextSearchable>
          <XmlTag><![CDATA[ClassType]]></XmlTag>
          <Abstract><![CDATA[False]]></Abstract>
          <Accessibility><![CDATA[Public]]></Accessibility>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <ManagementGroupId><![CDATA[f0bfdf68-bb60-15e4-e21a-3678feeaa78e]]></ManagementGroupId>
          <Identifier>1|Microsoft.SystemCenter.Library/31bf3856ad364e35|1.0.0.0|Microsoft.SystemCenter.HealthService||</Identifier>
          <Name><![CDATA[Microsoft.SystemCenter.HealthService]]></Name>
          <Id><![CDATA[ab4c891f-3359-3fb6-0704-075fbfe36710]]></Id>
          <DisplayName><![CDATA[Health Service]]></DisplayName>
          <Description><![CDATA[This type represents the System Center Health Service.]]></Description>
          <LanguageCode><![CDATA[ENU]]></LanguageCode>
          <Comment></Comment>
          <Status><![CDATA[Unchanged]]></Status>
          <LastModified>12/14/2016 11:15:23 AM</LastModified>
          <TimeAdded>12/14/2016 11:15:23 AM</TimeAdded>
          <InstanceName></InstanceName>
          <ManagementPackName><![CDATA[Microsoft.SystemCenter.Library]]></ManagementPackName>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response> 

Back to top

Was this page helpful? Yes No Submitting... Thank you

Comments