Management Pack management operations for Microsoft System Center Operations Manager 2012

This topic describes the adapter requests and responses for the Management Pack operations and describes the elements used in the requests.

Import Management Pack operation

The Import Management Pack operation installs the specified management pack on the Microsoft System Center Operations Manager management server. 

The following table describes the adapter request elements for the Import Management Pack operation.

Adapter request elements for the Import Management Pack operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Import-SCOMManagementPack

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

<sourcefile-path>

Specifies the path of the file that contains the management pack 

This file must have a .xml or .mp extension, and you must include the file extension in the value of this parameter.

Yes

<preview>

Specifies whether you want to preview the results of the operation 

Valid values:

  • true: Indicates that you want to preview the results of the operation
  • false: Indicates that the operation is executed without displaying the results of the execution (default)

No

The following figure shows the <items> XML for the Import Management Pack operation.

<items> XML for the Import Management Pack operation

<items>
<item>
<timeout-secs>120</timeout-secs>
<command-parameters>
<sourcefile-path>C:\packs\Microsoft.Windows.Client.BusinessCritical.xml</sourcefile-path>
<preview>true</preview>
</command-parameters>
</item>
</items> 

The following figure shows the sample adapter request.

Sample adapter request for the Import Management Pack operation

<request-data>
 <scom-request>
   <operation-name>Import-SCOMManagementPack</operation-name>
   <command-request>
     <timeout-secs>120</timeout-secs>
     <command-parameters>
       <sourcefile-path>C:\packs\Microsoft.SystemCenter.ApplicationMonitoring.360.SLA.xml</sourcefile-path>
       <preview>false</preview>
     </command-parameters>
   </command-request>
 </scom-request>
</request-data> 

The following figure shows the adapter response. 

Adapter response for the Import Management Pack operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; Import-SCOMManagementPack -fullname C:\packs\Microsoft.SystemCenter.ApplicationMonitoring.360.SLA.xml | format-list</command>
       <execution-milliseconds>487645</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>0</count>
     </metadata>
     <output />
   </command-output>
 </commands-output>
</scom-response> 

Back to top

Find Management Pack operation

The Find Management Pack operation retrieves all the management packs that are filtered by the specified search criterion. 

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

Adapter request elements for the Find Management Pack operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMManagementPack

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 the parent element for a single search criterion 

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

Conditional; required if the <filters> element is specified

<managementpack-prop-key>

Specifies the name or key of the management pack property used in the search 

Valid values:

  • Name
  • KeyToken
  • Version
  • Id
  • VersionId
  • References
  • Sealed
  • ContentReadable
  • FriendlyName
  • DisplayName
  • Description
  • DefaultLanguageCode
  • LockObject

Conditional; required if the <filters> element is specified

<managementpack-prop-val>

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

Conditional; required if the <filters> element is specified

<operand>

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

Valid values:

  • equals
  • not equals
  • matches

Conditional; required if the <filters> element is specified

 

Note

The following naming discrepancies exist between the Microsoft System Center Operations Manager application and API:

  • The ID attribute of the application is mapped to the Name attribute of the management pack in the API.
  • The Name attribute of the application is mapped to the DisplayName attribute of the management pack in the API.

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

<items> XML for the Find Management Pack operation

<items>
 <item>
 <timeout-secs>120</timeout-secs>
<command-parameters>
<filters>
<filter>
<managementpack-prop-key>Sealed</managementpack-prop-key>
<managementpack-prop-val>true</managementpack-prop-val>
<operand>equals</operand>
</filter>
<filter>
<managementpack-prop-key>DisplayName</managementpack-prop-key>
<managementpack-prop-val>Health</managementpack-prop-val>
<operand>matches</operand>
</filter>
</filters>
</command-parameters>
 </item>
</items>

The following figure shows the sample adapter request. 

Sample adapter request for the Find Management Pack operation

<request-data>
 <scom-request>
   <operation-name>Get-SCOMManagementPack</operation-name>
   <command-request>
     <timeout-secs>120</timeout-secs>
     <command-parameters>
       <filters>
         <filter>
           <managementpack-prop-key>Sealed</managementpack-prop-key>
           <managementpack-prop-val>true</managementpack-prop-val>
           <operand>equals</operand>
         </filter>
         <filter>
           <managementpack-prop-key>DisplayName</managementpack-prop-key>
           <managementpack-prop-val>System Center Core Library</managementpack-prop-val>
           <operand>matches</operand>
         </filter>
       </filters>
     </command-parameters>
   </command-request>
 </scom-request>
</request-data>

The following figure shows the adapter response. 

