VM

API that can retrieve the VMs associated with a domain, zone or subnet for mediation created VM's for REST created VM's you need to set the additional proxy user header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example : Nokia@bob), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.

Overview

computeProvisioned boolean creation only  
creationDate string read only   autogenerated   orderable  
deleteExpiry integer filterable   orderable  
deleteMode enum (TIMER) filterable   orderable  
domainIDs list
embeddedMetadata list read only   autogenerated  
enterpriseID string
enterpriseName string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
hypervisorIP string filterable   orderable  
interfaces list
l2DomainIDs list
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
orchestrationID string
owner string autogenerated  
reasonType enum (BLOCKED_LAST | BLOCKED_UNKNOWN | CRASHED_LAST | CRASHED_UNKNOWN | NOSTATE_LAST | NOSTATE_UNKNOWN | PAUSED_DUMP | PAUSED_FROM_SNAPSHOT | PAUSED_IOERROR | PAUSED_LAST | PAUSED_MIGRATION | PAUSED_SAVE | PAUSED_SHUTTING_DOWN | PAUSED_UNKNOWN | PAUSED_USER | PAUSED_WATCHDOG | RUNNING_BOOTED | RUNNING_FROM_SNAPSHOT | RUNNING_LAST | RUNNING_MIGRATED | RUNNING_MIGRATION_CANCELED | RUNNING_RESTORED | RUNNING_SAVE_CANCELED | RUNNING_UNKNOWN | RUNNING_UNPAUSED | SHUTDOWN_LAST | SHUTDOWN_UNKNOWN | SHUTDOWN_USER | SHUTOFF_CRASHED | SHUTOFF_DESTROYED | SHUTOFF_FAILED | SHUTOFF_FROM_SNAPSHOT | SHUTOFF_LAST | SHUTOFF_MIGRATED | SHUTOFF_SAVED | SHUTOFF_SHUTDOWN | SHUTOFF_UNKNOWN | UNKNOWN) filterable   orderable  
resyncInfo object
siteIdentifier string filterable   orderable  
status enum (BLOCKED | CRASHED | DELETE_PENDING | IDLE | INIT | LAST | NOSTATE | PAUSED | RUNNING | SHUTDOWN | SHUTOFF | UNKNOWN | UNREACHABLE) filterable   orderable  
subnetIDs list
userID string
userName string filterable   orderable  
UUID string required   filterable   orderable  
VRSID string
vrsRawVersion string read only   filterable   orderable  
vrsVersion string read only   filterable   orderable  
zoneIDs list

API Resource

/vms/id
delete get put

Parents

/qos/id/vms
get
/enterprises/id/vms
get
/zones/id/vms
get
/vms
get post
/vports/id/vms
get
/subnets/id/vms
get
/vrss/id/vms
get
/domains/id/vms
get
/l2domains/id/vms
get
get
get
/users/id/vms
get
get

Children

/vms/id/permissions
delete get post put
/vms/id/resync
get post
/vms/id/metadatas
get post
/vms/id/alarms
get
/vms/id/globalmetadatas
get post put
/vms/id/vminterfaces
get post
/vms/id/vrss
get
/vms/id/eventlogs
get

Members

This object has no members.

Attributes documentation

computeProvisioned boolean creation only  
Discussion

computeProvisioned


Charateristics

SDK attribute: computeProvisioned

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

deleteExpiry integer filterable   orderable  
Discussion

Reflects the VM Deletion expiry timer in seconds, deleteMode needs to be non-null value for deleteExpiry to be taken in to effect. CMS created VMs will always have deleteMode set to TIMER.


Charateristics

SDK attribute: deleteExpiry

deleteMode enum filterable   orderable  
Discussion

Reflects the mode of VM Deletion.


Charateristics

Allowed values: TIMER
SDK attribute: deleteMode

domainIDs list
Discussion

Array of IDs of the domain that the VM is connected to


Charateristics

SDK attribute: domainIDs

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

enterpriseID string
Discussion

ID of the enterprise that this VM belongs to


Charateristics

Format: free
SDK attribute: enterpriseID

