Suspend VM operation

The Suspend VM operation pauses the virtual machine activity. If the <status> response element contains _success_, the <Task> response element contains the ID of the queued task, which you can use to obtain the task status. All transactions remain in the frozen state, until the virtual machine gets a Resume command.

The following table describes the elements for this request.

Adapter request elements for the Suspend VM operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Basic_Vm	Yes
<operation-name>	Defines the name of operation: Suspend_VM	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 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 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 the Suspend operation is to be executed	Yes

The following code sample shows the sample adapter request for the Suspend VM operation.

Sample adapter request for the Suspend VM operation

<vmware-infrastructure-request>
    <operation-type>Basic_Vm</operation-type>
    <operation-name>Suspend_VM</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 Suspend VM operation.

Sample adapter response for the Suspend VM operation

<vmware-infrastructure-response>
    <metadata>
       <status>success</status>
    </metadata>
       <SuspendVM_TaskResponse>
           <Task>task-712</Task>
       </SuspendVM_TaskResponse>
</vmware-infrastructure-response>

The following table describes the response element.

Adapter response element for the Suspend VM operation

Element	Definition
<Task>	Specifies the task ID of the submitted task Use the task ID to obtain the status of the specified task. For information about using the task ID to check the task status, see Request and response for the Retrieve_Task_Status operation.

Suspend VM operation

On this page