BaseccVmCluster

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

Bases: object

Details of the BaseDB-C@C VM cluster resource. Applies to Base Database Service on Cloud@Customer instances only.

Attributes:

DATABASE_EDITION_ENTERPRISE_EDITION

A constant which can be used with the database_edition property of a BaseccVmCluster.

DATABASE_EDITION_ENTERPRISE_EDITION_DEVELOPER

A constant which can be used with the database_edition property of a BaseccVmCluster.

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE

A constant which can be used with the database_edition property of a BaseccVmCluster.

DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE

A constant which can be used with the database_edition property of a BaseccVmCluster.

DATABASE_EDITION_STANDARD_EDITION

A constant which can be used with the database_edition property of a BaseccVmCluster.

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE

A constant which can be used with the license_model property of a BaseccVmCluster.

LICENSE_MODEL_LICENSE_INCLUDED

A constant which can be used with the license_model property of a BaseccVmCluster.

LIFECYCLE_STATE_AVAILABLE

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_PROVISIONING

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_TERMINATED

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_TERMINATING

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a BaseccVmCluster.

VM_CLUSTER_TYPE_DEVELOPER

A constant which can be used with the vm_cluster_type property of a BaseccVmCluster.

VM_CLUSTER_TYPE_REGULAR

A constant which can be used with the vm_cluster_type property of a BaseccVmCluster.

additional_vm_storage_size_in_gbs

Gets the additional_vm_storage_size_in_gbs of this BaseccVmCluster.

availability_domain

[Required] Gets the availability_domain of this BaseccVmCluster.

base_infrastructure_id

[Required] Gets the base_infrastructure_id of this BaseccVmCluster.

base_vm_cluster_network_id

[Required] Gets the base_vm_cluster_network_id of this BaseccVmCluster.

boot_storage_size_in_gbs

Gets the boot_storage_size_in_gbs of this BaseccVmCluster.

cloud_automation_update_details

Gets the cloud_automation_update_details of this BaseccVmCluster.

cluster_name

Gets the cluster_name of this BaseccVmCluster.

compartment_id

[Required] Gets the compartment_id of this BaseccVmCluster.

cpus_enabled

[Required] Gets the cpus_enabled of this BaseccVmCluster.

data_collection_options

Gets the data_collection_options of this BaseccVmCluster.

data_storage_size_in_gbs

Gets the data_storage_size_in_gbs of this BaseccVmCluster.

database_edition

Gets the database_edition of this BaseccVmCluster.

db_servers

Gets the db_servers of this BaseccVmCluster.

defined_tags

[Required] Gets the defined_tags of this BaseccVmCluster.

description

Gets the description of this BaseccVmCluster.

display_name

[Required] Gets the display_name of this BaseccVmCluster.

freeform_tags

[Required] Gets the freeform_tags of this BaseccVmCluster.

gi_version

[Required] Gets the gi_version of this BaseccVmCluster.

id

[Required] Gets the id of this BaseccVmCluster.

last_patch_history_entry_id

Gets the last_patch_history_entry_id of this BaseccVmCluster.

license_model

Gets the license_model of this BaseccVmCluster.

lifecycle_details

Gets the lifecycle_details of this BaseccVmCluster.

lifecycle_state

[Required] Gets the lifecycle_state of this BaseccVmCluster.

memory_size_in_gbs

Gets the memory_size_in_gbs of this BaseccVmCluster.

node_count

Gets the node_count of this BaseccVmCluster.

reco_storage_size_in_gbs

Gets the reco_storage_size_in_gbs of this BaseccVmCluster.

ssh_public_keys

[Required] Gets the ssh_public_keys of this BaseccVmCluster.

system_tags

[Required] Gets the system_tags of this BaseccVmCluster.

system_version

Gets the system_version of this BaseccVmCluster.

time_created

[Required] Gets the time_created of this BaseccVmCluster.

time_updated

Gets the time_updated of this BaseccVmCluster.

time_zone

Gets the time_zone of this BaseccVmCluster.

total_storage_size_in_gbs

Gets the total_storage_size_in_gbs of this BaseccVmCluster.

vm_cluster_type

Gets the vm_cluster_type of this BaseccVmCluster.

Methods:

__init__(**kwargs)

Initializes a new BaseccVmCluster object with values from keyword arguments.

DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'

A constant which can be used with the database_edition property of a BaseccVmCluster. This constant has a value of “ENTERPRISE_EDITION”

DATABASE_EDITION_ENTERPRISE_EDITION_DEVELOPER = 'ENTERPRISE_EDITION_DEVELOPER'

A constant which can be used with the database_edition property of a BaseccVmCluster. This constant has a value of “ENTERPRISE_EDITION_DEVELOPER”

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'

A constant which can be used with the database_edition property of a BaseccVmCluster. This constant has a value of “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”

DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE'

A constant which can be used with the database_edition property of a BaseccVmCluster. This constant has a value of “ENTERPRISE_EDITION_HIGH_PERFORMANCE”

DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION'

A constant which can be used with the database_edition property of a BaseccVmCluster. This constant has a value of “STANDARD_EDITION”

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

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

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

VM_CLUSTER_TYPE_DEVELOPER = 'DEVELOPER'

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

__init__(**kwargs)

Initializes a new BaseccVmCluster 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 BaseccVmCluster.

  • last_patch_history_entry_id (str) – The value to assign to the last_patch_history_entry_id property of this BaseccVmCluster.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this BaseccVmCluster. 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’.

  • time_created (datetime) – The value to assign to the time_created property of this BaseccVmCluster.

  • time_updated (datetime) – The value to assign to the time_updated property of this BaseccVmCluster.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this BaseccVmCluster.

  • availability_domain (str) – The value to assign to the availability_domain property of this BaseccVmCluster.

  • compartment_id (str) – The value to assign to the compartment_id property of this BaseccVmCluster.

  • database_edition (str) – The value to assign to the database_edition property of this BaseccVmCluster. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, “ENTERPRISE_EDITION_DEVELOPER”, ‘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 BaseccVmCluster.

  • db_servers (list[str]) – The value to assign to the db_servers property of this BaseccVmCluster.

  • cpus_enabled (int) – The value to assign to the cpus_enabled property of this BaseccVmCluster.

  • base_infrastructure_id (str) – The value to assign to the base_infrastructure_id property of this BaseccVmCluster.

  • base_vm_cluster_network_id (str) – The value to assign to the base_vm_cluster_network_id property of this BaseccVmCluster.

  • gi_version (str) – The value to assign to the gi_version property of this BaseccVmCluster.

  • data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this BaseccVmCluster.

  • description (str) – The value to assign to the description property of this BaseccVmCluster.

  • display_name (str) – The value to assign to the display_name property of this BaseccVmCluster.

  • ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this BaseccVmCluster.

  • time_zone (str) – The value to assign to the time_zone property of this BaseccVmCluster.

  • cluster_name (str) – The value to assign to the cluster_name property of this BaseccVmCluster.

  • boot_storage_size_in_gbs (int) – The value to assign to the boot_storage_size_in_gbs property of this BaseccVmCluster.

  • additional_vm_storage_size_in_gbs (int) – The value to assign to the additional_vm_storage_size_in_gbs property of this BaseccVmCluster.

  • total_storage_size_in_gbs (int) – The value to assign to the total_storage_size_in_gbs property of this BaseccVmCluster.

  • data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this BaseccVmCluster.

  • reco_storage_size_in_gbs (int) – The value to assign to the reco_storage_size_in_gbs property of this BaseccVmCluster.

  • memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this BaseccVmCluster.

  • license_model (str) – The value to assign to the license_model property of this BaseccVmCluster. 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’.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BaseccVmCluster.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BaseccVmCluster.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this BaseccVmCluster.

  • system_version (str) – The value to assign to the system_version property of this BaseccVmCluster.

  • vm_cluster_type (str) – The value to assign to the vm_cluster_type property of this BaseccVmCluster. 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 BaseccVmCluster.

property additional_vm_storage_size_in_gbs

Gets the additional_vm_storage_size_in_gbs of this BaseccVmCluster. Total /u01 partition size (GB) for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The additional_vm_storage_size_in_gbs of this BaseccVmCluster.

Return type

int

property availability_domain

[Required] Gets the availability_domain of this BaseccVmCluster. The name of the availability domain in which the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster is located.

Returns

The availability_domain of this BaseccVmCluster.

Return type

str

property base_infrastructure_id

[Required] Gets the base_infrastructure_id of this BaseccVmCluster. The OCID of Oracle Data Cloud@Customer Infrastructure.

Returns

The base_infrastructure_id of this BaseccVmCluster.

Return type

str

property base_vm_cluster_network_id

[Required] Gets the base_vm_cluster_network_id of this BaseccVmCluster. The OCID of BaseDB-C@C VM Cluster Network.

Returns

The base_vm_cluster_network_id of this BaseccVmCluster.

Return type

str

property boot_storage_size_in_gbs

Gets the boot_storage_size_in_gbs of this BaseccVmCluster. Total boot partition size (GB) for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The boot_storage_size_in_gbs of this BaseccVmCluster.

Return type

int

property cloud_automation_update_details

Gets the cloud_automation_update_details of this BaseccVmCluster.

Returns

The cloud_automation_update_details of this BaseccVmCluster.

Return type

oci.database.models.CloudAutomationUpdateDetails

property cluster_name

Gets the cluster_name of this BaseccVmCluster. The cluster name for Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The cluster_name of this BaseccVmCluster.

Return type

str

property compartment_id

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

Returns

The compartment_id of this BaseccVmCluster.

Return type

str

property cpus_enabled

