Management Server management operation

This section illustrates the adapter request and response for the #get-managementserver operation and describes the elements used in the request.

get-managementserver operation

The get-managementserver operation retrieves the details of the management servers that are filtered by the specified search criterion.

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

Adapter request elements for the get-managementserver operation

Element

Definition

Required

<operation-name>

Specifies the operation name: get-managementserver

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 illustrates a sample adapter request for the get-managementserver operation: 

Sample adapter request for the get-managementserver operation

<scom-request>
<operation-name>get-managementserver</operation-name>
<command-request>
<timeout-secs>120</timeout-secs>
<command-parameters>
<filters>
<filter>
<managementserver-prop-key>Name</managementserver-prop-key>
<managementserver-prop-val>win2stdvm.neuron.com</managementserver-prop-val>
<operand>equals</operand>
</filter>
</filters>
</command-parameters>
</command-request>
</scom-request>



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

Sample adapter response for the get-managementserver operation

<scom-response>
<metadata>
<status>success</status>
<count>1</count>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>./Microsoft.EnterpriseManagement.OperationsManager.ClientShell.
Startup.ps1;get-managementserver | where-object {$_.Name -eq
'win2stdvm.neuron.com'}</command>
<execution-milliseconds>12831</execution-milliseconds>
<exit-code>0</exit-code>
<status>success</status>
<count>1</count>
</metadata>
<output>
<item>
<IsRootManagementServer>True</IsRootManagementServer>
<IsGateway>False</IsGateway>
<AemEnabled>True</AemEnabled>
<AutoApproveManuallyInstalledAgents>False</AutoApproveManuallyInstalledAgents>
<RejectManuallyInstalledAgents>True</RejectManuallyInstalledAgents>
<MissingHeartbeatThreshold>3</MissingHeartbeatThreshold>
<Id>9d465024-0c3b-33e3-f456-decfaa5eb781</Id>
<LastModified>1/8/2009 10:32:39 AM</LastModified>
<Name>win2stdvm.neuron.com</Name>
<DisplayName>win2stdvm.neuron.com</DisplayName>
<HostComputer>win2stdvm.neuron.com</HostComputer>
<HostedHealthService>win2stdvm.neuron.com</HostedHealthService>
<HealthState>Success</HealthState>
<PrincipalName>win2stdvm.neuron.com</PrincipalName>
<NetworkName>win2stdvm.neuron.com</NetworkName>
<ComputerName>win2stdvm</ComputerName>
<Domain>SYNAPSE</Domain>
<IPAddress>172.11.11.111</IPAddress>
<Version>6.0.6278.0</Version>
<RequestCompression>True</RequestCompression>
<CommunicationPort>5723</CommunicationPort>
<MaximumSizeOfAllTransferredFilesBytes>0</MaximumSizeOfAllTransferredFilesBytes>
<MaximumQueueSizeBytes>104857600</MaximumQueueSizeBytes>
<ManuallyInstalled>False</ManuallyInstalled>
<InstallTime>1/8/2009 3:43:16 PM</InstallTime>
<InstalledBy />
<CreateListener>True</CreateListener>
<AuthenticationName>win2stdvm.neuron.com</AuthenticationName>
<ActionAccountIdentity>james.calvin</ActionAccountIdentity>
<HeartbeatInterval>60</HeartbeatInterval>
<ProxyingEnabled>True</ProxyingEnabled>
<ManagementGroup>M1</ManagementGroup>
<ManagementGroupId>00000000-0000-0000-0000-000000000000</ManagementGroupId>
</item>
</output>
</command-output>
</commands-output>
</scom-response>

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

Comments