CloudVmCluster

class oci.database.models.CloudVmCluster(**kwargs)

Bases: object

Details of the cloud VM cluster.

Attributes

DISK_REDUNDANCY_HIGH A constant which can be used with the disk_redundancy property of a CloudVmCluster.
DISK_REDUNDANCY_NORMAL A constant which can be used with the disk_redundancy property of a CloudVmCluster.
LICENSE_MODEL_BRING_YOUR_OWN_LICENSE A constant which can be used with the license_model property of a CloudVmCluster.
LICENSE_MODEL_LICENSE_INCLUDED A constant which can be used with the license_model property of a CloudVmCluster.
LIFECYCLE_STATE_AVAILABLE A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_PROVISIONING A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_TERMINATED A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_TERMINATING A constant which can be used with the lifecycle_state property of a CloudVmCluster.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a CloudVmCluster.
availability_domain [Required] Gets the availability_domain of this CloudVmCluster.
backup_network_nsg_ids Gets the backup_network_nsg_ids of this CloudVmCluster.
backup_subnet_id Gets the backup_subnet_id of this CloudVmCluster.
cloud_exadata_infrastructure_id [Required] Gets the cloud_exadata_infrastructure_id of this CloudVmCluster.
cluster_name Gets the cluster_name of this CloudVmCluster.
compartment_id [Required] Gets the compartment_id of this CloudVmCluster.
cpu_core_count [Required] Gets the cpu_core_count of this CloudVmCluster.
data_storage_percentage Gets the data_storage_percentage of this CloudVmCluster.
defined_tags Gets the defined_tags of this CloudVmCluster.
disk_redundancy Gets the disk_redundancy of this CloudVmCluster.
display_name [Required] Gets the display_name of this CloudVmCluster.
domain [Required] Gets the domain of this CloudVmCluster.
freeform_tags Gets the freeform_tags of this CloudVmCluster.
gi_version Gets the gi_version of this CloudVmCluster.
hostname [Required] Gets the hostname of this CloudVmCluster.
id [Required] Gets the id of this CloudVmCluster.
iorm_config_cache Gets the iorm_config_cache of this CloudVmCluster.
is_local_backup_enabled Gets the is_local_backup_enabled of this CloudVmCluster.
is_sparse_diskgroup_enabled Gets the is_sparse_diskgroup_enabled of this CloudVmCluster.
last_update_history_entry_id Gets the last_update_history_entry_id of this CloudVmCluster.
license_model Gets the license_model of this CloudVmCluster.
lifecycle_details Gets the lifecycle_details of this CloudVmCluster.
lifecycle_state [Required] Gets the lifecycle_state of this CloudVmCluster.
listener_port Gets the listener_port of this CloudVmCluster.
node_count Gets the node_count of this CloudVmCluster.
nsg_ids Gets the nsg_ids of this CloudVmCluster.
scan_dns_record_id Gets the scan_dns_record_id of this CloudVmCluster.
scan_ip_ids Gets the scan_ip_ids of this CloudVmCluster.
shape [Required] Gets the shape of this CloudVmCluster.
ssh_public_keys [Required] Gets the ssh_public_keys of this CloudVmCluster.
storage_size_in_gbs Gets the storage_size_in_gbs of this CloudVmCluster.
subnet_id [Required] Gets the subnet_id of this CloudVmCluster.
system_version Gets the system_version of this CloudVmCluster.
time_created Gets the time_created of this CloudVmCluster.
time_zone Gets the time_zone of this CloudVmCluster.
vip_ids Gets the vip_ids of this CloudVmCluster.

Methods

__init__(**kwargs) Initializes a new CloudVmCluster object with values from keyword arguments.
DISK_REDUNDANCY_HIGH = 'HIGH'

A constant which can be used with the disk_redundancy property of a CloudVmCluster. This constant has a value of “HIGH”

DISK_REDUNDANCY_NORMAL = 'NORMAL'

A constant which can be used with the disk_redundancy property of a CloudVmCluster. This constant has a value of “NORMAL”

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

