In This Document
Was this document useful?
Have a suggestion for the Armor Knowledge Base? Send a message to email@example.com.
The Get VMs API displays a list of virtual machines in your account.
This API also displays any schedule events associated with the virtual machine, such as a scheduled downgrade.
The following table describes the different parts of this API call:
|API Call / URL||Method / Type|
There are no parameters for this API call.
The following table describes the expected results for specific outputs that may not be clear enough within the sample output.
|status||Integer||The state of the object|
A range of numbers from -1 to 19
(See Note below for possible values)
|taskDate||Date and time||The date and time, in combined date and time format (ISO 8601), of when the event will take place||Any date and time||2016-09-01T00:00:00|
|maitenanceWindow||Integer||A countdown of when the event will take place||Any value in minutes||60|
The following table lists the possible return values for Status:
|Numeric value||String value||Description|
|-1||FAILED_CREATION||The object could not be created|
|0||UNRESOLVED||The object is unresolved|
|1||RESOLVED||The object is resolved|
|2||DEPLOYED||The object is deployed|
|3||SUSPENDED||The object is suspended|
|4||POWERED_ON||The object is powered on|
|5||WAITING_FOR_INPUT||The object is waiting for user input|
|6||UNKNOWN||The object is in an unknown state|
|7||UNRECOGNIZED||The object is in an unrecognized state|
|8||POWERED_OFF||The object is powered off.|
|9||INCONSISTENT_STATE||The object is in an inconsistent state|
|10||MIXED||Children do not all have the same status|
|11||DESCRIPTION_PENDING||Upload initiated, OVF descriptor pending|
|12||COPYING_CONTENTS||Upload initiated, copying contents|
|13||DISK_CONTENTS_PENDING||Upload initiated, disk contents pending|
|14||QUARANTINED||Upload has been quarantined|
|15||QUARANTINE_EXPIRED||Upload quarantine period has expired|
|16||REJECTED||Upload has been rejected|
|17||TRANSFER_TIMEOUT||Upload transfer session timed out|
|18||VAPP_UNDEPLOYED||The vApp is resolved and undeployed|
|19||VAPP_PARTIALLY_DEPLOYED||The vApp is resolved and partially deployed.|
|100||CHANGES_PENDING||The request has been received, but not completed.|
|101||COMPLETE||The action has been completed.|
|102||BUSY||The server is busy and cannot complete the action. Try again.|
|103||TEMPLATE_PENDING||The virtual machine template is currently being generated.|