A vm object represents a virtual machine which encompasses network elements such as IP addresses (fixed and floating, private and public), DNS names and all related extensive attributes.
References to grid:cloudapi:vm are object references. The name part of a vm object reference has the following components:
- ID of the VM
- Name of the VM
Example: grid:cloudapi:vm/ZGldHdvcmtfdmlldyQxMTk:i-bfc15674/vm1
The object does not support the following operations:
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): comment, id, name.
Availability zone of the VM.
Type
String.
Search
The field is not available for search.
Notes
The availability_zone cannot be updated.
availability_zone cannot be written.
Structure containing all the cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
Comment for the vm object; maximum 1024 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The comment is part of the base object.
Elastic IP address associated with the VM’s primary interface.
Type
String.
Search
The field is available for search via
Notes
The elastic_ip_address cannot be updated.
elastic_ip_address cannot be written.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The timestamp when the VM was first seen in the system.
Type
Timestamp.
Search
The field is not available for search.
Notes
The first_seen cannot be updated.
first_seen cannot be written.
Hostname part of the FQDN for the address associated with the VM’s primary interface.
Type
String.
Search
The field is not available for search.
Notes
The hostname cannot be updated.
hostname cannot be written.
Unique ID associated with the VM. This is set only when the VM is first created.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The id is part of the base object.
The id cannot be updated.
id cannot be written.
Identifier of the kernel that this VM is running; maximum 128 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is not available for search.
The timestamp when the last event associated with the VM happened.
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_seen cannot be updated.
last_seen cannot be written.
Name of the VM.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The name is part of the base object.
Number of Networks containing any address associated with this VM.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The network_count cannot be updated.
network_count cannot be written.
Guest Operating system that this VM is running; maximum 128 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is not available for search.
MAC address associated with the VM’s primary interface.
Type
String.
Search
The field is available for search via
Notes
The primary_mac_address cannot be updated.
primary_mac_address cannot be written.
Address of the network that is the container of the address associated with the VM’s primary interface.
Type
String.
Search
The field is not available for search.
Notes
The subnet_address cannot be updated.
subnet_address cannot be written.
CIDR of the network that is the container of the address associated with the VM’s primary interface.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The subnet_cidr cannot be updated.
subnet_cidr cannot be written.
Subnet ID of the network that is the container of the address associated with the VM’s primary interface.
Type
String.
Search
The field is not available for search.
Notes
The subnet_id cannot be updated.
subnet_id cannot be written.
Name of the tenant associated with the VM.
Type
String.
Search
The field is not available for search.
Notes
The tenant_name cannot be updated.
tenant_name cannot be written.
VM type; maximum 64 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is not available for search.
Network address of the parent VPC.
Type
String.
Search
The field is not available for search.
Notes
The vpc_address cannot be updated.
vpc_address cannot be written.
Network CIDR of the parent VPC.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The vpc_cidr cannot be updated.
vpc_cidr cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| availability_zone | String | N | Y | N | N/A |
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | Y | : = ~ |
| elastic_ip_address | String | N | Y | N | = |
| extattrs | Extattr | N | N | N | ext |
| first_seen | Timestamp | N | Y | N | N/A |
| hostname | String | N | Y | N | N/A |
| id | String | N | Y | Y | = |
| kernel_id | String | N | N | N | N/A |
| last_seen | Timestamp | N | Y | N | N/A |
| name | String | N | N | Y | : = ~ |
| network_count | Unsigned int | N | Y | N | N/A |
| operating_system | String | N | N | N | N/A |
| primary_mac_address | String | N | Y | N | = |
| subnet_address | String | N | Y | N | N/A |
| subnet_cidr | Unsigned int | N | Y | N | N/A |
| subnet_id | String | N | Y | N | N/A |
| tenant_name | String | N | Y | N | N/A |
| vm_type | String | N | N | N | N/A |
| vpc_address | String | N | Y | N | N/A |
| vpc_cidr | Unsigned int | N | Y | N | N/A |
| vpc_id | String | N | Y | N | N/A |
| vpc_name | String | N | Y | N | N/A |
