VmInstance¶

class oci.datacc.models.VmInstance(**kwargs)¶

Bases: object

VM instance details.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VmInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VmInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VmInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VmInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a VmInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VmInstance.
`boot_storage_size_in_gbs`	Gets the boot_storage_size_in_gbs of this VmInstance.
`compartment_id`	[Required] Gets the compartment_id of this VmInstance.
`cpus_enabled`	[Required] Gets the cpus_enabled of this VmInstance.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this VmInstance.
`defined_tags`	Gets the defined_tags of this VmInstance.
`description`	Gets the description of this VmInstance.
`display_name`	Gets the display_name of this VmInstance.
`dns_servers`	Gets the dns_servers of this VmInstance.
`domain_name`	Gets the domain_name of this VmInstance.
`freeform_tags`	Gets the freeform_tags of this VmInstance.
`gateway`	Gets the gateway of this VmInstance.
`hostname`	Gets the hostname of this VmInstance.
`id`	[Required] Gets the id of this VmInstance.
`image_id`	Gets the image_id of this VmInstance.
`infrastructure_id`	[Required] Gets the infrastructure_id of this VmInstance.
`ip_address`	Gets the ip_address of this VmInstance.
`lifecycle_details`	Gets the lifecycle_details of this VmInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VmInstance.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this VmInstance.
`metadata`	Gets the metadata of this VmInstance.
`netmask`	Gets the netmask of this VmInstance.
`ntp_servers`	Gets the ntp_servers of this VmInstance.
`server_id`	Gets the server_id of this VmInstance.
`ssh_public_keys`	[Required] Gets the ssh_public_keys of this VmInstance.
`system_tags`	Gets the system_tags of this VmInstance.
`time_created`	[Required] Gets the time_created of this VmInstance.
`time_updated`	[Required] Gets the time_updated of this VmInstance.
`time_zone`	[Required] Gets the time_zone of this VmInstance.
`userdata`	Gets the userdata of this VmInstance.
`vlan_id`	Gets the vlan_id of this VmInstance.
`vm_network_id`	Gets the vm_network_id of this VmInstance.

Methods

__init__(**kwargs) Initializes a new VmInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a VmInstance. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new VmInstance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this VmInstance.
compartment_id (str) – The value to assign to the compartment_id property of this VmInstance.
display_name (str) – The value to assign to the display_name property of this VmInstance.
description (str) – The value to assign to the description property of this VmInstance.
infrastructure_id (str) – The value to assign to the infrastructure_id property of this VmInstance.
cpus_enabled (int) – The value to assign to the cpus_enabled property of this VmInstance.
memory_size_in_gbs (float) – The value to assign to the memory_size_in_gbs property of this VmInstance.
boot_storage_size_in_gbs (float) – The value to assign to the boot_storage_size_in_gbs property of this VmInstance.
data_storage_size_in_gbs (float) – The value to assign to the data_storage_size_in_gbs property of this VmInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VmInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VmInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VmInstance.
image_id (str) – The value to assign to the image_id property of this VmInstance.
server_id (str) – The value to assign to the server_id property of this VmInstance.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this VmInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VmInstance. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VmInstance.
time_created (datetime) – The value to assign to the time_created property of this VmInstance.
time_updated (datetime) – The value to assign to the time_updated property of this VmInstance.
domain_name (str) – The value to assign to the domain_name property of this VmInstance.
time_zone (str) – The value to assign to the time_zone property of this VmInstance.
dns_servers (list[str]) – The value to assign to the dns_servers property of this VmInstance.
ntp_servers (list[str]) – The value to assign to the ntp_servers property of this VmInstance.
hostname (str) – The value to assign to the hostname property of this VmInstance.
ip_address (str) – The value to assign to the ip_address property of this VmInstance.
netmask (str) – The value to assign to the netmask property of this VmInstance.
gateway (str) – The value to assign to the gateway property of this VmInstance.
vlan_id (str) – The value to assign to the vlan_id property of this VmInstance.
userdata (str) – The value to assign to the userdata property of this VmInstance.
metadata (dict(str, str)) – The value to assign to the metadata property of this VmInstance.
vm_network_id (str) – The value to assign to the vm_network_id property of this VmInstance.

boot_storage_size_in_gbs¶

Gets the boot_storage_size_in_gbs of this VmInstance. Boot storage memory to be allocated in GBs.

Returns:	The boot_storage_size_in_gbs of this VmInstance.
Return type:	float

compartment_id¶

