VmCluster¶

class oci.database.models.VmCluster(**kwargs)¶

Bases: object

Details of the VM cluster resource. Applies to Exadata Cloud@Customer instances only.

Attributes

`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a VmCluster.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a VmCluster.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a VmCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VmCluster.
`availability_domain`	Gets the availability_domain of this VmCluster.
`cloud_automation_update_details`	Gets the cloud_automation_update_details of this VmCluster.
`compartment_id`	Gets the compartment_id of this VmCluster.
`cpus_enabled`	Gets the cpus_enabled of this VmCluster.
`data_collection_options`	Gets the data_collection_options of this VmCluster.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this VmCluster.
`data_storage_size_in_tbs`	Gets the data_storage_size_in_tbs of this VmCluster.
`db_node_storage_size_in_gbs`	Gets the db_node_storage_size_in_gbs of this VmCluster.
`db_servers`	Gets the db_servers of this VmCluster.
`defined_tags`	Gets the defined_tags of this VmCluster.
`display_name`	Gets the display_name of this VmCluster.
`exadata_infrastructure_id`	Gets the exadata_infrastructure_id of this VmCluster.
`file_system_configuration_details`	Gets the file_system_configuration_details of this VmCluster.
`freeform_tags`	Gets the freeform_tags of this VmCluster.
`gi_software_image_id`	Gets the gi_software_image_id of this VmCluster.
`gi_version`	Gets the gi_version of this VmCluster.
`id`	Gets the id of this VmCluster.
`is_local_backup_enabled`	Gets the is_local_backup_enabled of this VmCluster.
`is_sparse_diskgroup_enabled`	Gets the is_sparse_diskgroup_enabled of this VmCluster.
`last_patch_history_entry_id`	Gets the last_patch_history_entry_id of this VmCluster.
`license_model`	Gets the license_model of this VmCluster.
`lifecycle_details`	Gets the lifecycle_details of this VmCluster.
`lifecycle_state`	Gets the lifecycle_state of this VmCluster.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this VmCluster.
`ocpus_enabled`	Gets the ocpus_enabled of this VmCluster.
`shape`	Gets the shape of this VmCluster.
`ssh_public_keys`	Gets the ssh_public_keys of this VmCluster.
`system_version`	Gets the system_version of this VmCluster.
`time_created`	Gets the time_created of this VmCluster.
`time_zone`	Gets the time_zone of this VmCluster.
`vm_cluster_network_id`	Gets the vm_cluster_network_id of this VmCluster.

Methods

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

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'¶: A constant which can be used with the license_model property of a VmCluster. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'¶: A constant which can be used with the license_model property of a VmCluster. This constant has a value of “LICENSE_INCLUDED”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS = 'MAINTENANCE_IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “MAINTENANCE_IN_PROGRESS”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a VmCluster. This constant has a value of “TERMINATING”

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

__init__(**kwargs)¶

Initializes a new VmCluster 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 VmCluster.
compartment_id (str) – The value to assign to the compartment_id property of this VmCluster.
last_patch_history_entry_id (str) – The value to assign to the last_patch_history_entry_id property of this VmCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VmCluster. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this VmCluster.
time_created (datetime) – The value to assign to the time_created property of this VmCluster.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VmCluster.
time_zone (str) – The value to assign to the time_zone property of this VmCluster.
is_local_backup_enabled (bool) – The value to assign to the is_local_backup_enabled property of this VmCluster.
exadata_infrastructure_id (str) – The value to assign to the exadata_infrastructure_id property of this VmCluster.
is_sparse_diskgroup_enabled (bool) – The value to assign to the is_sparse_diskgroup_enabled property of this VmCluster.
vm_cluster_network_id (str) – The value to assign to the vm_cluster_network_id property of this VmCluster.
cpus_enabled (int) – The value to assign to the cpus_enabled property of this VmCluster.
ocpus_enabled (float) – The value to assign to the ocpus_enabled property of this VmCluster.
memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this VmCluster.
db_node_storage_size_in_gbs (int) – The value to assign to the db_node_storage_size_in_gbs property of this VmCluster.
data_storage_size_in_tbs (float) – The value to assign to the data_storage_size_in_tbs property of this VmCluster.
data_storage_size_in_gbs (float) – The value to assign to the data_storage_size_in_gbs property of this VmCluster.
shape (str) – The value to assign to the shape property of this VmCluster.
gi_version (str) – The value to assign to the gi_version property of this VmCluster.
system_version (str) – The value to assign to the system_version property of this VmCluster.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this VmCluster.
license_model (str) – The value to assign to the license_model property of this VmCluster. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_servers (list[str]) – The value to assign to the db_servers property of this VmCluster.
availability_domain (str) – The value to assign to the availability_domain property of this VmCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VmCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VmCluster.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this VmCluster.
gi_software_image_id (str) – The value to assign to the gi_software_image_id property of this VmCluster.
file_system_configuration_details (list[oci.database.models.FileSystemConfigurationDetail]) – The value to assign to the file_system_configuration_details property of this VmCluster.
cloud_automation_update_details (oci.database.models.CloudAutomationUpdateDetails) – The value to assign to the cloud_automation_update_details property of this VmCluster.

availability_domain¶

Gets the availability_domain of this VmCluster. The name of the availability domain that the VM cluster is located in.

Returns:	The availability_domain of this VmCluster.
Return type:	str

cloud_automation_update_details¶

Gets the cloud_automation_update_details of this VmCluster.

Returns:	The cloud_automation_update_details of this VmCluster.
Return type:	oci.database.models.CloudAutomationUpdateDetails

compartment_id¶

Gets the compartment_id of this VmCluster. The OCID of the compartment.

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

cpus_enabled¶

Gets the cpus_enabled of this VmCluster. The number of enabled CPU cores.

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

data_collection_options¶

Gets the data_collection_options of this VmCluster.

Returns:	The data_collection_options of this VmCluster.
Return type:	oci.database.models.DataCollectionOptions

data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this VmCluster. Size of the DATA disk group in GBs.

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

data_storage_size_in_tbs¶

Gets the data_storage_size_in_tbs of this VmCluster. Size, in terabytes, of the DATA disk group.

Returns:	The data_storage_size_in_tbs of this VmCluster.
Return type:	float

db_node_storage_size_in_gbs¶

Gets the db_node_storage_size_in_gbs of this VmCluster. The local node storage allocated in GBs.

Returns:	The db_node_storage_size_in_gbs of this VmCluster.
Return type:	int

db_servers¶

Gets the db_servers of this VmCluster. The list of Db server.

Returns:	The db_servers of this VmCluster.
Return type:	list[str]

defined_tags¶

Gets the defined_tags of this VmCluster. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

display_name¶

Gets the display_name of this VmCluster. The user-friendly name for the Exadata Cloud@Customer VM cluster. The name does not need to be unique.

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

exadata_infrastructure_id¶

Gets the exadata_infrastructure_id of this VmCluster. The OCID of the Exadata infrastructure.

Returns:	The exadata_infrastructure_id of this VmCluster.
Return type:	str

file_system_configuration_details¶

Gets the file_system_configuration_details of this VmCluster. Details of the file system configuration of the VM cluster.

Returns:	The file_system_configuration_details of this VmCluster.
Return type:	list[oci.database.models.FileSystemConfigurationDetail]

freeform_tags¶

Gets the freeform_tags of this VmCluster. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

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

gi_software_image_id¶

Gets the gi_software_image_id of this VmCluster. The OCID of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE.

Returns:	The gi_software_image_id of this VmCluster.
Return type:	str

gi_version¶

Gets the gi_version of this VmCluster. The Oracle Grid Infrastructure software version for the VM cluster.

Returns:	The gi_version of this VmCluster.
Return type:	str

id¶

Gets the id of this VmCluster. The OCID of the VM cluster.

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

is_local_backup_enabled¶

Gets the is_local_backup_enabled of this VmCluster. If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster.

Returns:	The is_local_backup_enabled of this VmCluster.
Return type:	bool

is_sparse_diskgroup_enabled¶

Gets the is_sparse_diskgroup_enabled of this VmCluster. If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created.

Returns:	The is_sparse_diskgroup_enabled of this VmCluster.
Return type:	bool

last_patch_history_entry_id¶

Gets the last_patch_history_entry_id of this VmCluster. The OCID of the last patch history. This value is updated as soon as a patch operation starts.

Returns:	The last_patch_history_entry_id of this VmCluster.
Return type:	str

license_model¶

Gets the license_model of this VmCluster. The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The license_model of this VmCluster.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this VmCluster. Additional information about the current lifecycle state.

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

lifecycle_state¶

Gets the lifecycle_state of this VmCluster. The current state of the VM cluster.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MAINTENANCE_IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

memory_size_in_gbs¶

Gets the memory_size_in_gbs of this VmCluster. The memory allocated in GBs.

Returns:	The memory_size_in_gbs of this VmCluster.
Return type:	int

ocpus_enabled¶

Gets the ocpus_enabled of this VmCluster. The number of enabled OCPU cores.

Returns:	The ocpus_enabled of this VmCluster.
Return type:	float

shape¶

Gets the shape of this VmCluster. The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.

Returns:	The shape of this VmCluster.
Return type:	str

ssh_public_keys¶

Gets the ssh_public_keys of this VmCluster. The public key portion of one or more key pairs used for SSH access to the VM cluster.

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

system_version¶

Gets the system_version of this VmCluster. Operating system version of the image.

Returns:	The system_version of this VmCluster.
Return type:	str

time_created¶

Gets the time_created of this VmCluster. The date and time that the VM cluster was created.

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

time_zone¶

Gets the time_zone of this VmCluster. The time zone of the Exadata infrastructure. For details, see Exadata Infrastructure Time Zones.

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

vm_cluster_network_id¶

Gets the vm_cluster_network_id of this VmCluster. The OCID of the VM cluster network.

Returns:	The vm_cluster_network_id of this VmCluster.
Return type:	str