Adapter response for the Find Management Pack operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; Get-SCOMManagementPack | where-object {$_.Sealed -eq $True} | where-object {$_.DisplayName -match 'System Center Core Library'} | format-list</command>
       <execution-milliseconds>61481</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>1</count>
     </metadata>
     <output>
       <item>
         <Name><![CDATA[Microsoft.SystemCenter.Library]]></Name>
         <TimeCreated>12/14/2016 11:15:23 AM</TimeCreated>
         <LastModified>12/14/2016 11:15:23 AM</LastModified>
         <KeyToken><![CDATA[31bf3856ad364e35]]></KeyToken>
         <Version><![CDATA[7.0.8437.0]]></Version>
         <Id><![CDATA[7cfc5cc0-ae0a-da4f-5ac2-d64540141a55]]></Id>
         <Identifier>2|Microsoft.SystemCenter.Library/31bf3856ad364e35|7.0.8437.0|Microsoft.SystemCenter.Library||</Identifier>
         <VersionId><![CDATA[fa5cf4e9-cf54-b234-030d-a20743209ded]]></VersionId>
         <References>{ManagementPack:[Name=System.ApplicationLog.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=System.Snmp.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=Microsoft.Windows.Library, KeyToken=31bf3856ad364e35, Version=7.5.8501.0], ManagementPack:[Name=System.Performance.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0]...}</References>
         <Sealed><![CDATA[True]]></Sealed>
         <ContentReadable><![CDATA[True]]></ContentReadable>
         <FriendlyName><![CDATA[Microsoft System Center Library]]></FriendlyName>
         <DisplayName><![CDATA[System Center Core Library]]></DisplayName>
         <Description>Microsoft System Center Library: This Management Pack contains type definitions for System Center.</Description>
         <DefaultLanguageCode><![CDATA[ENU]]></DefaultLanguageCode>
         <ActiveLanguageCode></ActiveLanguageCode>
         <LockObject><![CDATA[System.Object]]></LockObject>
         <Store><![CDATA[SCOM-GROUP]]></Store>
         <SchemaVersion><![CDATA[2.0]]></SchemaVersion>
         <OriginalSchemaVersion><![CDATA[1.1]]></OriginalSchemaVersion>
         <Registry>Microsoft.EnterpriseManagement.Configuration.ExtensionRegistry</Registry>
         <Extensions>Microsoft.EnterpriseManagement.Configuration.ExtensionManagement</Extensions>
         <LifetimeManagers>Microsoft.EnterpriseManagement.LifetimeManagerTypeRegistry</LifetimeManagers>
         <Features><![CDATA[Microsoft.EnterpriseManagement.FeatureContainer]]></Features>
         <ImageReferences>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_ImageReferences</ImageReferences>
         <EntityTypes>Microsoft.EnterpriseManagement.SingleManagementPackEntityTypeManagement</EntityTypes>
         <ManagementPacks>Microsoft.EnterpriseManagement.SingleManagementPackManagement</ManagementPacks>
         <Presentation>Microsoft.EnterpriseManagement.SinglePresentationManagement</Presentation>
         <Monitoring>Microsoft.EnterpriseManagement.SingleManagementPackMonitoringConfigurationManagement</Monitoring>
         <DerivedTypes>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_DerivedTypes</DerivedTypes>
       </item>
     </output>
   </command-output>
 </commands-output>
</scom-response>

Back to top

Find Management Pack By Name operation

The Find Management Pack by Name operation retrieves the details of the management pack that is identified by the specified name. 

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

Adapter request elements for the Find Management Pack by Name operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMManagementPack

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-name>

Specifies the name of the management pack that you want to retrieve 


Note: If the name contains spaces, enclose it in single quotation marks.

Yes

Note

The following naming discrepancies exist between the Microsoft System Center Operations Manager application and API:

  • The ID attribute of the application is mapped to the Name attribute of the management pack in the API.
  • The Name attribute of the application is mapped to the DisplayName attribute of the management pack in the API. 

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

<items> XML for the Find Management Pack by Name operation

<items>
 <item>
<timeout-secs>120</timeout-secs>
<command-parameters>
<managementpack-name>System.Library</managementpack-name>
</command-parameters>
 </item>
</items>

 

The following figure shows the sample adapter request.

Sample adapter request for the Find Management Pack by Name operation

<request-data>
 <scom-request>
   <operation-name>Get-SCOMManagementPack</operation-name>
   <command-request>
     <timeout-secs>120</timeout-secs>
     <command-parameters>
       <managementpack-name>Microsoft.SystemCenter.Library</managementpack-name>
     </command-parameters>
   </command-request>
 </scom-request>
</request-data>

