VM address is an abstract object that represents a virtual machine running on the Cloud Management Platform.
References to grid:cloudapi:vmaddress are object references. The name part of a Grid Cloud API VM address object reference has the following components:
- Name of Grid Cloud API VM address
Example: grid:cloudapi:vmaddress/ZGldHdvcmtfdmlldyQxMTk:vnname1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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): address, is_ipv4, network_view, port_id, vm_name.
The IP address of the interface.
Type
String.
Search
The field is available for search via
Notes
The address is part of the base object.
The address cannot be updated.
address cannot be written.
IP address type (Public, Private, Elastic, Floating, ...).
Type
String.
Search
The field is not available for search.
Notes
The address_type cannot be updated.
address_type cannot be written.
Reference to associated IPv4 or IPv6 address.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The associated_ip cannot be updated.
associated_ip cannot be written.
Array of string denoting the types of underlying objects IPv4/IPv6 - “A”, “AAAA”, “PTR”, “HOST”, “FA”, “RESERVATION”, “UNMANAGED” + (“BULKHOST”, “DHCP_RANGE”, “RESERVED_RANGE”, “LEASE”, “NETWORK”, “BROADCAST”, “PENDING”),
Type
String array.
Search
The field is not available for search.
Notes
The associated_object_types cannot be updated.
associated_object_types cannot be written.
The list of references to the object (Host, Fixed Address, RR, ...) that defines this IP.
Type
An array of the following objects: fixedaddress, ipv6fixedaddress, ipv6range, lease, range, record:a, record:aaaa, record:host, record:host_ipv4addr, record:host_ipv6addr, record:ptr.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The associated_objects cannot be updated.
associated_objects cannot be written.
Structure containing all the cloud API related information. Only management platform “mgmt_platform” is updated 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.
The list of all FQDNs associated with the IP address.
Type
String array.
Search
The field is not available for search.
Notes
The dns_names cannot be updated.
dns_names cannot be written.
Elastic IP address associated with this private address, if this address is a private address; otherwise empty.
Type
String.
Search
The field is not available for search.
Notes
The elastic_address cannot be updated.
elastic_address cannot be written.
Name of the interface associated with this IP address.
Type
String.
Search
The field is not available for search.
Notes
The interface_name cannot be updated.
interface_name cannot be written.
Indicates whether the address is IPv4 or IPv6.
Type
Bool.
Search
The field is not available for search.
Notes
The is_ipv4 is part of the base object.
The is_ipv4 cannot be updated.
is_ipv4 cannot be written.
The MAC address of the interface.
Type
String.
Search
The field is available for search via
Notes
The mac_address cannot be updated.
mac_address cannot be written.
The Microsoft Active Directory user related information.
Type
A/An Active Directory User Data struct.
Search
The field is not available for search.
Notes
The ms_ad_user_data cannot be updated.
ms_ad_user_data cannot be written.
The network to which this address belongs, in IPv4 Address/CIDR format.
Type
String.
Search
The field is not available for search.
Notes
The network cannot be updated.
network cannot be written.
Network view name of the delegated object.
Type
String.
Search
The field is not available for search.
Notes
The network_view is part of the base object.
The network_view cannot be updated.
network_view cannot be written.
Port identifier of the interface.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The port_id is part of the base object.
The port_id cannot be updated.
port_id cannot be written.
Private IP address associated with this public (or elastic or floating) address, if this address is a public address; otherwise empty.
Type
String.
Search
The field is not available for search.
Notes
The private_address cannot be updated.
private_address cannot be written.
Host part of the FQDN of this address if this address is a private address; otherwise empty
Type
String.
Search
The field is not available for search.
Notes
The private_hostname cannot be updated.
private_hostname cannot be written.
Public IP address associated with this private address, if this address is a private address; otherwise empty.
Type
String.
Search
The field is not available for search.
Notes
The public_address cannot be updated.
public_address cannot be written.
Host part of the FQDN of this address if this address is a public (or elastic or floating) address; otherwise empty
Type
String.
Search
The field is not available for search.
Notes
The public_hostname cannot be updated.
public_hostname cannot be written.
Network address of the subnet that is the container of this address.
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 subnet that is the container of this address.
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 that is the container of this address.
Type
String.
Search
The field is not available for search.
Notes
The subnet_id cannot be updated.
subnet_id cannot be written.
The Cloud API Tenant object.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The tenant cannot be updated.
tenant cannot be written.
Availability zone of the VM.
Type
String.
Search
The field is not available for search.
Notes
The vm_availability_zone cannot be updated.
vm_availability_zone cannot be written.
VM comment.
Type
String.
Search
The field is not available for search.
Notes
The vm_comment cannot be updated.
vm_comment cannot be written.
Date/time the VM was first created as NIOS object.
Type
Timestamp.
Search
The field is not available for search.
Notes
The vm_creation_time cannot be updated.
vm_creation_time cannot be written.
Host part of the FQDN of the address attached to the primary interface.
Type
String.
Search
The field is not available for search.
Notes
The vm_hostname cannot be updated.
vm_hostname cannot be written.
The UUID of the Virtual Machine.
Type
String.
Search
The field is available for search via
Notes
The vm_id cannot be updated.
vm_id cannot be written.
Kernel ID of the VM that this address is associated with.
Type
String.
Search
The field is not available for search.
Notes
The vm_kernel_id cannot be updated.
vm_kernel_id cannot be written.
Last time the VM was updated.
Type
Timestamp.
Search
The field is not available for search.
Notes
The vm_last_update_time cannot be updated.
vm_last_update_time cannot be written.
The name of the Virtual Machine.
Type
String.
Search
The field is available for search via
Notes
The vm_name is part of the base object.
The vm_name cannot be updated.
vm_name cannot be written.
Count of networks containing all the addresses of the VM.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The vm_network_count cannot be updated.
vm_network_count cannot be written.
Operating system that the VM is running.
Type
String.
Search
The field is not available for search.
Notes
The vm_operating_system cannot be updated.
vm_operating_system cannot be written.
Type of the VM this address is associated with.
Type
String.
Search
The field is not available for search.
Notes
The vm_type cannot be updated.
vm_type cannot be written.
Network address of the VPC of the VM that this address is associated with.
Type
String.
Search
The field is not available for search.
Notes
The vm_vpc_address cannot be updated.
vm_vpc_address cannot be written.
CIDR of the VPC of the VM that this address is associated with.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The vm_vpc_cidr cannot be updated.
vm_vpc_cidr cannot be written.
Identifier of the VPC where the VM is defined.
Type
String.
Search
The field is not available for search.
Notes
The vm_vpc_id cannot be updated.
vm_vpc_id cannot be written.
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | N | Y | Y | = ~ |
| address_type | String | N | Y | N | N/A |
| associated_ip | String | N | Y | N | N/A |
| associated_object_types | [String] | N | Y | N | N/A |
| associated_objects | obj | N | Y | N | N/A |
| cloud_info | struct | N | Y | N | N/A |
| dns_names | [String] | N | Y | N | N/A |
| elastic_address | String | N | Y | N | N/A |
| interface_name | String | N | Y | N | N/A |
| is_ipv4 | Bool | N | Y | Y | N/A |
| mac_address | String | N | Y | N | = ~ |
| ms_ad_user_data | struct | N | Y | N | N/A |
| network | String | N | Y | N | N/A |
| network_view | String | N | Y | Y | N/A |
| port_id | Unsigned int | N | Y | Y | N/A |
| private_address | String | N | Y | N | N/A |
| private_hostname | String | N | Y | N | N/A |
| public_address | String | N | Y | N | N/A |
| public_hostname | String | N | Y | N | N/A |
| 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 | String | N | Y | N | N/A |
| vm_availability_zone | String | N | Y | N | N/A |
| vm_comment | String | N | Y | N | N/A |
| vm_creation_time | Timestamp | N | Y | N | N/A |
| vm_hostname | String | N | Y | N | N/A |
| vm_id | String | N | Y | N | = ~ |
| vm_kernel_id | String | N | Y | N | N/A |
| vm_last_update_time | Timestamp | N | Y | N | N/A |
| vm_name | String | N | Y | Y | = ~ |
| vm_network_count | Unsigned int | N | Y | N | N/A |
| vm_operating_system | String | N | Y | N | N/A |
| vm_type | String | N | Y | N | N/A |
| vm_vpc_address | String | N | Y | N | N/A |
| vm_vpc_cidr | Unsigned int | N | Y | N | N/A |
| vm_vpc_id | String | N | Y | N | N/A |
| vm_vpc_name | String | N | Y | N | N/A |
| vm_vpc_ref | String | N | Y | N | N/A |
| Field | Type | Search |
|---|---|---|
| tenant_name | String | = ~ |
grid:cloudapi:vm : Grid Cloud API vm object.