[Required] Gets the compartment_id of this VmInstance. The OCID of the compartment containing the VM instance.

Returns:	The compartment_id of this VmInstance.
Return type:	str

cpus_enabled¶

[Required] Gets the cpus_enabled of this VmInstance. The number of CPU cores enabled for each VM instance.

Returns:	The cpus_enabled of this VmInstance.
Return type:	int

data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this VmInstance. Data storage to be allocated in GBs.

Returns:	The data_storage_size_in_gbs of this VmInstance.
Return type:	float

defined_tags¶

Gets the defined_tags of this VmInstance. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this VmInstance.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this VmInstance. VM instance description.

Returns:	The description of this VmInstance.
Return type:	str

display_name¶

Gets the display_name of this VmInstance. VM instance display name. This name does not have to be unique, and is changeable.

Returns:	The display_name of this VmInstance.
Return type:	str

dns_servers¶

Gets the dns_servers of this VmInstance. The list of DNS server IP addresses. Maximum of 3 allowed.

Returns:	The dns_servers of this VmInstance.
Return type:	list[str]

domain_name¶

Gets the domain_name of this VmInstance. The domain name of the VM instance.

Returns:	The domain_name of this VmInstance.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this VmInstance. Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this VmInstance.
Return type:	dict(str, str)

gateway¶

Gets the gateway of this VmInstance. The gateway IP address of the VM instance network.

Returns:	The gateway of this VmInstance.
Return type:	str

hostname¶

Gets the hostname of this VmInstance. The host name of the instance.

Returns:	The hostname of this VmInstance.
Return type:	str

id¶

[Required] Gets the id of this VmInstance. The OCID of the VM instance.

Returns:	The id of this VmInstance.
Return type:	str

image_id¶

Gets the image_id of this VmInstance. The OCID of the VM custom instance uploaded.

Returns:	The image_id of this VmInstance.
Return type:	str

infrastructure_id¶

[Required] Gets the infrastructure_id of this VmInstance. The OCID of the Database Infrastructure.

Returns:	The infrastructure_id of this VmInstance.
Return type:	str

ip_address¶

Gets the ip_address of this VmInstance. The IP address of the instance.

Returns:	The ip_address of this VmInstance.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this VmInstance. Lifecycle state details of the VM instance.

Returns:	The lifecycle_details of this VmInstance.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this VmInstance. The current state of the VM instance.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this VmInstance.
Return type:	str

memory_size_in_gbs¶

Gets the memory_size_in_gbs of this VmInstance. The memory to be allocated in GBs.

Returns:	The memory_size_in_gbs of this VmInstance.
Return type:	float

metadata¶

Gets the metadata of this VmInstance. Custom metadata key/value pairs which can be used to: - Provide information to Cloud-Init to be used for various system initialization tasks. - Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration.

Returns:	The metadata of this VmInstance.
Return type:	dict(str, str)

netmask¶

Gets the netmask of this VmInstance. The netmask of the VM instance network.

Returns:	The netmask of this VmInstance.
Return type:	str

ntp_servers¶

Gets the ntp_servers of this VmInstance. The list of NTP server addresses. Maximum of 3 allowed.

Returns:	The ntp_servers of this VmInstance.
Return type:	list[str]

server_id¶

Gets the server_id of this VmInstance. The OCID of the compute node on which VM instance should be launched.

Returns:	The server_id of this VmInstance.
Return type:	str

ssh_public_keys¶

[Required] Gets the ssh_public_keys of this VmInstance. List of public key used for SSH access to the VM instance.

Returns:	The ssh_public_keys of this VmInstance.
Return type:	list[str]

system_tags¶

Gets the system_tags of this VmInstance. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

Returns:	The system_tags of this VmInstance.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this VmInstance. The time that the VM instance was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this VmInstance.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this VmInstance. The time that the VM instance was last updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this VmInstance.
Return type:	datetime

time_zone¶

[Required] Gets the time_zone of this VmInstance. The time zone to use for the VM instance.

Returns:	The time_zone of this VmInstance.
Return type:	str

userdata¶

Gets the userdata of this VmInstance. Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For information about how to take advantage of user data, see the Cloud-Init Documentation.

Returns:	The userdata of this VmInstance.
Return type:	str

vlan_id¶

Gets the vlan_id of this VmInstance. The network VLAN ID.

Returns:	The vlan_id of this VmInstance.
Return type:	str

vm_network_id¶

Gets the vm_network_id of this VmInstance. The OCID of the VM Network.

Returns:	The vm_network_id of this VmInstance.
Return type:	str