Shut Down Guest OS operation

The Shut Down Guest OS operation shuts down the guest operating system without powering off the virtual machine. You cannot immediately act on a virtual machine whose guest OS is being shut down; instead, you must verify that the guest OS for which shutdown has been initiated has indeed completed by verifying that the {{<status>}} element contains success.

The following table describes the elements for this request.

Adapter request elements for the Shut Down Guest OS operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Basic_Vm	Yes
<operation-name>	Defines the name of operation: Shut_Down_Guest_OS	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Warning If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Warning If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the <virtual-machine> element required to execute the operation	Yes
<virtual-machine>	Contains the name of the virtual machine on which this operation is to be executed	Yes

The following code sample shows a sample adapter request for the Shut Down Guest OS operation.

Sample adapter request for the Shut Down Guest OS operation

<vmware-infrastructure-request>
    <operation-type>Basic_Vm</operation-type>
    <operation-name>Shut_Down_Guest_OS</operation-name>
<soap-url></soap-url>
<transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
       <virtual-machine>win1</virtual-machine>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Shut Down Guest OS operation.

Sample adapter response for the Shut Down Guest OS operation

<vmware-infrastructure-response>
    <metadata>
       <status>success</status>
    </metadata>
     <ShutdownGuestResponse>
    </ShutdownGuestResponse>
</vmware-infrastructure-response>

Adapter response element for the Shut Down Guest OS operation

Element	Definition
<status>	Contains the status of the operation Valid values: success, error If the <status> element contains error, the response format is as shown in the following code snippet: <vmware-infrastructure-response> <metadata> <status>error</status> </metadata> <Fault> <faultcode>ServerFaultCode</faultcode> <faultstring>The attempted operation cannot be performed in the current state (Suspended).</faultstring> <detail> <InvalidPowerState> <requestedState>poweredOn</requestedState> <existingState>suspended</existingState> </InvalidPowerState> </detail> </Fault> </vmware-infrastructure-response
<ShutdownGuestResponse>	Is empty if the <status> element contains success; contains the <Fault> element if the <status> element contains error

Element

Definition

Contains the status of the operation

Valid values: success, error

If the <status> element contains error, the response format is as shown in the following code snippet:

<vmware-infrastructure-response>
<metadata>
<status>error</status>
</metadata>
<Fault>
<faultcode>ServerFaultCode</faultcode>
<faultstring>The attempted operation cannot be performed in the current state (Suspended).</faultstring>
<detail>
<InvalidPowerState>
<requestedState>poweredOn</requestedState>
<existingState>suspended</existingState>
</InvalidPowerState>
</detail>
</Fault>
</vmware-infrastructure-response

Is empty if the <status> element contains success; contains the <Fault> element if the <status> element contains error

Shut Down Guest OS operation

TrueSight Orchestration Content 20.19.02

On this page