CreateExadbVmClusterDetails¶

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

Bases: object

Details for the create Exadata VM cluster on Exascale Infrastructure operation. Applies to Exadata Database Service on Exascale Infrastructure only.

Attributes:

`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a CreateExadbVmClusterDetails.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a CreateExadbVmClusterDetails.
`SHAPE_ATTRIBUTE_BLOCK_STORAGE`	A constant which can be used with the shape_attribute property of a CreateExadbVmClusterDetails.
`SHAPE_ATTRIBUTE_SMART_STORAGE`	A constant which can be used with the shape_attribute property of a CreateExadbVmClusterDetails.
`availability_domain`	[Required] Gets the availability_domain of this CreateExadbVmClusterDetails.
`backup_network_nsg_ids`	Gets the backup_network_nsg_ids of this CreateExadbVmClusterDetails.
`backup_subnet_id`	[Required] Gets the backup_subnet_id of this CreateExadbVmClusterDetails.
`cluster_name`	Gets the cluster_name of this CreateExadbVmClusterDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateExadbVmClusterDetails.
`data_collection_options`	Gets the data_collection_options of this CreateExadbVmClusterDetails.
`defined_tags`	Gets the defined_tags of this CreateExadbVmClusterDetails.
`display_name`	[Required] Gets the display_name of this CreateExadbVmClusterDetails.
`domain`	Gets the domain of this CreateExadbVmClusterDetails.
`enabled_e_cpu_count`	[Required] Gets the enabled_e_cpu_count of this CreateExadbVmClusterDetails.
`exascale_db_storage_vault_id`	[Required] Gets the exascale_db_storage_vault_id of this CreateExadbVmClusterDetails.
`freeform_tags`	Gets the freeform_tags of this CreateExadbVmClusterDetails.
`grid_image_id`	[Required] Gets the grid_image_id of this CreateExadbVmClusterDetails.
`hostname`	[Required] Gets the hostname of this CreateExadbVmClusterDetails.
`is_older_version_acknowledged`	Gets the is_older_version_acknowledged of this CreateExadbVmClusterDetails.
`license_model`	Gets the license_model of this CreateExadbVmClusterDetails.
`node_count`	[Required] Gets the node_count of this CreateExadbVmClusterDetails.
`nsg_ids`	Gets the nsg_ids of this CreateExadbVmClusterDetails.
`private_zone_id`	Gets the private_zone_id of this CreateExadbVmClusterDetails.
`scan_listener_port_tcp`	Gets the scan_listener_port_tcp of this CreateExadbVmClusterDetails.
`scan_listener_port_tcp_ssl`	Gets the scan_listener_port_tcp_ssl of this CreateExadbVmClusterDetails.
`security_attributes`	Gets the security_attributes of this CreateExadbVmClusterDetails.
`shape`	[Required] Gets the shape of this CreateExadbVmClusterDetails.
`shape_attribute`	Gets the shape_attribute of this CreateExadbVmClusterDetails.
`ssh_public_keys`	[Required] Gets the ssh_public_keys of this CreateExadbVmClusterDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateExadbVmClusterDetails.
`subscription_id`	Gets the subscription_id of this CreateExadbVmClusterDetails.
`system_version`	Gets the system_version of this CreateExadbVmClusterDetails.
`time_zone`	Gets the time_zone of this CreateExadbVmClusterDetails.
`total_e_cpu_count`	[Required] Gets the total_e_cpu_count of this CreateExadbVmClusterDetails.
`vm_file_system_storage`	[Required] Gets the vm_file_system_storage of this CreateExadbVmClusterDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateExadbVmClusterDetails 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 CreateExadbVmClusterDetails. 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 CreateExadbVmClusterDetails. This constant has a value of “LICENSE_INCLUDED”

SHAPE_ATTRIBUTE_BLOCK_STORAGE = 'BLOCK_STORAGE'¶: A constant which can be used with the shape_attribute property of a CreateExadbVmClusterDetails. This constant has a value of “BLOCK_STORAGE”

SHAPE_ATTRIBUTE_SMART_STORAGE = 'SMART_STORAGE'¶: A constant which can be used with the shape_attribute property of a CreateExadbVmClusterDetails. This constant has a value of “SMART_STORAGE”

__init__(**kwargs)¶

Initializes a new CreateExadbVmClusterDetails 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 CreateExadbVmClusterDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateExadbVmClusterDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateExadbVmClusterDetails.
backup_subnet_id (str) – The value to assign to the backup_subnet_id property of this CreateExadbVmClusterDetails.
cluster_name (str) – The value to assign to the cluster_name property of this CreateExadbVmClusterDetails.
display_name (str) – The value to assign to the display_name property of this CreateExadbVmClusterDetails.
hostname (str) – The value to assign to the hostname property of this CreateExadbVmClusterDetails.
domain (str) – The value to assign to the domain property of this CreateExadbVmClusterDetails.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this CreateExadbVmClusterDetails.
license_model (str) – The value to assign to the license_model property of this CreateExadbVmClusterDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”
time_zone (str) – The value to assign to the time_zone property of this CreateExadbVmClusterDetails.
scan_listener_port_tcp (int) – The value to assign to the scan_listener_port_tcp property of this CreateExadbVmClusterDetails.
scan_listener_port_tcp_ssl (int) – The value to assign to the scan_listener_port_tcp_ssl property of this CreateExadbVmClusterDetails.
private_zone_id (str) – The value to assign to the private_zone_id property of this CreateExadbVmClusterDetails.
shape (str) – The value to assign to the shape property of this CreateExadbVmClusterDetails.
node_count (int) – The value to assign to the node_count property of this CreateExadbVmClusterDetails.
total_e_cpu_count (int) – The value to assign to the total_e_cpu_count property of this CreateExadbVmClusterDetails.
enabled_e_cpu_count (int) – The value to assign to the enabled_e_cpu_count property of this CreateExadbVmClusterDetails.
vm_file_system_storage (oci.database.models.ExadbVmClusterStorageDetails) – The value to assign to the vm_file_system_storage property of this CreateExadbVmClusterDetails.
exascale_db_storage_vault_id (str) – The value to assign to the exascale_db_storage_vault_id property of this CreateExadbVmClusterDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateExadbVmClusterDetails.
backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this CreateExadbVmClusterDetails.
grid_image_id (str) – The value to assign to the grid_image_id property of this CreateExadbVmClusterDetails.
system_version (str) – The value to assign to the system_version property of this CreateExadbVmClusterDetails.
is_older_version_acknowledged (bool) – The value to assign to the is_older_version_acknowledged property of this CreateExadbVmClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateExadbVmClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateExadbVmClusterDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateExadbVmClusterDetails.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this CreateExadbVmClusterDetails.
subscription_id (str) – The value to assign to the subscription_id property of this CreateExadbVmClusterDetails.
shape_attribute (str) – The value to assign to the shape_attribute property of this CreateExadbVmClusterDetails. Allowed values for this property are: “SMART_STORAGE”, “BLOCK_STORAGE”

property availability_domain¶

[Required] Gets the availability_domain of this CreateExadbVmClusterDetails. The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located.

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

property backup_network_nsg_ids¶

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

property backup_subnet_id¶

[Required] Gets the backup_subnet_id of this CreateExadbVmClusterDetails. The OCID of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure.

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

property cluster_name¶

Gets the cluster_name of this CreateExadbVmClusterDetails. The cluster name for Exadata VM cluster on Exascale Infrastructure. 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 CreateExadbVmClusterDetails.
Return type: str

property compartment_id¶

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

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

property data_collection_options¶

Gets the data_collection_options of this CreateExadbVmClusterDetails.

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

property defined_tags¶

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

property display_name¶

[Required] Gets the display_name of this CreateExadbVmClusterDetails. The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique.

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

property domain¶

Gets the domain of this CreateExadbVmClusterDetails. A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then 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 Database Service on Exascale Infrastructure only.

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

property enabled_e_cpu_count¶

[Required] Gets the enabled_e_cpu_count of this CreateExadbVmClusterDetails. The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure.

Returns: The enabled_e_cpu_count of this CreateExadbVmClusterDetails.
Return type: int

property exascale_db_storage_vault_id¶

[Required] Gets the exascale_db_storage_vault_id of this CreateExadbVmClusterDetails. The OCID of the Exadata Database Storage Vault.

Returns: The exascale_db_storage_vault_id of this CreateExadbVmClusterDetails.
Return type: str

property freeform_tags¶

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

property grid_image_id¶

[Required] Gets the grid_image_id of this CreateExadbVmClusterDetails. Grid Setup will be done using this grid image id.

The grid image ID can be obtained using the API /20160918/giVersions/{majorVersion}/minorVersions?compartmentId=<compartmentId>&shapeFamily=EXADB_XS&availabilityDomain=<AD name>. The list of supported major versions can be obtained using the API /20160918/giVersions?compartmentId=<compartmentId>&shape=ExaDbXS&availabilityDomain=<AD name>

Returns: The grid_image_id of this CreateExadbVmClusterDetails.
Return type: str

property hostname¶

[Required] Gets the hostname of this CreateExadbVmClusterDetails. The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters.

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, then the Exadata VM cluster on Exascale Infrastructure will fail to provision.

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

property is_older_version_acknowledged¶

Gets the is_older_version_acknowledged of this CreateExadbVmClusterDetails. If true, the caller acknowledges selecting or applying an older DB, Grid Infrastructure, or operating system software version that is outside the latest default version window.

Returns: The is_older_version_acknowledged of this CreateExadbVmClusterDetails.
Return type: bool

property license_model¶

Gets the license_model of this CreateExadbVmClusterDetails. The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. 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 CreateExadbVmClusterDetails.
Return type: str

property node_count¶

[Required] Gets the node_count of this CreateExadbVmClusterDetails. The number of nodes in the Exadata VM cluster on Exascale Infrastructure.

Returns: The node_count of this CreateExadbVmClusterDetails.
Return type: int

property nsg_ids¶

Gets the nsg_ids of this CreateExadbVmClusterDetails. 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 AI Databases with private access. The nsgIds list can be empty.

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

property private_zone_id¶

Gets the private_zone_id of this CreateExadbVmClusterDetails. The private zone ID in which you want DNS records to be created.

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

property scan_listener_port_tcp¶

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

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

property scan_listener_port_tcp_ssl¶

Gets the scan_listener_port_tcp_ssl of this CreateExadbVmClusterDetails. The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484.

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

property security_attributes¶

Gets the security_attributes of this CreateExadbVmClusterDetails. Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

Returns: The security_attributes of this CreateExadbVmClusterDetails.
Return type: dict(str, dict(str, object))

property shape¶

[Required] Gets the shape of this CreateExadbVmClusterDetails. The shape of the Exadata VM cluster on Exascale Infrastructure resource

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

property shape_attribute¶

Gets the shape_attribute of this CreateExadbVmClusterDetails. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later

Allowed values for this property are: “SMART_STORAGE”, “BLOCK_STORAGE”

Returns: The shape_attribute of this CreateExadbVmClusterDetails.
Return type: str

property ssh_public_keys¶

[Required] Gets the ssh_public_keys of this CreateExadbVmClusterDetails. The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure.

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

property subnet_id¶

[Required] Gets the subnet_id of this CreateExadbVmClusterDetails. The OCID of the subnet associated with the Exadata VM cluster on Exascale Infrastructure.

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

property subscription_id¶

Gets the subscription_id of this CreateExadbVmClusterDetails. The OCID of the subscription with which resource needs to be associated with.

Returns: The subscription_id of this CreateExadbVmClusterDetails.
Return type: str

property system_version¶

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

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

property time_zone¶

Gets the time_zone of this CreateExadbVmClusterDetails. The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see Time Zones.

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

property total_e_cpu_count¶

[Required] Gets the total_e_cpu_count of this CreateExadbVmClusterDetails. The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure.

Returns: The total_e_cpu_count of this CreateExadbVmClusterDetails.
Return type: int

property vm_file_system_storage¶

[Required] Gets the vm_file_system_storage of this CreateExadbVmClusterDetails.

Returns: The vm_file_system_storage of this CreateExadbVmClusterDetails.
Return type: oci.database.models.ExadbVmClusterStorageDetails