The following figure shows the adapter response. 

Adapter response for the Find Management Pack by Name operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; Get-SCOMManagementPack -name Microsoft.SystemCenter.Library | format-list</command>
       <execution-milliseconds>64772</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>1</count>
     </metadata>
     <output>
       <item>
         <Name><![CDATA[Microsoft.SystemCenter.Library]]></Name>
         <TimeCreated>12/14/2016 11:15:23 AM</TimeCreated>
         <LastModified>12/14/2016 11:15:23 AM</LastModified>
         <KeyToken><![CDATA[31bf3856ad364e35]]></KeyToken>
         <Version><![CDATA[7.0.8437.0]]></Version>
         <Id><![CDATA[7cfc5cc0-ae0a-da4f-5ac2-d64540141a55]]></Id>
         <Identifier>2|Microsoft.SystemCenter.Library/31bf3856ad364e35|7.0.8437.0|Microsoft.SystemCenter.Library||</Identifier>
         <VersionId><![CDATA[fa5cf4e9-cf54-b234-030d-a20743209ded]]></VersionId>
         <References>{ManagementPack:[Name=System.ApplicationLog.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=System.Snmp.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=Microsoft.Windows.Library, KeyToken=31bf3856ad364e35, Version=7.5.8501.0], ManagementPack:[Name=System.Performance.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0]...}</References>
         <Sealed><![CDATA[True]]></Sealed>
         <ContentReadable><![CDATA[True]]></ContentReadable>
         <FriendlyName><![CDATA[Microsoft System Center Library]]></FriendlyName>
         <DisplayName><![CDATA[System Center Core Library]]></DisplayName>
         <Description>Microsoft System Center Library: This Management Pack contains type definitions for System Center.</Description>
         <DefaultLanguageCode><![CDATA[ENU]]></DefaultLanguageCode>
         <ActiveLanguageCode></ActiveLanguageCode>
         <LockObject><![CDATA[System.Object]]></LockObject>
         <Store><![CDATA[SCOM-GROUP]]></Store>
         <SchemaVersion><![CDATA[2.0]]></SchemaVersion>
         <OriginalSchemaVersion><![CDATA[1.1]]></OriginalSchemaVersion>
         <Registry>Microsoft.EnterpriseManagement.Configuration.ExtensionRegistry</Registry>
         <Extensions>Microsoft.EnterpriseManagement.Configuration.ExtensionManagement</Extensions>
         <LifetimeManagers>Microsoft.EnterpriseManagement.LifetimeManagerTypeRegistry</LifetimeManagers>
         <Features><![CDATA[Microsoft.EnterpriseManagement.FeatureContainer]]></Features>
         <ImageReferences>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_ImageReferences</ImageReferences>
         <EntityTypes>Microsoft.EnterpriseManagement.SingleManagementPackEntityTypeManagement</EntityTypes>
         <ManagementPacks>Microsoft.EnterpriseManagement.SingleManagementPackManagement</ManagementPacks>
         <Presentation>Microsoft.EnterpriseManagement.SinglePresentationManagement</Presentation>
         <Monitoring>Microsoft.EnterpriseManagement.SingleManagementPackMonitoringConfigurationManagement</Monitoring>
         <DerivedTypes>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_DerivedTypes</DerivedTypes>
       </item>
     </output>
   </command-output>
 </commands-output>
</scom-response>


Back to top

Find Management Pack By ID operation

The Find Management Pack by ID operation retrieves the details of the management pack that is identified by the specified globally unique identifier (GUID). 

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

Adapter request elements for the Find Management Pack by ID operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMManagementPack

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-id>

Specifies the GUID of the management pack that you want to retrieve

Yes

The following naming discrepancies exist between the Microsoft System Center Operations Manager application and API:

  • The ID attribute of the application is mapped to the Name attribute of the management pack in the API.
  • The Name attribute of the application is mapped to the DisplayName attribute of the management pack in the API.

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

<items> XML for the Find Management Pack by ID operation

<items>
<item>
  <timeout-secs>120</timeout-secs>
<command-parameters>
<managementpack-id>01c8b236-3bce-9dba-6f1c-c119bcdc2972</managementpack-id>
</command-parameters>
</item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Find Management Pack by ID operation

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

The following figure shows the adapter response. 

