DbSystemSummary¶

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

Bases: object

The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see Bare Metal and Virtual Machine DB Systems.

Note: Deprecated for Exadata Cloud Service instances using the new resource model. To provision and manage new Exadata Cloud Service systems, use the CloudExadataInfrastructure and CloudVmCluster. See Exadata Cloud Service for more information on Exadata systems.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

For information about access control and compartments, see Overview of the Identity Service.

For information about availability domains, see Regions and Availability Domains.

To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity Service API.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`DATABASE_EDITION_ENTERPRISE_EDITION`	A constant which can be used with the database_edition property of a DbSystemSummary.
`DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE`	A constant which can be used with the database_edition property of a DbSystemSummary.
`DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE`	A constant which can be used with the database_edition property of a DbSystemSummary.
`DATABASE_EDITION_STANDARD_EDITION`	A constant which can be used with the database_edition property of a DbSystemSummary.
`DISK_REDUNDANCY_HIGH`	A constant which can be used with the disk_redundancy property of a DbSystemSummary.
`DISK_REDUNDANCY_NORMAL`	A constant which can be used with the disk_redundancy property of a DbSystemSummary.
`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a DbSystemSummary.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a DbSystemSummary.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_MAINTENANCE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_MIGRATED`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`LIFECYCLE_STATE_UPGRADING`	A constant which can be used with the lifecycle_state property of a DbSystemSummary.
`STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED`	A constant which can be used with the storage_volume_performance_mode property of a DbSystemSummary.
`STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE`	A constant which can be used with the storage_volume_performance_mode property of a DbSystemSummary.
`availability_domain`	[Required] Gets the availability_domain of this DbSystemSummary.
`backup_network_nsg_ids`	Gets the backup_network_nsg_ids of this DbSystemSummary.
`backup_subnet_id`	Gets the backup_subnet_id of this DbSystemSummary.
`cluster_name`	Gets the cluster_name of this DbSystemSummary.
`compartment_id`	[Required] Gets the compartment_id of this DbSystemSummary.
`cpu_core_count`	[Required] Gets the cpu_core_count of this DbSystemSummary.
`data_collection_options`	Gets the data_collection_options of this DbSystemSummary.
`data_storage_percentage`	Gets the data_storage_percentage of this DbSystemSummary.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this DbSystemSummary.
`database_edition`	[Required] Gets the database_edition of this DbSystemSummary.
`db_system_options`	Gets the db_system_options of this DbSystemSummary.
`defined_tags`	Gets the defined_tags of this DbSystemSummary.
`disk_redundancy`	Gets the disk_redundancy of this DbSystemSummary.
`display_name`	[Required] Gets the display_name of this DbSystemSummary.
`domain`	[Required] Gets the domain of this DbSystemSummary.
`fault_domains`	Gets the fault_domains of this DbSystemSummary.
`freeform_tags`	Gets the freeform_tags of this DbSystemSummary.
`gi_software_image_id`	Gets the gi_software_image_id of this DbSystemSummary.
`hostname`	[Required] Gets the hostname of this DbSystemSummary.
`id`	[Required] Gets the id of this DbSystemSummary.
`kms_key_id`	Gets the kms_key_id of this DbSystemSummary.
`last_maintenance_run_id`	Gets the last_maintenance_run_id of this DbSystemSummary.
`last_patch_history_entry_id`	Gets the last_patch_history_entry_id of this DbSystemSummary.
`license_model`	Gets the license_model of this DbSystemSummary.
`lifecycle_details`	Gets the lifecycle_details of this DbSystemSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DbSystemSummary.
`listener_port`	Gets the listener_port of this DbSystemSummary.
`maintenance_window`	Gets the maintenance_window of this DbSystemSummary.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this DbSystemSummary.
`next_maintenance_run_id`	Gets the next_maintenance_run_id of this DbSystemSummary.
`node_count`	Gets the node_count of this DbSystemSummary.
`nsg_ids`	Gets the nsg_ids of this DbSystemSummary.
`os_version`	Gets the os_version of this DbSystemSummary.
`point_in_time_data_disk_clone_timestamp`	Gets the point_in_time_data_disk_clone_timestamp of this DbSystemSummary.
`reco_storage_size_in_gb`	Gets the reco_storage_size_in_gb of this DbSystemSummary.
`scan_dns_name`	Gets the scan_dns_name of this DbSystemSummary.
`scan_dns_record_id`	Gets the scan_dns_record_id of this DbSystemSummary.
`scan_ip_ids`	Gets the scan_ip_ids of this DbSystemSummary.
`security_attributes`	Gets the security_attributes of this DbSystemSummary.
`shape`	[Required] Gets the shape of this DbSystemSummary.
`source_db_system_id`	Gets the source_db_system_id of this DbSystemSummary.
`sparse_diskgroup`	Gets the sparse_diskgroup of this DbSystemSummary.
`ssh_public_keys`	[Required] Gets the ssh_public_keys of this DbSystemSummary.
`storage_volume_performance_mode`	Gets the storage_volume_performance_mode of this DbSystemSummary.
`subnet_id`	[Required] Gets the subnet_id of this DbSystemSummary.
`time_created`	Gets the time_created of this DbSystemSummary.
`time_zone`	Gets the time_zone of this DbSystemSummary.
`version`	Gets the version of this DbSystemSummary.
`vip_ids`	Gets the vip_ids of this DbSystemSummary.
`zone_id`	Gets the zone_id of this DbSystemSummary.

