Stop VMRack operation

The Stop VMRack operation stops a VMRack.

The following table describes the <items> XML and request elements for the Stop VMRack operation.

Adapter request elements for the Stop VMRack operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: stop-vmrack

Yes

<arguments>

Specifies a list of elements that are required for the operation

Yes

<targets>

Contains one or more <target> elements

Conditional; required if the actor adapter configuration is empty

<target>

Contains the name attribute that references a BMC Atrium Orchestrator Grid Manager configuration node, or contains the elements that define a dynamic target

To reference a Grid Manager configuration node, the <target> element must be specified as a child of the <arguments> element and must contain the name of a configuration node that is defined in Grid Manager. If <target> is not provided or is left empty, the request is executed on the first defined configuration node.

To define a dynamic target, you can use one or more <target> elements in the <targets> element. If a dynamic target is not specified, the adapter uses the configuration information specified in Grid Manager. You can define dynamic targets by using the following child elements:

  • <host>
  • <user-name>
  • <password>
  • <protocol>
  • <port>
  • <use-ssl-certificate>
  • <allow-unsigned-certificate>
  • <install-certificate>
  • <passphrase>

Conditional; required if a target is referenced or defined in the request

<host>

Specifies the host name or the IP address of the server where the Dell AIM controller is installed

Conditional; required when using dynamic targets

<user-name>

Specifies the user name for the Dell AIM controller authentication

Conditional; required when using dynamic targets

<password>

Specifies the password that corresponds to the user name

The password element can contain an encryption-type attribute that indicates whether the password specified is encrypted.

Valid values for encryption-type attribute: Plain (default), Base64

Conditional; required when using dynamic targets

<protocol>

Specifies the communication protocol for the Dell AIM controller

Valid values: http (default), https

No

<port>

Specifies the communication port for the Dell AIM controller

Default values:

  • 80 for http protocol
  • 443 for https protocol

No

<use-ssl-certificate>

Specifies whether SSL certificates are used for authentication

Valid values: false (default), true

No

<allow-unsigned-certificates>

Specifies whether to allow unsigned certificates from trusted zones

If you are using self-signed SSL certificates (a common practice), set the value of this element to true.

On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte (a rare practice), set the value of this element to false.

Valid values: false (default), true

No

<install-certificate>

Specifies whether to install security certificates automatically

If you prefer to have security certificates installed automatically (a common practice), set the value of this element to true.

If you prefer to manually export the security certificate from the Dell AIM server and manually import it into the cacerts file of the local peer of BMC Atrium Orchestrator (a rare practice), set the value of this element to false.

Valid values: false (default), true

No

<passphrase>

Specifies the password to the keystore file (cacerts ) local to the BMC Atrium Orchestrator peer

Default value: changeit

Note

The value of the <passphrase> element must match the password in the keystore. You can change the password by using keytool. If you change the password, you must update the value of the <passphrase> element.

No

<vmrack-id>

Specifies the ID of the VMRack that is stopped

Yes

The following figure illustrates a sample adapter request for the Stop VMRack operation:

Sample adapter request for the Stop VMRack operation

<dell-aim-request>
    <operation-name>stop-vmrack</operation-name>
    <arguments>
      <target>con</target>
      <vmrack-id>CH.0.11</vmrack-id>
    </arguments>
</dell-aim-request>

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

Sample adapter response for the Stop VMRack operation

<dell-aim-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>con</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <message>VMRack with ID - "CH.0.11" stopped successfully.</message>
      </output>
    </response>
  </responses>
</dell-aim-response>
Was this page helpful? Yes No Submitting... Thank you

Comments