Management Server operation for Microsoft System Center Operations Manager 2012

This topic describes the adapter request and responses for the Management Server operation.

Find Management Server operation

The Find Management Server operation retrieves the details of the management servers that are filtered by the specified search criterion. 

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

Adapter request elements for the Find Management Server operation

Element

Definition

Required

<operation-name>

Specifies the operation name: Get-SCOMManagementServer

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 search criterion by using multiple <filter> elements.

Conditional; required if the <filters>element is specified

<managementserver-prop-key>

Specifies the name of the management server's entity property used in the search 

Valid values:

  • Domain
  • ManagementGroupId
  • ProxyingEnabled
  • MaximumQueueSizeBytes
  • CommunicationPort
  • DisplayName
  • Version
  • RequestCompression
  • IsGateway
  • Id
  • Name
  • HostComputer
  • IPAddress
  • Version
  • ManuallyInstalled
  • MaximumSizeOfAllTransferredFilesBytes
  • HostedHealthService
  • HealthState
  • PrincipalName
  • NetworkName
  • ComputerName

Conditional; required if the <filters>element is specified

<managementserver-prop-val>

Specifies the value of the property specified in the <managementserver-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 <managementserver-prop-key> and <managementserver-prop-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 Management Server operation.

<items> XML for the Find Management Server operation

 <items>
	<item>
		<timeout-secs>120</timeout-secs>
		<command-parameters>
		<filters>
			<filter>
				<managementserver-prop-key>Name</managementserver-prop-key>
				<managementserver-prop-val>clm-pun-021145.bmc.com</managementserver-prop-val>
				<operand>equals</operand>
			</filter>
		</filters>
		</command-parameters>
	</item>
</items>

The following figure shows the sample adapter request. 

Sample adapter request for the Find Management Server operation

<request-data>
  <scom-request>
    <operation-name>Get-SCOMManagementServer</operation-name>
    <command-request>
      <timeout-secs>120</timeout-secs>
      <command-parameters>
        <filters>
          <filter>
            <managementserver-prop-key>Name</managementserver-prop-key>
            <managementserver-prop-val>VW-PUN-BNA-DV22.punbnadv21.local</managementserver-prop-val>
            <operand>equals</operand>
          </filter>
        </filters>
      </command-parameters>
    </command-request>
  </scom-request>
</request-data>

The following figure shows the adapter response.

Adapter response for the Find Management Server operation

<scom-response>
  <metadata>
    <status>success</status>
    <count>1</count>
  </metadata>
  <commands-output>
    <command-output>
      <metadata>
        <command> Import-Module OperationsManager; Get-SCOMManagementServer | where-object {$_.Name -eq 'VW-PUN-BNA-DV22.punbnadv21.local'} | format-list</command>
        <execution-milliseconds>54507</execution-milliseconds>
        <exit-code>0</exit-code>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <item>
          <IsRootManagementServer><![CDATA[True]]></IsRootManagementServer>
          <IsGateway><![CDATA[False]]></IsGateway>
          <AemEnabled><![CDATA[False]]></AemEnabled>
          <AutoApproveManuallyInstalledAgents><![CDATA[False]]></AutoApproveManuallyInstalledAgents>
          <RejectManuallyInstalledAgents><![CDATA[True]]></RejectManuallyInstalledAgents>
          <MissingHeartbeatThreshold><![CDATA[3]]></MissingHeartbeatThreshold>
          <ManagementGroup><![CDATA[SCOM-GROUP]]></ManagementGroup>
          <Id><![CDATA[148814ad-18b7-aa34-2348-dbd94b249012]]></Id>
          <LastModified>12/14/2016 11:44:21 AM</LastModified>
          <Name><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></Name>
          <DisplayName><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></DisplayName>
          <HostComputer><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></HostComputer>
          <HostedHealthService><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></HostedHealthService>
          <HealthState>Healthy</HealthState>
          <PrincipalName><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></PrincipalName>
          <NetworkName><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></NetworkName>
          <ComputerName><![CDATA[VW-PUN-BNA-DV22]]></ComputerName>
          <Domain><![CDATA[punbnadv21.local]]></Domain>
          <IPAddress><![CDATA[10.129.83.176]]></IPAddress>
          <Version><![CDATA[7.2.11719.0]]></Version>
          <RequestCompression><![CDATA[True]]></RequestCompression>
          <CommunicationPort><![CDATA[5723]]></CommunicationPort>
          <MaximumSizeOfAllTransferredFilesBytes><![CDATA[0]]></MaximumSizeOfAllTransferredFilesBytes>
          <MaximumQueueSizeBytes><![CDATA[104857600]]></MaximumQueueSizeBytes>
          <ManuallyInstalled><![CDATA[False]]></ManuallyInstalled>
          <InstallTime>12/14/2016 04:52:47 PM</InstallTime>
          <InstalledBy></InstalledBy>
          <CreateListener><![CDATA[True]]></CreateListener>
          <AuthenticationName><![CDATA[VW-PUN-BNA-DV22.punbnadv21.local]]></AuthenticationName>
          <ActionAccountIdentity><![CDATA[PUNBNADV21\SCOMADMIN]]></ActionAccountIdentity>
          <HeartbeatInterval><![CDATA[60]]></HeartbeatInterval>
          <ProxyingEnabled><![CDATA[True]]></ProxyingEnabled>
          <ManagementGroupId><![CDATA[00000000-0000-0000-0000-000000000000]]></ManagementGroupId>
        </item>
      </output>
    </command-output>
  </commands-output>
</scom-response>
Was this page helpful? Yes No Submitting... Thank you

Comments