Methods

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

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'¶: A constant which can be used with the database_edition property of a DbSystemSummary. 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 DbSystemSummary. 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 DbSystemSummary. This constant has a value of “STANDARD_EDITION”

DISK_REDUNDANCY_HIGH = 'HIGH'¶: A constant which can be used with the disk_redundancy property of a DbSystemSummary. This constant has a value of “HIGH”

DISK_REDUNDANCY_NORMAL = 'NORMAL'¶: A constant which can be used with the disk_redundancy property of a DbSystemSummary. 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 DbSystemSummary. 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 DbSystemSummary. 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 DbSystemSummary. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. 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 DbSystemSummary. This constant has a value of “MAINTENANCE_IN_PROGRESS”

LIFECYCLE_STATE_MIGRATED = 'MIGRATED'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “MIGRATED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “UPDATING”

LIFECYCLE_STATE_UPGRADING = 'UPGRADING'¶: A constant which can be used with the lifecycle_state property of a DbSystemSummary. This constant has a value of “UPGRADING”

STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED = 'BALANCED'¶: A constant which can be used with the storage_volume_performance_mode property of a DbSystemSummary. This constant has a value of “BALANCED”

STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE = 'HIGH_PERFORMANCE'¶: A constant which can be used with the storage_volume_performance_mode property of a DbSystemSummary. This constant has a value of “HIGH_PERFORMANCE”

__init__(**kwargs)¶

Initializes a new DbSystemSummary 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 DbSystemSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DbSystemSummary.
display_name (str) – The value to assign to the display_name property of this DbSystemSummary.
availability_domain (str) – The value to assign to the availability_domain property of this DbSystemSummary.
fault_domains (list[str]) – The value to assign to the fault_domains property of this DbSystemSummary.
subnet_id (str) – The value to assign to the subnet_id property of this DbSystemSummary.
backup_subnet_id (str) – The value to assign to the backup_subnet_id property of this DbSystemSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DbSystemSummary.
backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this DbSystemSummary.
gi_software_image_id (str) – The value to assign to the gi_software_image_id property of this DbSystemSummary.
memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this DbSystemSummary.
storage_volume_performance_mode (str) – The value to assign to the storage_volume_performance_mode property of this DbSystemSummary. Allowed values for this property are: “BALANCED”, “HIGH_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
shape (str) – The value to assign to the shape property of this DbSystemSummary.
db_system_options (oci.database.models.DbSystemOptions) – The value to assign to the db_system_options property of this DbSystemSummary.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this DbSystemSummary.
time_zone (str) – The value to assign to the time_zone property of this DbSystemSummary.
hostname (str) – The value to assign to the hostname property of this DbSystemSummary.
domain (str) – The value to assign to the domain property of this DbSystemSummary.
kms_key_id (str) – The value to assign to the kms_key_id property of this DbSystemSummary.
version (str) – The value to assign to the version property of this DbSystemSummary.
os_version (str) – The value to assign to the os_version property of this DbSystemSummary.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this DbSystemSummary.
cluster_name (str) – The value to assign to the cluster_name property of this DbSystemSummary.
data_storage_percentage (int) – The value to assign to the data_storage_percentage property of this DbSystemSummary.
database_edition (str) – The value to assign to the database_edition property of this DbSystemSummary. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
last_patch_history_entry_id (str) – The value to assign to the last_patch_history_entry_id property of this DbSystemSummary.
listener_port (int) – The value to assign to the listener_port property of this DbSystemSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbSystemSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MIGRATED”, “MAINTENANCE_IN_PROGRESS”, “NEEDS_ATTENTION”, “UPGRADING”, ‘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 DbSystemSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DbSystemSummary.
disk_redundancy (str) – The value to assign to the disk_redundancy property of this DbSystemSummary. 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’.
sparse_diskgroup (bool) – The value to assign to the sparse_diskgroup property of this DbSystemSummary.
scan_ip_ids (list[str]) – The value to assign to the scan_ip_ids property of this DbSystemSummary.
vip_ids (list[str]) – The value to assign to the vip_ids property of this DbSystemSummary.
scan_dns_record_id (str) – The value to assign to the scan_dns_record_id property of this DbSystemSummary.
scan_dns_name (str) – The value to assign to the scan_dns_name property of this DbSystemSummary.
zone_id (str) – The value to assign to the zone_id property of this DbSystemSummary.
data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this DbSystemSummary.
reco_storage_size_in_gb (int) – The value to assign to the reco_storage_size_in_gb property of this DbSystemSummary.
node_count (int) – The value to assign to the node_count property of this DbSystemSummary.
license_model (str) – The value to assign to the license_model property of this DbSystemSummary. 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’.
maintenance_window (oci.database.models.MaintenanceWindow) – The value to assign to the maintenance_window property of this DbSystemSummary.
last_maintenance_run_id (str) – The value to assign to the last_maintenance_run_id property of this DbSystemSummary.
next_maintenance_run_id (str) – The value to assign to the next_maintenance_run_id property of this DbSystemSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbSystemSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbSystemSummary.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DbSystemSummary.
source_db_system_id (str) – The value to assign to the source_db_system_id property of this DbSystemSummary.
point_in_time_data_disk_clone_timestamp (datetime) – The value to assign to the point_in_time_data_disk_clone_timestamp property of this DbSystemSummary.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this DbSystemSummary.

