Shut down virtual guest
This topic lists the XML samples and node element descriptions required for configuring the request and response of the VMware_Integration module for shutting down a virtual guest.
The following table lists the workflow names used for shutting down a virtual guest in the VMware and BMC Cloud Lifecycle Management integration:
Workflow type | Name |
|---|---|
CLM_Integration | Shutdown Virtual Guest |
VMware_Integration | Shutdown Virtual Guest Implementation |
Request to VMware_Integration module
All of the following node elements are required for configuring the request:
Name | Description | Sample values |
|---|---|---|
<server-name> | Specifies the management server to be used for managing the virtual clusters and hosts | MICRO-CSM-VC01.bmc.com |
<polling-count> | Specifies the number of times polling is done before it is timed out. | 100 |
<polling-interval> | Specifies the time interval, in seconds, between successive pollings | 30 |
<vapp> | Specifies a name to be assigned to the virtual guest to be provisioned | riverbed-1 |
<deployment-params> | Contains deployment parameters, in XML format, specified during provisioning | None |
<param> | Contains individual parameter details | None |
<key> | Specifies the key type used for the deployment parameter | SCRATCHPAD_TXN_ID |
<value> | Specifies the value of the deployment parameter key | 17c87ce9-2e80-468f-b884-f327382e7aa2 |
Response from VMware_Integration module
XML sample for configuring the response
<shutdown-status>success</shutdown-status>
</virtual-guest>
The following node element is required for configuring the response:
Element | Description | Sample values |
|---|---|---|
<shutdown-status> | Represents the final status of the shutdown operation | success, or failure |
If an error occurs during execution, error XML code is returned in the following format:
<error>Error Message</error>
</value>