Power On/Power Off/Reboot/Terminate VM

Details

API Details
Name

Power On/Off or Reboot/Terminate VM

Description

Allows you to power on/off or reboot/terminate the specified VM.

MethodPUT
URI

v1/tenants/tenantId/vms/vmId

CloudCenter ReleaseIntroduced in CloudCenter 4.1.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The START, STOP, REBOOT, and DELETE operations are supported for the action (vmActionEnum) enumeration type.

ESB Headeraction: update.tenants.tenantId.vmsvmId

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/vms/i-6f8abdab" 

Request Body

{
    "id": null,
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/vms/i-6f8abdab",
    "perms": [],
    "hostName": null,
    "publicIpAddr": null,
    "privateIpAddr": null,
    "status": null,
    "startTime": null,
    "stopTime": null,
    "isCliqrLaunched": false,
    "userId": null,
    "jobId": null,
    "jobName": null,
    "userEmail": null,
    "vmOperationData": 
    {
        "action": "STOP",
        "depEnvId": "1",
        "depEnvName": null,
        "regionName": "Amazon-us-west-2"
    }
}

Response

The server responds with the HTTP Response code 200 OK if the deletion of the phase is successful.

Request Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
perms
  • Description: The permissions for a CloudCenter Resource managed by ACLs.

  • Type: Array of strings

    resourceName Permissions →

    Enumeration ↓

    read
    write
    create
    delete
    administration
    executemove_in
    move_out
    access
    approve
    authorize
    managenotify

    POLICY

    YesYes   

    ACTION_POLICY

    Yes    

    PUBLISHED_APP

    Yes    

    DEPLOYMENT_ENVIRONMENT 

    YesYesYesYes 

    APPLICATION

    Yes

    Yes

       

    REPOSITORY

    Yes    

    CLOUD_ACCOUNT 

    Yes    

    SYSTEM_TAG

    Yes    

    SECURITY_PROFILE

    Yes    

    SERVICE

    Yes    

    CUSTOM_ACTION

    Yes  Yes 
    PROJECTYes   Yes
    IMAGEYes    
    MANAGE_EXPORTYesYes   
    MANAGE_IMPORTYesYes   
hostName
  • Description: The DNS host name for this VM 
  • Type: String
publicIpAddr
  • Description: Public IP address of the application VM or CCO. This attribute is the same as the publicIp or publicIpAddress attributes.
  • Type: String
privateIpAddr
  • Description: Private IP address of the application VM or CCO. This attribute is the same as the privateIp attribute.
  • Type: String
status
  • Description: Status of the operation. See Deployment and VM States for a list of all job operations.
  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed
startTime
stopTime
  • Description: Stop time for this VM.
  • Type: Long
isCliqrLaunched
  • Description: Identifies if the server was launched using CCM.
  • Type: Boolean
userId
  • Description: Unique, system-generated identifier for a user
  • Type: String
jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String
jobName
  • Description: The name of this job
  • Type: String
userEmail
  • Description: Email address of the resource
  • Type: String
vmOperationData (click for additional details)

Response Attributes

None.