Page tree

Overview

The Perform VM Power Actions API call performs a power action on a virtual machine. 

You can use the Get VMs to find the virtual machine ID (id).

Sample request

POST  https://api.armor.com/vms/1/power/reset

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type

/vms/{id}/power/{powerAction}

POST


The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionRequired or optionalTypeExample
idThe ID of the virtual machineRequiredInteger1
powerAction

The desired action:

  • on - This action will turn on your virtual machine.
  • off - This action will turn off your virtual machine
  • forceOff - This action will forcefully turn off your virtual machine if off does not respond. 
  • shutdown - This action will turn off the operating system on your virtual machine. 
  • reboot - This action will reset the operating system on your virtual machine. 
  • reset- This action will reboot your virtual machine. 
OptionalStringreset



Sample return

StatusResponse
200
{
 "canUseFluidScale": false,
 "disks": [],
 "isDeleted": false,
 "id": 9,
 "coreInstanceId": "00000000-0000-0000-0000-000000000000",
 "name": "New_Test_0100",
 "provider": "4",
 "location": "DFW01",
 "zone": "DFW01-VC01",
 "ipAddress": "",
 "status": 8,
 "appId": 1,
 "appName": "General Dynamics Web",
 "osId": null,
 "os": "Ubuntu 14.04",
 "deployed": false,
 "cpu": 1,
 "memory": 2048,
 "storage": 30720,
 "notes": null,
 "vCenterId": 2,
 "vCenterName": "DFW01-VC01",
 "product": {
      "sku":"A1-122",
      "size": "A1",
      "isExpired": false
 },
 "uuid": "urn:firehost:b5e1892b-bf4d-4209-b513-83c04f187ca3",
 "health": 0,
 "tags": [],
 "scheduledEvents": []
}
400
Bad Request

Output

The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample
canUseFluidScaleBoolean valueFluidScale allows for application scaling without a reboot.true, falsefalse
statusIntegerThe state of the object

A range of numbers from -1 to 19

(See Note below for possible values)

8
taskDateDate and timeThe date and time, in combined date and time format (ISO 8601), of when the event will take place Any date and time2016-09-01T00:00:00
maitenanceWindowIntegerA countdown of when the event will take placeAny value in minutes60

 The following table lists the possible return values for Status:

Numeric valueString valueDescription
-1FAILED_CREATIONThe object could not be created
0UNRESOLVEDThe object is unresolved
1RESOLVEDThe object is resolved
2DEPLOYEDThe object is deployed
3SUSPENDEDThe object is suspended
4POWERED_ONThe object is powered on
5WAITING_FOR_INPUTThe object is waiting for user input
6UNKNOWNThe object is in an unknown state
7UNRECOGNIZEDThe object is in an unrecognized state
8POWERED_OFFThe object is powered off.
9INCONSISTENT_STATEThe object is in an inconsistent state
10MIXEDChildren do not all have the same status
11DESCRIPTION_PENDINGUpload initiated, OVF descriptor pending
12COPYING_CONTENTSUpload initiated, copying contents
13DISK_CONTENTS_PENDINGUpload initiated, disk contents pending
14QUARANTINEDUpload has been quarantined
15QUARANTINE_EXPIREDUpload quarantine period has expired
16REJECTEDUpload has been rejected
17TRANSFER_TIMEOUTUpload transfer session timed out
18VAPP_UNDEPLOYEDThe vApp is resolved and undeployed
19VAPP_PARTIALLY_DEPLOYEDThe vApp is resolved and partially deployed.
100CHANGES_PENDINGThe request has been received, but not completed. 
101COMPLETEThe action has been completed. 
102BUSYThe server is busy and cannot complete the action. Try again. 
103TEMPLATE_PENDINGThe virtual machine template is currently being generated.




In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.