CreateCloudVmClusterDetails¶

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

Bases: object

Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only.

Attributes

`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a CreateCloudVmClusterDetails.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a CreateCloudVmClusterDetails.
`backup_network_nsg_ids`	Gets the backup_network_nsg_ids of this CreateCloudVmClusterDetails.
`backup_subnet_id`	[Required] Gets the backup_subnet_id of this CreateCloudVmClusterDetails.
`cloud_exadata_infrastructure_id`	[Required] Gets the cloud_exadata_infrastructure_id of this CreateCloudVmClusterDetails.
`cluster_name`	Gets the cluster_name of this CreateCloudVmClusterDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateCloudVmClusterDetails.
`cpu_core_count`	[Required] Gets the cpu_core_count of this CreateCloudVmClusterDetails.
`data_collection_options`	Gets the data_collection_options of this CreateCloudVmClusterDetails.
`data_storage_percentage`	Gets the data_storage_percentage of this CreateCloudVmClusterDetails.
`data_storage_size_in_tbs`	Gets the data_storage_size_in_tbs of this CreateCloudVmClusterDetails.
`db_node_storage_size_in_gbs`	Gets the db_node_storage_size_in_gbs of this CreateCloudVmClusterDetails.
`db_servers`	Gets the db_servers of this CreateCloudVmClusterDetails.
`defined_tags`	Gets the defined_tags of this CreateCloudVmClusterDetails.
`display_name`	[Required] Gets the display_name of this CreateCloudVmClusterDetails.
`domain`	Gets the domain of this CreateCloudVmClusterDetails.
`freeform_tags`	Gets the freeform_tags of this CreateCloudVmClusterDetails.
`gi_version`	[Required] Gets the gi_version of this CreateCloudVmClusterDetails.
`hostname`	[Required] Gets the hostname of this CreateCloudVmClusterDetails.
`is_local_backup_enabled`	Gets the is_local_backup_enabled of this CreateCloudVmClusterDetails.
`is_sparse_diskgroup_enabled`	Gets the is_sparse_diskgroup_enabled of this CreateCloudVmClusterDetails.
`license_model`	Gets the license_model of this CreateCloudVmClusterDetails.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this CreateCloudVmClusterDetails.
`nsg_ids`	Gets the nsg_ids of this CreateCloudVmClusterDetails.
`ocpu_count`	Gets the ocpu_count of this CreateCloudVmClusterDetails.
`private_zone_id`	Gets the private_zone_id of this CreateCloudVmClusterDetails.
`scan_listener_port_tcp`	Gets the scan_listener_port_tcp of this CreateCloudVmClusterDetails.
`scan_listener_port_tcp_ssl`	Gets the scan_listener_port_tcp_ssl of this CreateCloudVmClusterDetails.
`ssh_public_keys`	[Required] Gets the ssh_public_keys of this CreateCloudVmClusterDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateCloudVmClusterDetails.
`system_version`	Gets the system_version of this CreateCloudVmClusterDetails.
`time_zone`	Gets the time_zone of this CreateCloudVmClusterDetails.

Methods

__init__(**kwargs) Initializes a new CreateCloudVmClusterDetails 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 CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails. This constant has a value of “LICENSE_INCLUDED”

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateCloudVmClusterDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateCloudVmClusterDetails.
backup_subnet_id (str) – The value to assign to the backup_subnet_id property of this CreateCloudVmClusterDetails.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this CreateCloudVmClusterDetails.
ocpu_count (float) – The value to assign to the ocpu_count property of this CreateCloudVmClusterDetails.
memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this CreateCloudVmClusterDetails.
db_node_storage_size_in_gbs (int) – The value to assign to the db_node_storage_size_in_gbs property of this CreateCloudVmClusterDetails.
data_storage_size_in_tbs (float) – The value to assign to the data_storage_size_in_tbs property of this CreateCloudVmClusterDetails.
db_servers (list[str]) – The value to assign to the db_servers property of this CreateCloudVmClusterDetails.
cluster_name (str) – The value to assign to the cluster_name property of this CreateCloudVmClusterDetails.
data_storage_percentage (int) – The value to assign to the data_storage_percentage property of this CreateCloudVmClusterDetails.
display_name (str) – The value to assign to the display_name property of this CreateCloudVmClusterDetails.
cloud_exadata_infrastructure_id (str) – The value to assign to the cloud_exadata_infrastructure_id property of this CreateCloudVmClusterDetails.
hostname (str) – The value to assign to the hostname property of this CreateCloudVmClusterDetails.
domain (str) – The value to assign to the domain property of this CreateCloudVmClusterDetails.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this CreateCloudVmClusterDetails.
license_model (str) – The value to assign to the license_model property of this CreateCloudVmClusterDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”
is_sparse_diskgroup_enabled (bool) – The value to assign to the is_sparse_diskgroup_enabled property of this CreateCloudVmClusterDetails.
is_local_backup_enabled (bool) – The value to assign to the is_local_backup_enabled property of this CreateCloudVmClusterDetails.
time_zone (str) – The value to assign to the time_zone property of this CreateCloudVmClusterDetails.
scan_listener_port_tcp (int) – The value to assign to the scan_listener_port_tcp property of this CreateCloudVmClusterDetails.
scan_listener_port_tcp_ssl (int) – The value to assign to the scan_listener_port_tcp_ssl property of this CreateCloudVmClusterDetails.
private_zone_id (str) – The value to assign to the private_zone_id property of this CreateCloudVmClusterDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateCloudVmClusterDetails.
backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this CreateCloudVmClusterDetails.
gi_version (str) – The value to assign to the gi_version property of this CreateCloudVmClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateCloudVmClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateCloudVmClusterDetails.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this CreateCloudVmClusterDetails.
system_version (str) – The value to assign to the system_version property of this CreateCloudVmClusterDetails.

backup_network_nsg_ids¶

Gets the backup_network_nsg_ids of this CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails.
Return type:	list[str]

backup_subnet_id¶

[Required] Gets the backup_subnet_id of this CreateCloudVmClusterDetails. The OCID of the backup network subnet associated with the cloud VM cluster.

Returns:	The backup_subnet_id of this CreateCloudVmClusterDetails.
Return type:	str

cloud_exadata_infrastructure_id¶

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

Returns:	The cloud_exadata_infrastructure_id of this CreateCloudVmClusterDetails.
Return type:	str

cluster_name¶

Gets the cluster_name of this CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails.
Return type:	str

compartment_id¶

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

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

cpu_core_count¶

[Required] Gets the cpu_core_count of this CreateCloudVmClusterDetails. The number of CPU cores to enable for a cloud VM cluster. Valid values depend on the specified shape:

Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.

Returns:	The cpu_core_count of this CreateCloudVmClusterDetails.
Return type:	int

data_collection_options¶

Gets the data_collection_options of this CreateCloudVmClusterDetails.

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

data_storage_percentage¶

Gets the data_storage_percentage of this CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails.
Return type:	int

data_storage_size_in_tbs¶

Gets the data_storage_size_in_tbs of this CreateCloudVmClusterDetails. The data disk group size to be allocated in TBs.

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

db_node_storage_size_in_gbs¶

Gets the db_node_storage_size_in_gbs of this CreateCloudVmClusterDetails. The local node storage to be allocated in GBs.

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

db_servers¶

Gets the db_servers of this CreateCloudVmClusterDetails. The list of DB servers.

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

defined_tags¶

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

display_name¶

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

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

domain¶

Gets the domain of this CreateCloudVmClusterDetails. A domain name used for the cloud VM cluster. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Cloud Service instances only.

Returns:	The domain of this CreateCloudVmClusterDetails.
Return type:	str

freeform_tags¶

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

gi_version¶

[Required] Gets the gi_version of this CreateCloudVmClusterDetails. A valid Oracle Grid Infrastructure (GI) software version.

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

hostname¶

[Required] Gets the hostname of this CreateCloudVmClusterDetails. The hostname for the cloud VM cluster. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata systems.

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the cloud VM Cluster will fail to provision.

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

is_local_backup_enabled¶

Gets the is_local_backup_enabled of this CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails.
Return type:	bool

is_sparse_diskgroup_enabled¶

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

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

license_model¶

Gets the license_model of this CreateCloudVmClusterDetails. The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

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

memory_size_in_gbs¶

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

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

nsg_ids¶

Gets the nsg_ids of this CreateCloudVmClusterDetails. The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

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

ocpu_count¶

Gets the ocpu_count of this CreateCloudVmClusterDetails. The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

Returns:	The ocpu_count of this CreateCloudVmClusterDetails.
Return type:	float

private_zone_id¶

Gets the private_zone_id of this CreateCloudVmClusterDetails. The private zone id in which DNS records need to be created.

Returns:	The private_zone_id of this CreateCloudVmClusterDetails.
Return type:	str

scan_listener_port_tcp¶

Gets the scan_listener_port_tcp of this CreateCloudVmClusterDetails. The TCP Single Client Access Name (SCAN) port. The default port is 1521.

Returns:	The scan_listener_port_tcp of this CreateCloudVmClusterDetails.
Return type:	int

scan_listener_port_tcp_ssl¶

Gets the scan_listener_port_tcp_ssl of this CreateCloudVmClusterDetails. The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Returns:	The scan_listener_port_tcp_ssl of this CreateCloudVmClusterDetails.
Return type:	int

ssh_public_keys¶

[Required] Gets the ssh_public_keys of this CreateCloudVmClusterDetails. 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 CreateCloudVmClusterDetails.
Return type:	list[str]

subnet_id¶

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

Returns:	The subnet_id of this CreateCloudVmClusterDetails.
Return type:	str

system_version¶

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

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

time_zone¶

Gets the time_zone of this CreateCloudVmClusterDetails. The time zone to use for the cloud VM cluster. For details, see Time Zones.

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