availability_domain¶

[Required] Gets the availability_domain of this DbSystemSummary. The name of the availability domain that the DB system is located in.

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

backup_network_nsg_ids¶

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

backup_subnet_id¶

Gets the backup_subnet_id of this DbSystemSummary. The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restriction: See the subnet restrictions information for subnetId.

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

cluster_name¶

Gets the cluster_name of this DbSystemSummary. The cluster name for Exadata and 2-node RAC virtual machine DB systems. 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 DbSystemSummary.
Return type:	str

compartment_id¶

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

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

cpu_core_count¶

[Required] Gets the cpu_core_count of this DbSystemSummary. The number of CPU cores enabled on the DB system.

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

data_collection_options¶

Gets the data_collection_options of this DbSystemSummary.

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

data_storage_percentage¶

Gets the data_storage_percentage of this DbSystemSummary. 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 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

Returns:	The data_storage_percentage of this DbSystemSummary.
Return type:	int

data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this DbSystemSummary. The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

Returns:	The data_storage_size_in_gbs of this DbSystemSummary.
Return type:	int

database_edition¶

[Required] Gets the database_edition of this DbSystemSummary. The Oracle Database edition that applies to all the databases on the DB system.

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

Returns:	The database_edition of this DbSystemSummary.
Return type:	str

db_system_options¶

Gets the db_system_options of this DbSystemSummary.

Returns:	The db_system_options of this DbSystemSummary.
Return type:	oci.database.models.DbSystemOptions

defined_tags¶

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

disk_redundancy¶

Gets the disk_redundancy of this DbSystemSummary. The type of redundancy configured for the DB system. 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 DbSystemSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this DbSystemSummary. The user-friendly name for the DB system. The name does not have to be unique.

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

domain¶

[Required] Gets the domain of this DbSystemSummary. The domain name for the DB system.

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

fault_domains¶

Gets the fault_domains of this DbSystemSummary. List of the Fault Domains in which this DB system is provisioned.

Returns:	The fault_domains of this DbSystemSummary.
Return type:	list[str]

freeform_tags¶

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

gi_software_image_id¶

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

hostname¶

[Required] Gets the hostname of this DbSystemSummary. The hostname for the DB system.

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

id¶

[Required] Gets the id of this DbSystemSummary. The OCID of the DB system.

Returns:	The id of this DbSystemSummary.
Return type:	str

kms_key_id¶

Gets the kms_key_id of this DbSystemSummary. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:	The kms_key_id of this DbSystemSummary.
Return type:	str

last_maintenance_run_id¶