Adapter response for the Find Management Pack by ID operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; Get-SCOMManagementPack -id 7cfc5cc0-ae0a-da4f-5ac2-d64540141a55 | format-list</command>
       <execution-milliseconds>62636</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>1</count>
     </metadata>
     <output>
       <item>
         <Name><![CDATA[Microsoft.SystemCenter.Library]]></Name>
         <TimeCreated>12/14/2016 11:15:23 AM</TimeCreated>
         <LastModified>12/14/2016 11:15:23 AM</LastModified>
         <KeyToken><![CDATA[31bf3856ad364e35]]></KeyToken>
         <Version><![CDATA[7.0.8437.0]]></Version>
         <Id><![CDATA[7cfc5cc0-ae0a-da4f-5ac2-d64540141a55]]></Id>
         <Identifier>2|Microsoft.SystemCenter.Library/31bf3856ad364e35|7.0.8437.0|Microsoft.SystemCenter.Library||</Identifier>
         <VersionId><![CDATA[fa5cf4e9-cf54-b234-030d-a20743209ded]]></VersionId>
         <References>{ManagementPack:[Name=System.ApplicationLog.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=System.Snmp.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0], ManagementPack:[Name=Microsoft.Windows.Library, KeyToken=31bf3856ad364e35, Version=7.5.8501.0], ManagementPack:[Name=System.Performance.Library, KeyToken=31bf3856ad364e35, Version=7.0.8437.0]...}</References>
         <Sealed><![CDATA[True]]></Sealed>
         <ContentReadable><![CDATA[True]]></ContentReadable>
         <FriendlyName><![CDATA[Microsoft System Center Library]]></FriendlyName>
         <DisplayName><![CDATA[System Center Core Library]]></DisplayName>
         <Description>Microsoft System Center Library: This Management Pack contains type definitions for System Center.</Description>
         <DefaultLanguageCode><![CDATA[ENU]]></DefaultLanguageCode>
         <ActiveLanguageCode></ActiveLanguageCode>
         <LockObject><![CDATA[System.Object]]></LockObject>
         <Store><![CDATA[SCOM-GROUP]]></Store>
         <SchemaVersion><![CDATA[2.0]]></SchemaVersion>
         <OriginalSchemaVersion><![CDATA[1.1]]></OriginalSchemaVersion>
         <Registry>Microsoft.EnterpriseManagement.Configuration.ExtensionRegistry</Registry>
         <Extensions>Microsoft.EnterpriseManagement.Configuration.ExtensionManagement</Extensions>
         <LifetimeManagers>Microsoft.EnterpriseManagement.LifetimeManagerTypeRegistry</LifetimeManagers>
         <Features><![CDATA[Microsoft.EnterpriseManagement.FeatureContainer]]></Features>
         <ImageReferences>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_ImageReferences</ImageReferences>
         <EntityTypes>Microsoft.EnterpriseManagement.SingleManagementPackEntityTypeManagement</EntityTypes>
         <ManagementPacks>Microsoft.EnterpriseManagement.SingleManagementPackManagement</ManagementPacks>
         <Presentation>Microsoft.EnterpriseManagement.SinglePresentationManagement</Presentation>
         <Monitoring>Microsoft.EnterpriseManagement.SingleManagementPackMonitoringConfigurationManagement</Monitoring>
         <DerivedTypes>Microsoft.EnterpriseManagement.Configuration.IO.SingleManagementPackStore_DerivedTypes</DerivedTypes>
       </item>
     </output>
   </command-output>
 </commands-output>
</scom-response>

Back to top

Export Management Pack operation

The Export Management Pack operation exports a management pack to a file. 

The following table describes the adapter request elements for the Export Management Pack operation.

Adapter request elements for the Export Management Pack operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Export-SCOMManagementPack

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 search criterion required to filter the management pack that you want to export

Yes

<managementpack-name>

Specifies the name of the management pack that you want to export

Conditional; required if Format 3 is used

<managementpack-id>

Specifies the GUID of the management pack that you want to export

Conditional; required if Format 2 is used

<filters>

Specifies the parent element that contains the search criterion

Conditional; required if Format 1 is used

<filter>

Specifies the parent element for a single search criterion

Conditional; required if Format 1 is used

<managementpack-prop-key>

Specifies the name of the management pack property used in the search 

Valid values:

  • Name, KeyToken
  • Version
  • Id
  • VersionId
  • References
  • Sealed
  • ContentReadable
  • FriendlyName
  • DisplayName
  • Description
  • DefaultLanguageCode
  • LockObject

Conditional; required if Format 1 is used

<managementpack-prop-val>

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

Conditional; required if Format 1 is used

<operand>

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

Valid values:

  • equals
  • not equals
  • matches

Conditional; required if Format 1 is used

<export-path>

Specifies the path where the management pack is exported

Yes

The following naming discrepancies exist between the Microsoft System Center Operations Manager 2007 application and API:

  • The ID attribute of the application is mapped to the Name attribute of the management pack in the API.
  • The Name attribute of the application is mapped to the DisplayName attribute of the management pack in the API.