enterpriseName string filterable   orderable  
Discussion

Name of the enterprise that this VM belongs to


Charateristics

Format: free
SDK attribute: enterpriseName

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

hypervisorIP string filterable   orderable  
Discussion

IP address of the hypervisor that this VM is currently running in


Charateristics

Format: free
SDK attribute: hypervisorIP

interfaces list
Discussion

List of VM interfaces associated with the VM


Charateristics

SDK attribute: interfaces

l2DomainIDs list
Discussion

Array of IDs of the l2 domain that the VM is connected to


Charateristics

SDK attribute: l2DomainIDs

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.


Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of the VM


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

orchestrationID string
Discussion

Orchestration ID


Charateristics

Format: free
SDK attribute: orchestrationID

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

reasonType enum filterable   orderable  
Discussion

Reason of the event associated with the VM.


Charateristics

Allowed values: BLOCKED_LAST, BLOCKED_UNKNOWN, CRASHED_LAST, CRASHED_UNKNOWN, NOSTATE_LAST, NOSTATE_UNKNOWN, PAUSED_DUMP, PAUSED_FROM_SNAPSHOT, PAUSED_IOERROR, PAUSED_LAST, PAUSED_MIGRATION, PAUSED_SAVE, PAUSED_SHUTTING_DOWN, PAUSED_UNKNOWN, PAUSED_USER, PAUSED_WATCHDOG, RUNNING_BOOTED, RUNNING_FROM_SNAPSHOT, RUNNING_LAST, RUNNING_MIGRATED, RUNNING_MIGRATION_CANCELED, RUNNING_RESTORED, RUNNING_SAVE_CANCELED, RUNNING_UNKNOWN, RUNNING_UNPAUSED, SHUTDOWN_LAST, SHUTDOWN_UNKNOWN, SHUTDOWN_USER, SHUTOFF_CRASHED, SHUTOFF_DESTROYED, SHUTOFF_FAILED, SHUTOFF_FROM_SNAPSHOT, SHUTOFF_LAST, SHUTOFF_MIGRATED, SHUTOFF_SAVED, SHUTOFF_SHUTDOWN, SHUTOFF_UNKNOWN, UNKNOWN
SDK attribute: reasonType

resyncInfo object
Discussion

Information of the status of the resync operation of a VM


Charateristics

SDK attribute: resyncInfo

siteIdentifier string filterable   orderable  
Discussion

This property specifies the site the VM belongs to, for Geo-redundancy.


Charateristics

Format: free
SDK attribute: siteIdentifier

status enum filterable   orderable  
Discussion

Status of the VM.


Charateristics

Allowed values: BLOCKED, CRASHED, DELETE_PENDING, IDLE, INIT, LAST, NOSTATE, PAUSED, RUNNING, SHUTDOWN, SHUTOFF, UNKNOWN, UNREACHABLE
SDK attribute: status

subnetIDs list
Discussion

Array of IDs of the subnets that the VM is connected to


Charateristics

SDK attribute: subnetIDs

userID string
Discussion

ID of the user that created this VM


Charateristics

Format: free
SDK attribute: userID

userName string filterable   orderable  
Discussion

Username of the user that created this VM


Charateristics

Format: free
SDK attribute: userName

UUID string required   filterable   orderable  
Discussion

UUID of the VM


Charateristics

Format: free
SDK attribute: UUID

VRSID string
Discussion

Id of the VRS that this VM is attached to.


Charateristics

Format: free
SDK attribute: VRSID

vrsRawVersion string read only   filterable   orderable  
Discussion

Release version of VRS, which is used to determine the feature capabilties of VRS.


Charateristics

Format: free
Max length: 255
SDK attribute: vrsRawVersion

vrsVersion string read only   filterable   orderable  
Discussion

Interpreted version of VRS, which is used to determine the feature capabilities of VRS.


Charateristics

Format: free
Max length: 255
SDK attribute: vrsVersion

zoneIDs list
Discussion

Array of IDs of the zone that this VM is attached to


Charateristics

SDK attribute: zoneIDs