VmCluster¶
- class oci.database.models.VmCluster(**kwargs)¶
Bases:
objectDetails of the VM cluster resource. Applies to Exadata Cloud@Customer instances only.
Attributes:
A constant which can be used with the compute_model property of a VmCluster.
A constant which can be used with the compute_model property of a VmCluster.
A constant which can be used with the license_model property of a VmCluster.
A constant which can be used with the license_model property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the lifecycle_state property of a VmCluster.
A constant which can be used with the storage_management_type property of a VmCluster.
A constant which can be used with the storage_management_type property of a VmCluster.
A constant which can be used with the vm_backup_storage_type property of a VmCluster.
A constant which can be used with the vm_backup_storage_type property of a VmCluster.
A constant which can be used with the vm_cluster_type property of a VmCluster.
A constant which can be used with the vm_cluster_type property of a VmCluster.
A constant which can be used with the vm_file_system_storage_type property of a VmCluster.
A constant which can be used with the vm_file_system_storage_type property of a VmCluster.
Gets the availability_domain of this VmCluster.
Gets the cloud_automation_update_details of this VmCluster.
Gets the compartment_id of this VmCluster.
Gets the compute_model of this VmCluster.
Gets the cpus_enabled of this VmCluster.
Gets the data_collection_options of this VmCluster.
Gets the data_storage_percentage of this VmCluster.
Gets the data_storage_size_in_gbs of this VmCluster.
Gets the data_storage_size_in_tbs of this VmCluster.
Gets the db_node_storage_size_in_gbs of this VmCluster.
Gets the db_servers of this VmCluster.
Gets the defined_tags of this VmCluster.
Gets the display_name of this VmCluster.
Gets the exadata_infrastructure_id of this VmCluster.
Gets the exascale_db_storage_vault_id of this VmCluster.
Gets the file_system_configuration_details of this VmCluster.
Gets the freeform_tags of this VmCluster.
Gets the gi_software_image_id of this VmCluster.
Gets the gi_version of this VmCluster.
Gets the id of this VmCluster.
Gets the is_local_backup_enabled of this VmCluster.
Gets the is_sparse_diskgroup_enabled of this VmCluster.
Gets the last_patch_history_entry_id of this VmCluster.
Gets the license_model of this VmCluster.
Gets the lifecycle_details of this VmCluster.
Gets the lifecycle_state of this VmCluster.
Gets the live_image_version_details of this VmCluster.
Gets the memory_size_in_gbs of this VmCluster.
Gets the ocpus_enabled of this VmCluster.
Gets the oracle_linux_version of this VmCluster.
Gets the reco_storage_percentage of this VmCluster.
Gets the shape of this VmCluster.
Gets the sparse_storage_percentage of this VmCluster.
Gets the ssh_public_keys of this VmCluster.
Gets the storage_management_type of this VmCluster.
Gets the system_tags of this VmCluster.
Gets the system_version of this VmCluster.
Gets the time_created of this VmCluster.
Gets the time_zone of this VmCluster.
Gets the vm_backup_storage_type of this VmCluster.
Gets the vm_cluster_network_id of this VmCluster.
Gets the vm_cluster_type of this VmCluster.
Gets the vm_file_system_storage_type of this VmCluster.
Methods:
__init__(**kwargs)Initializes a new VmCluster object with values from keyword arguments.
- COMPUTE_MODEL_ECPU = 'ECPU'¶
A constant which can be used with the compute_model property of a VmCluster. This constant has a value of “ECPU”
- COMPUTE_MODEL_OCPU = 'OCPU'¶
A constant which can be used with the compute_model property of a VmCluster. This constant has a value of “OCPU”
- 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”
- STORAGE_MANAGEMENT_TYPE_ASM = 'ASM'¶
A constant which can be used with the storage_management_type property of a VmCluster. This constant has a value of “ASM”
- STORAGE_MANAGEMENT_TYPE_EXASCALE = 'EXASCALE'¶
A constant which can be used with the storage_management_type property of a VmCluster. This constant has a value of “EXASCALE”
- VM_BACKUP_STORAGE_TYPE_EXASCALE = 'EXASCALE'¶
A constant which can be used with the vm_backup_storage_type property of a VmCluster. This constant has a value of “EXASCALE”
- VM_BACKUP_STORAGE_TYPE_LOCAL = 'LOCAL'¶
A constant which can be used with the vm_backup_storage_type property of a VmCluster. This constant has a value of “LOCAL”
- VM_CLUSTER_TYPE_DEVELOPER = 'DEVELOPER'¶
A constant which can be used with the vm_cluster_type property of a VmCluster. This constant has a value of “DEVELOPER”
- VM_CLUSTER_TYPE_REGULAR = 'REGULAR'¶
A constant which can be used with the vm_cluster_type property of a VmCluster. This constant has a value of “REGULAR”
- VM_FILE_SYSTEM_STORAGE_TYPE_EXASCALE = 'EXASCALE'¶
A constant which can be used with the vm_file_system_storage_type property of a VmCluster. This constant has a value of “EXASCALE”
- VM_FILE_SYSTEM_STORAGE_TYPE_LOCAL = 'LOCAL'¶
A constant which can be used with the vm_file_system_storage_type property of a VmCluster. This constant has a value of “LOCAL”
- __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.
data_storage_percentage (int) – The value to assign to the data_storage_percentage property of this VmCluster.
reco_storage_percentage (int) – The value to assign to the reco_storage_percentage property of this VmCluster.
sparse_storage_percentage (int) – The value to assign to the sparse_storage_percentage property of this VmCluster.
live_image_version_details (oci.database.models.ExadataLiveImageVersionDetails) – The value to assign to the live_image_version_details property of this VmCluster.
oracle_linux_version (str) – The value to assign to the oracle_linux_version 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.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_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.
vm_cluster_type (str) – The value to assign to the vm_cluster_type property of this VmCluster. Allowed values for this property are: “REGULAR”, “DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
cloud_automation_update_details (oci.database.models.CloudAutomationUpdateDetails) – The value to assign to the cloud_automation_update_details property of this VmCluster.
exascale_db_storage_vault_id (str) – The value to assign to the exascale_db_storage_vault_id property of this VmCluster.
storage_management_type (str) – The value to assign to the storage_management_type property of this VmCluster. Allowed values for this property are: “ASM”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compute_model (str) – The value to assign to the compute_model property of this VmCluster. Allowed values for this property are: “ECPU”, “OCPU”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
vm_file_system_storage_type (str) – The value to assign to the vm_file_system_storage_type property of this VmCluster. Allowed values for this property are: “LOCAL”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
vm_backup_storage_type (str) – The value to assign to the vm_backup_storage_type property of this VmCluster. Allowed values for this property are: “LOCAL”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property 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
- property cloud_automation_update_details¶
Gets the cloud_automation_update_details of this VmCluster.
- Returns
The cloud_automation_update_details of this VmCluster.
- Return type
- property compartment_id¶
Gets the compartment_id of this VmCluster. The OCID of the compartment.
- Returns
The compartment_id of this VmCluster.
- Return type
str
- property compute_model¶
Gets the compute_model of this VmCluster. The compute model of the Autonomous AI Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
Allowed values for this property are: “ECPU”, “OCPU”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The compute_model of this VmCluster.
- Return type
str
- property 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
- property data_collection_options¶
Gets the data_collection_options of this VmCluster.
- Returns
The data_collection_options of this VmCluster.
- Return type
- property data_storage_percentage¶
Gets the data_storage_percentage of this VmCluster. The percentage assigned to DATA storage (user data and database files). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.
- Returns
The data_storage_percentage of this VmCluster.
- Return type
int
- property 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
- property 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
- property 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
- property 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]
- property 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))
- property 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
- property 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
- property exascale_db_storage_vault_id¶
Gets the exascale_db_storage_vault_id of this VmCluster. The OCID of the Exadata Database Storage Vault.
- Returns
The exascale_db_storage_vault_id of this VmCluster.
- Return type
str
- property 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
- property 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)
- property 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
- property 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
- property id¶
Gets the id of this VmCluster. The OCID of the VM cluster.
- Returns
The id of this VmCluster.
- Return type
str
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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
- property live_image_version_details¶
Gets the live_image_version_details of this VmCluster.
- Returns
The live_image_version_details of this VmCluster.
- Return type
- property 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
- property 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
- property oracle_linux_version¶
Gets the oracle_linux_version of this VmCluster. Oracle Linux version for the respective Exadata Image.
- Returns
The oracle_linux_version of this VmCluster.
- Return type
str
- property reco_storage_percentage¶
Gets the reco_storage_percentage of this VmCluster. The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.
- Returns
The reco_storage_percentage of this VmCluster.
- Return type
int
- property 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
- property sparse_storage_percentage¶
Gets the sparse_storage_percentage of this VmCluster. The percentage assigned to SPARSE storage (Exadata snapshots). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.
- Returns
The sparse_storage_percentage of this VmCluster.
- Return type
int
- property 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]
- property storage_management_type¶
Gets the storage_management_type of this VmCluster. Specifies whether the type of storage management for the VM cluster is ASM or Exascale.
Allowed values for this property are: “ASM”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The storage_management_type of this VmCluster.
- Return type
str
- property system_tags¶
Gets the system_tags of this VmCluster. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Returns
The system_tags of this VmCluster.
- Return type
dict(str, dict(str, object))
- property 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
- property 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
- property 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
- property vm_backup_storage_type¶
Gets the vm_backup_storage_type of this VmCluster. Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL.
Allowed values for this property are: “LOCAL”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The vm_backup_storage_type of this VmCluster.
- Return type
str
- property 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
- property vm_cluster_type¶
Gets the vm_cluster_type of this VmCluster. The vmcluster type for the VM cluster/Cloud VM cluster.
Allowed values for this property are: “REGULAR”, “DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The vm_cluster_type of this VmCluster.
- Return type
str
- property vm_file_system_storage_type¶
Gets the vm_file_system_storage_type of this VmCluster. Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL
Allowed values for this property are: “LOCAL”, “EXASCALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The vm_file_system_storage_type of this VmCluster.
- Return type
str