Gets the last_maintenance_run_id of this DbSystemSummary. The OCID of the last maintenance run.

Returns:	The last_maintenance_run_id of this DbSystemSummary.
Return type:	str

last_patch_history_entry_id¶

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

license_model¶

Gets the license_model of this DbSystemSummary. The Oracle license model that applies to all the databases on the DB system. 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 DbSystemSummary.
Return type:	str

lifecycle_details¶

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

Returns:	The lifecycle_details of this DbSystemSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DbSystemSummary. The current state of the DB system.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “MIGRATED”, “MAINTENANCE_IN_PROGRESS”, “NEEDS_ATTENTION”, “UPGRADING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DbSystemSummary.
Return type:	str

listener_port¶

Gets the listener_port of this DbSystemSummary. The port number configured for the listener on the DB system.

Returns:	The listener_port of this DbSystemSummary.
Return type:	int

maintenance_window¶

Gets the maintenance_window of this DbSystemSummary.

Returns:	The maintenance_window of this DbSystemSummary.
Return type:	oci.database.models.MaintenanceWindow

memory_size_in_gbs¶

Gets the memory_size_in_gbs of this DbSystemSummary. Memory allocated to the DB system, in gigabytes.

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

next_maintenance_run_id¶

Gets the next_maintenance_run_id of this DbSystemSummary. The OCID of the next maintenance run.

Returns:	The next_maintenance_run_id of this DbSystemSummary.
Return type:	str

node_count¶

Gets the node_count of this DbSystemSummary. The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

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

nsg_ids¶

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

os_version¶

Gets the os_version of this DbSystemSummary. The most recent OS Patch Version applied on the DB system.

Returns:	The os_version of this DbSystemSummary.
Return type:	str

point_in_time_data_disk_clone_timestamp¶

Gets the point_in_time_data_disk_clone_timestamp of this DbSystemSummary. The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

Returns:	The point_in_time_data_disk_clone_timestamp of this DbSystemSummary.
Return type:	datetime

reco_storage_size_in_gb¶

Gets the reco_storage_size_in_gb of this DbSystemSummary. The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

Returns:	The reco_storage_size_in_gb of this DbSystemSummary.
Return type:	int

scan_dns_name¶

Gets the scan_dns_name of this DbSystemSummary. The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

Returns:	The scan_dns_name of this DbSystemSummary.
Return type:	str

scan_dns_record_id¶

Gets the scan_dns_record_id of this DbSystemSummary. The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

Returns:	The scan_dns_record_id of this DbSystemSummary.
Return type:	str

scan_ip_ids¶

Gets the scan_ip_ids of this DbSystemSummary. The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. 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 DbSystemSummary.
Return type:	list[str]

security_attributes¶

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

shape¶

[Required] Gets the shape of this DbSystemSummary. The shape of the DB system. The shape determines resources to allocate to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory

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

source_db_system_id¶

Gets the source_db_system_id of this DbSystemSummary. The OCID of the DB system.

Returns:	The source_db_system_id of this DbSystemSummary.
Return type:	str

sparse_diskgroup¶

Gets the sparse_diskgroup of this DbSystemSummary. True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

Returns:	The sparse_diskgroup of this DbSystemSummary.
Return type:	bool

ssh_public_keys¶

[Required] Gets the ssh_public_keys of this DbSystemSummary. The public key portion of one or more key pairs used for SSH access to the DB system.

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

storage_volume_performance_mode¶

Gets the storage_volume_performance_mode of this DbSystemSummary. The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

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

Returns:	The storage_volume_performance_mode of this DbSystemSummary.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this DbSystemSummary. The OCID of the subnet the DB system is associated with.

Subnet Restrictions: - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB 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 DbSystemSummary.
Return type:	str

time_created¶

Gets the time_created of this DbSystemSummary. The date and time the DB system was created.

Returns:	The time_created of this DbSystemSummary.
Return type:	datetime

time_zone¶

Gets the time_zone of this DbSystemSummary. The time zone of the DB system. For details, see DB System Time Zones.

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

version¶

Gets the version of this DbSystemSummary. The Oracle Database version of the DB system.

Returns:	The version of this DbSystemSummary.
Return type:	str

vip_ids¶

Gets the vip_ids of this DbSystemSummary. The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system 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 DbSystemSummary.
Return type:	list[str]

zone_id¶

Gets the zone_id of this DbSystemSummary. The OCID of the zone the DB system is associated with.

Returns:	The zone_id of this DbSystemSummary.
Return type:	str