A constant which can be used with the license_model property of a CloudVmCluster. 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 CloudVmCluster. 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 CloudVmCluster. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a CloudVmCluster. 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 CloudVmCluster. 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 CloudVmCluster. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a CloudVmCluster. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a CloudVmCluster. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a CloudVmCluster. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • iorm_config_cache (ExadataIormConfig) – The value to assign to the iorm_config_cache property of this CloudVmCluster.
  • id (str) – The value to assign to the id property of this CloudVmCluster.
  • compartment_id (str) – The value to assign to the compartment_id property of this CloudVmCluster.
  • availability_domain (str) – The value to assign to the availability_domain property of this CloudVmCluster.
  • subnet_id (str) – The value to assign to the subnet_id property of this CloudVmCluster.
  • backup_subnet_id (str) – The value to assign to the backup_subnet_id property of this CloudVmCluster.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CloudVmCluster.
  • backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this CloudVmCluster.
  • last_update_history_entry_id (str) – The value to assign to the last_update_history_entry_id property of this CloudVmCluster.
  • shape (str) – The value to assign to the shape property of this CloudVmCluster.
  • listener_port (int) – The value to assign to the listener_port property of this CloudVmCluster.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudVmCluster. 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’.
  • node_count (int) – The value to assign to the node_count property of this CloudVmCluster.
  • storage_size_in_gbs (int) – The value to assign to the storage_size_in_gbs property of this CloudVmCluster.
  • display_name (str) – The value to assign to the display_name property of this CloudVmCluster.
  • time_created (datetime) – The value to assign to the time_created property of this CloudVmCluster.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this CloudVmCluster.
  • time_zone (str) – The value to assign to the time_zone property of this CloudVmCluster.
  • hostname (str) – The value to assign to the hostname property of this CloudVmCluster.
  • domain (str) – The value to assign to the domain property of this CloudVmCluster.
  • cpu_core_count (int) – The value to assign to the cpu_core_count property of this CloudVmCluster.
  • cluster_name (str) – The value to assign to the cluster_name property of this CloudVmCluster.
  • data_storage_percentage (int) – The value to assign to the data_storage_percentage property of this CloudVmCluster.
  • is_local_backup_enabled (bool) – The value to assign to the is_local_backup_enabled property of this CloudVmCluster.
  • cloud_exadata_infrastructure_id (str) – The value to assign to the cloud_exadata_infrastructure_id property of this CloudVmCluster.
  • is_sparse_diskgroup_enabled (bool) – The value to assign to the is_sparse_diskgroup_enabled property of this CloudVmCluster.
  • gi_version (str) – The value to assign to the gi_version property of this CloudVmCluster.
  • system_version (str) – The value to assign to the system_version property of this CloudVmCluster.
  • ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this CloudVmCluster.
  • license_model (str) – The value to assign to the license_model property of this CloudVmCluster. 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’.
  • disk_redundancy (str) – The value to assign to the disk_redundancy property of this CloudVmCluster. Allowed values for this property are: “HIGH”, “NORMAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • scan_ip_ids (list[str]) – The value to assign to the scan_ip_ids property of this CloudVmCluster.
  • vip_ids (list[str]) – The value to assign to the vip_ids property of this CloudVmCluster.
  • scan_dns_record_id (str) – The value to assign to the scan_dns_record_id property of this CloudVmCluster.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudVmCluster.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudVmCluster.
availability_domain

[Required] Gets the availability_domain of this CloudVmCluster. The name of the availability domain that the cloud Exadata infrastructure resource is located in.

Returns:The availability_domain of this CloudVmCluster.
Return type:str
backup_network_nsg_ids

Gets the backup_network_nsg_ids of this CloudVmCluster. A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Returns:The backup_network_nsg_ids of this CloudVmCluster.
Return type:list[str]
backup_subnet_id

Gets the backup_subnet_id of this CloudVmCluster. The OCID of the backup network subnet associated with the cloud VM cluster.

Subnet Restriction: See the subnet restrictions information for subnetId.

Returns:The backup_subnet_id of this CloudVmCluster.
Return type:str
cloud_exadata_infrastructure_id

[Required] Gets the cloud_exadata_infrastructure_id of this CloudVmCluster. The OCID of the cloud Exadata infrastructure.

Returns:The cloud_exadata_infrastructure_id of this CloudVmCluster.
Return type:str
cluster_name

Gets the cluster_name of this CloudVmCluster. The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Returns:The cluster_name of this CloudVmCluster.
Return type:str
compartment_id

[Required] Gets the compartment_id of this CloudVmCluster. The OCID of the compartment.

Returns:The compartment_id of this CloudVmCluster.
Return type:str
cpu_core_count

[Required] Gets the cpu_core_count of this CloudVmCluster. The number of CPU cores enabled on the cloud VM cluster.

Returns:The cpu_core_count of this CloudVmCluster.
Return type:int
data_storage_percentage

Gets the data_storage_percentage of this CloudVmCluster. The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. 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 CloudVmCluster.
Return type:int
defined_tags