[Required] Gets the cpus_enabled of this BaseccVmCluster. The number of ECPUs to enable per VM for the BaseDB C@C VM cluster. Minimum: 8 ECPUs per VM for Enterprise Edition Extreme Performance VM clusters, and 4 ECPUs per VM for other editions. Maximum: 32 ECPUs per VM for Standard Edition, and 240 ECPUs per VM for other editions. For a two-VM Enterprise Edition Extreme Performance VM Cluster, the maximum is 480 total ECPUs (240 ECPUs per VM).

Returns

The cpus_enabled of this BaseccVmCluster.

Return type

int

property data_collection_options

Gets the data_collection_options of this BaseccVmCluster.

Returns

The data_collection_options of this BaseccVmCluster.

Return type

oci.database.models.DataCollectionOptions

property data_storage_size_in_gbs

Gets the data_storage_size_in_gbs of this BaseccVmCluster. The DATA Disk Group size in GB for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The data_storage_size_in_gbs of this BaseccVmCluster.

Return type

int

property database_edition

Gets the database_edition of this BaseccVmCluster. The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, “ENTERPRISE_EDITION_DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_edition of this BaseccVmCluster.

Return type

str

property db_servers

Gets the db_servers of this BaseccVmCluster. List of Base server OCIDs.

Returns

The db_servers of this BaseccVmCluster.

Return type

list[str]

property defined_tags

[Required] Gets the defined_tags of this BaseccVmCluster. 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 BaseccVmCluster.

Return type

dict(str, dict(str, object))

property description

Gets the description of this BaseccVmCluster. The description for Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The description of this BaseccVmCluster.

Return type

str

property display_name

[Required] Gets the display_name of this BaseccVmCluster. The user-friendly name for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster. The name does not need to be unique.

Returns

The display_name of this BaseccVmCluster.

Return type

str

property freeform_tags

[Required] Gets the freeform_tags of this BaseccVmCluster. 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 BaseccVmCluster.

Return type

dict(str, str)

property gi_version

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

Returns

The gi_version of this BaseccVmCluster.

Return type

str

property id

[Required] Gets the id of this BaseccVmCluster. The OCID of the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The id of this BaseccVmCluster.

Return type

str

property last_patch_history_entry_id

Gets the last_patch_history_entry_id of this BaseccVmCluster. 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 BaseccVmCluster.

Return type

str

property license_model

Gets the license_model of this BaseccVmCluster. The Oracle license model that applies to the Base Database Service on Cloud@Customer (BaseDB-C@C) 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 BaseccVmCluster.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this BaseccVmCluster. Additional information about the current lifecycle state of the the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The lifecycle_details of this BaseccVmCluster.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this BaseccVmCluster. 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 BaseccVmCluster.

Return type

str

property memory_size_in_gbs

Gets the memory_size_in_gbs of this BaseccVmCluster. The total memory to be allocated, in GBs, for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster. Minimum for Extreme Performance Edition 1-node or 2-node systems is 16 GB per VM. Minimum for all other editions is 11 GB.

Returns

The memory_size_in_gbs of this BaseccVmCluster.

Return type

int

property node_count

Gets the node_count of this BaseccVmCluster. The number of nodes in the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The node_count of this BaseccVmCluster.

Return type

int

property reco_storage_size_in_gbs

Gets the reco_storage_size_in_gbs of this BaseccVmCluster. The RECO Disk Group size in GB for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The reco_storage_size_in_gbs of this BaseccVmCluster.

Return type

int

property ssh_public_keys

[Required] Gets the ssh_public_keys of this BaseccVmCluster. The public key portion of one or more key pairs used for SSH access to the VMs of Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster.

Returns

The ssh_public_keys of this BaseccVmCluster.

Return type

list[str]

property system_tags

[Required] Gets the system_tags of this BaseccVmCluster. 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 BaseccVmCluster.

Return type

dict(str, dict(str, object))

property system_version

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

Returns

The system_version of this BaseccVmCluster.

Return type

str

property time_created

[Required] Gets the time_created of this BaseccVmCluster. The date and time that the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster was created.

Returns

The time_created of this BaseccVmCluster.

Return type

datetime

property time_updated

Gets the time_updated of this BaseccVmCluster. The date and time that the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster was updated.

Returns

The time_updated of this BaseccVmCluster.

Return type

datetime

property time_zone

Gets the time_zone of this BaseccVmCluster. The time zone to use for the Base Database Service on Cloud@Customer (BaseDB-C@C) VM cluster. For details, see Time Zones.

Returns

The time_zone of this BaseccVmCluster.

Return type

str

property total_storage_size_in_gbs

Gets the total_storage_size_in_gbs of this BaseccVmCluster. The total storage allocated in GBs.

Returns

The total_storage_size_in_gbs of this BaseccVmCluster.

Return type

int

property vm_cluster_type

Gets the vm_cluster_type of this BaseccVmCluster. The cluster type for the Base Database Service on Cloud@Customer (BaseDB-C@C) 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 BaseccVmCluster.

Return type

str