The following figure shows the <items> XML for the Export Management Pack operation for Format 1.

<items> XML for the Export Management Pack operation for Format 1

<items>
 <item>
 <timeout-secs>120</timeout-secs>
<command-parameters>
<managementpack>
<filters>
<filter>
<managementpack-prop-key>Sealed</managementpack-prop-key>
<managementpack-prop-val>$false</managementpack-prop-val>
<operand>equals</operand>
</filter>
</filters>
</managementpack>
<export-path>C:\packs</export-path>
</command-parameters>
 </item>
</items>

The following figure shows the <items> XML for the Export Management Pack operation for Format 2.

<items> XML for the Export Management Pack operation for Format 2

<items>
 <item>
 <timeout-secs>120</timeout-secs>
<command-parameters>
<managementpack>
<managementpack-id>66de9512-d446-f46b-bb85-197ec864f1f7</managementpack-id>
</managementpack>
<export-path>C:\packs</export-path>
</command-parameters>
 </item>
</items>

The following figure shows the <items> XML for the Export Management Pack operation for Format 3.

<items> XML for the Export Management Pack operation for Format 3

<items>
 <item>
 <timeout-secs>120</timeout-secs>
<command-parameters>
<managementpack>
<managementpack-name>Microsoft.Windows.Client.BusinessCritical</managementpack-name>
</managementpack>
<export-path>C:\packs</export-path>
</command-parameters>
 </item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Export Management Pack operation

<request-data>
 <scom-request>
   <operation-name>Export-SCOMManagementPack</operation-name>
   <command-request>
     <timeout-secs>120</timeout-secs>
     <command-parameters>
       <managementpack>
         <managementpack-name>Microsoft.SystemCenter.ApplicationMonitoring.360.SLA</managementpack-name>
       </managementpack>
       <export-path>C:\packs</export-path>
     </command-parameters>
   </command-request>
 </scom-request>
</request-data>

The following figure shows the adapter response.

Adapter response for the Export Management Pack operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; (Get-SCOMManagementPack -name Microsoft.SystemCenter.ApplicationMonitoring.360.SLA) | Export-SCOMManagementPack -path 'C:\packs' | format-list</command>
       <execution-milliseconds>35085</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>0</count>
     </metadata>
     <output />
   </command-output>
 </commands-output>
</scom-response>

 

Back to top

Remove Management Pack operation

The Remove Management Pack operation uninstalls the specified management pack from the Microsoft System Center Operations Manager management server. 

The following table describes the adapter request elements for the Remove Management Pack operation.

Adapter request elements for the Remove Management Pack operation

Element

Definition

Required

<operation-name>

Specifies the operation name: 

Remove-SCOMManagementPack

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-name> element

Yes

<managementpack-name>

Specifies the name of the management pack that you want to uninstall

Yes

<preview>

Specifies whether you want to preview the results of the operation 

Valid values:

  • true: Indicates that you want to preview the results of the operation
  • false: Indicates that the operation is executed without displaying the results of the execution (default)

No

The following naming discrepancies exist between the Microsoft System Center Operations Manager application and API:

  • The ID attribute of the application is mapped to the Name attribute of the management pack in the API.
  • The Name attribute of the application is mapped to the DisplayName attribute of the management pack in the API.

The following figure shows the <items> XML for the Remove Management Pack operation. 

<items> XML for the Remove Management Pack operation

<items>
<item>
 <timeout-secs>120</timeout-secs>
  <command-parameters>
   <managementpack>
    <managementpack-name>Microsoft.Windows.Client.BusinessCritical</managementpack-name>
   </managementpack>
   <preview>true</preview>
  </command-parameters>
 </item>
</items>

The following figure shows the sample adapter request.

Sample adapter request for the Remove Management Pack operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; (Get-SCOMManagementPack -name Microsoft.SystemCenter.ApplicationMonitoring.360.SLA) | Export-SCOMManagementPack -path 'C:\packs' | format-list</command>
       <execution-milliseconds>35085</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>0</count>
     </metadata>
     <output />
   </command-output>
 </commands-output>
</scom-response>

The following figure shows the adapter response.

Adapter response for the Remove Management Pack operation

<scom-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command> Import-Module OperationsManager; Remove-SCOMManagementPack -managementpack (Get-SCOMManagementPack -name Microsoft.SystemCenter.ApplicationMonitoring.360.SLA) | format-list</command>
       <execution-milliseconds>97190</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
       <count>0</count>
     </metadata>
     <output />
   </command-output>
 </commands-output>
</scom-response>

Back to top

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*