Gets the defined_tags of this CloudVmCluster. 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 CloudVmCluster.
Return type:dict(str, dict(str, object))
disk_redundancy

Gets the disk_redundancy of this CloudVmCluster. The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

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

Returns:The disk_redundancy of this CloudVmCluster.
Return type:str
display_name

[Required] Gets the display_name of this CloudVmCluster. The user-friendly name for the cloud VM cluster. The name does not need to be unique.

Returns:The display_name of this CloudVmCluster.
Return type:str
domain

[Required] Gets the domain of this CloudVmCluster. The domain name for the cloud VM cluster.

Returns:The domain of this CloudVmCluster.
Return type:str
freeform_tags

Gets the freeform_tags of this CloudVmCluster. 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 CloudVmCluster.
Return type:dict(str, str)
gi_version

Gets the gi_version of this CloudVmCluster. A valid Oracle Grid Infrastructure (GI) software version.

Returns:The gi_version of this CloudVmCluster.
Return type:str
hostname

[Required] Gets the hostname of this CloudVmCluster. The hostname for the cloud VM cluster.

Returns:The hostname of this CloudVmCluster.
Return type:str
id

[Required] Gets the id of this CloudVmCluster. The OCID of the cloud VM cluster.

Returns:The id of this CloudVmCluster.
Return type:str
iorm_config_cache

Gets the iorm_config_cache of this CloudVmCluster.

Returns:The iorm_config_cache of this CloudVmCluster.
Return type:ExadataIormConfig
is_local_backup_enabled

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

Returns:The is_local_backup_enabled of this CloudVmCluster.
Return type:bool
is_sparse_diskgroup_enabled

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

Returns:The is_sparse_diskgroup_enabled of this CloudVmCluster.
Return type:bool
last_update_history_entry_id

Gets the last_update_history_entry_id of this CloudVmCluster. The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

Returns:The last_update_history_entry_id of this CloudVmCluster.
Return type:str
license_model

Gets the license_model of this CloudVmCluster. The Oracle license model that applies to the cloud 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 CloudVmCluster.
Return type:str
lifecycle_details

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

Returns:The lifecycle_details of this CloudVmCluster.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this CloudVmCluster. The current state of the cloud 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 CloudVmCluster.
Return type:str
listener_port

Gets the listener_port of this CloudVmCluster. The port number configured for the listener on the cloud VM cluster.

Returns:The listener_port of this CloudVmCluster.
Return type:int
node_count

Gets the node_count of this CloudVmCluster. The number of nodes in the cloud VM cluster.

Returns:The node_count of this CloudVmCluster.
Return type:int
nsg_ids

Gets the nsg_ids of this CloudVmCluster. A list of the OCIDs of the network security groups (NSGs) that this resource belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.

Returns:The nsg_ids of this CloudVmCluster.
Return type:list[str]
scan_dns_record_id

Gets the scan_dns_record_id of this CloudVmCluster. The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

Returns:The scan_dns_record_id of this CloudVmCluster.
Return type:str
scan_ip_ids

Gets the scan_ip_ids of this CloudVmCluster. The OCID of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

Note: For a single-node DB system, this list is empty.

Returns:The scan_ip_ids of this CloudVmCluster.
Return type:list[str]
shape

[Required] Gets the shape of this CloudVmCluster. The model name of the Exadata hardware running the cloud VM cluster.

Returns:The shape of this CloudVmCluster.
Return type:str
ssh_public_keys

[Required] Gets the ssh_public_keys of this CloudVmCluster. The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

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

Gets the storage_size_in_gbs of this CloudVmCluster. The storage allocation for the disk group, in gigabytes (GB).

Returns:The storage_size_in_gbs of this CloudVmCluster.
Return type:int
subnet_id

[Required] Gets the subnet_id of this CloudVmCluster. The OCID of the subnet associated with the cloud VM cluster.

Subnet Restrictions: - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Returns:The subnet_id of this CloudVmCluster.
Return type:str
system_version

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

Returns:The system_version of this CloudVmCluster.
Return type:str
time_created

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

Returns:The time_created of this CloudVmCluster.
Return type:datetime
time_zone

Gets the time_zone of this CloudVmCluster. The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

Returns:The time_zone of this CloudVmCluster.
Return type:str
vip_ids

Gets the vip_ids of this CloudVmCluster. The OCID of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

Note: For a single-node DB system, this list is empty.

Returns:The vip_ids of this CloudVmCluster.
Return type:list[str]