Deployment VM Operations DEPRECATED

Details

API Details
Name

Deployment VM Operations – DEPRECATED in CloudCenter 4.4.0.

Use the Power On/Off or Reboot/Terminate VM API instead.

DescriptionStarts, stops, or reboots VMs launched by CloudCenter.
MethodPUT
URI/v1/virtualmachines/vmId?jobId=jobId&action=actionOption
CloudCenter Release

CloudCenter 3.x and 4.x

DEPRECATED in CloudCenter 4.4.0.

Notes
ESB Header

action: put.virtualmachines.vmId
actionparam: jobId=jobId&action=actionOption

See the Enterprise Service Bus (ESB) section for the relevant release for additional context.

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/virtualmachines/i-00c04ef6?jobId=511&action=reboot"

Response

{
 "Action":"Succeeded"
}

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

vmId
  • DescriptionUnique, system-generated identifier for a VM

  • Type: String

action
  • Description: Identifies the valid operations that can be performed on the VM.
  • Type: Array of Enumeration vmAction

    Enumeration Description
    STARTStart this VM
    STOPStop this VM
    REBOOTReboot this VM
    DELETEDelete this VM

The DELETE action is not applicable for this API.

Response Attributes

None

Terms & Conditions Privacy Statement Cookies Trademarks