DbNodeSummary¶

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

Bases: object

A server where Oracle Database software is running.

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

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

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DbNodeSummary.
`MAINTENANCE_TYPE_EXADBXS_REBOOT_MIGRATION`	A constant which can be used with the maintenance_type property of a DbNodeSummary.
`MAINTENANCE_TYPE_VMDB_REBOOT_MIGRATION`	A constant which can be used with the maintenance_type property of a DbNodeSummary.
`additional_details`	Gets the additional_details of this DbNodeSummary.
`backup_ip_id`	Gets the backup_ip_id of this DbNodeSummary.
`backup_vnic2_id`	Gets the backup_vnic2_id of this DbNodeSummary.
`backup_vnic_id`	Gets the backup_vnic_id of this DbNodeSummary.
`cpu_core_count`	Gets the cpu_core_count of this DbNodeSummary.
`db_node_storage_size_in_gbs`	Gets the db_node_storage_size_in_gbs of this DbNodeSummary.
`db_server_id`	Gets the db_server_id of this DbNodeSummary.
`db_system_id`	[Required] Gets the db_system_id of this DbNodeSummary.
`defined_tags`	Gets the defined_tags of this DbNodeSummary.
`fault_domain`	Gets the fault_domain of this DbNodeSummary.
`freeform_tags`	Gets the freeform_tags of this DbNodeSummary.
`host_ip_id`	Gets the host_ip_id of this DbNodeSummary.
`hostname`	Gets the hostname of this DbNodeSummary.
`id`	[Required] Gets the id of this DbNodeSummary.
`lifecycle_details`	Gets the lifecycle_details of this DbNodeSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DbNodeSummary.
`maintenance_type`	Gets the maintenance_type of this DbNodeSummary.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this DbNodeSummary.
`software_storage_size_in_gb`	Gets the software_storage_size_in_gb of this DbNodeSummary.
`time_created`	[Required] Gets the time_created of this DbNodeSummary.
`time_maintenance_window_end`	Gets the time_maintenance_window_end of this DbNodeSummary.
`time_maintenance_window_start`	Gets the time_maintenance_window_start of this DbNodeSummary.
`total_cpu_core_count`	Gets the total_cpu_core_count of this DbNodeSummary.
`vnic2_id`	Gets the vnic2_id of this DbNodeSummary.
`vnic_id`	[Required] Gets the vnic_id of this DbNodeSummary.

Methods

__init__(**kwargs) Initializes a new DbNodeSummary object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a DbNodeSummary. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DbNodeSummary. This constant has a value of “FAILED”

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

LIFECYCLE_STATE_STARTING = 'STARTING'¶: A constant which can be used with the lifecycle_state property of a DbNodeSummary. This constant has a value of “STARTING”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a DbNodeSummary. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a DbNodeSummary. This constant has a value of “STOPPING”

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

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

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

MAINTENANCE_TYPE_EXADBXS_REBOOT_MIGRATION = 'EXADBXS_REBOOT_MIGRATION'¶: A constant which can be used with the maintenance_type property of a DbNodeSummary. This constant has a value of “EXADBXS_REBOOT_MIGRATION”

MAINTENANCE_TYPE_VMDB_REBOOT_MIGRATION = 'VMDB_REBOOT_MIGRATION'¶: A constant which can be used with the maintenance_type property of a DbNodeSummary. This constant has a value of “VMDB_REBOOT_MIGRATION”

__init__(**kwargs)¶

Initializes a new DbNodeSummary 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 DbNodeSummary.
db_system_id (str) – The value to assign to the db_system_id property of this DbNodeSummary.
vnic_id (str) – The value to assign to the vnic_id property of this DbNodeSummary.
backup_vnic_id (str) – The value to assign to the backup_vnic_id property of this DbNodeSummary.
host_ip_id (str) – The value to assign to the host_ip_id property of this DbNodeSummary.
backup_ip_id (str) – The value to assign to the backup_ip_id property of this DbNodeSummary.
vnic2_id (str) – The value to assign to the vnic2_id property of this DbNodeSummary.
backup_vnic2_id (str) – The value to assign to the backup_vnic2_id property of this DbNodeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbNodeSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “STOPPING”, “STOPPED”, “STARTING”, “TERMINATING”, “TERMINATED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
hostname (str) – The value to assign to the hostname property of this DbNodeSummary.
fault_domain (str) – The value to assign to the fault_domain property of this DbNodeSummary.
time_created (datetime) – The value to assign to the time_created property of this DbNodeSummary.
software_storage_size_in_gb (int) – The value to assign to the software_storage_size_in_gb property of this DbNodeSummary.
maintenance_type (str) – The value to assign to the maintenance_type property of this DbNodeSummary. Allowed values for this property are: “VMDB_REBOOT_MIGRATION”, “EXADBXS_REBOOT_MIGRATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_maintenance_window_start (datetime) – The value to assign to the time_maintenance_window_start property of this DbNodeSummary.
time_maintenance_window_end (datetime) – The value to assign to the time_maintenance_window_end property of this DbNodeSummary.
additional_details (str) – The value to assign to the additional_details property of this DbNodeSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbNodeSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbNodeSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DbNodeSummary.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this DbNodeSummary.
memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this DbNodeSummary.
db_node_storage_size_in_gbs (int) – The value to assign to the db_node_storage_size_in_gbs property of this DbNodeSummary.
total_cpu_core_count (int) – The value to assign to the total_cpu_core_count property of this DbNodeSummary.
db_server_id (str) – The value to assign to the db_server_id property of this DbNodeSummary.

additional_details¶

Gets the additional_details of this DbNodeSummary. Additional information about the planned maintenance.

Returns:	The additional_details of this DbNodeSummary.
Return type:	str

backup_ip_id¶

Gets the backup_ip_id of this DbNodeSummary. The OCID of the backup IP address associated with the database node. Use this OCID with either the get_private_ip() or the get_public_ip_by_private_ip_id() API to get the IP address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

Returns:	The backup_ip_id of this DbNodeSummary.
Return type:	str

backup_vnic2_id¶

Gets the backup_vnic2_id of this DbNodeSummary. The OCID of the second backup VNIC.

Note: Applies only to Exadata Cloud Service.

Returns:	The backup_vnic2_id of this DbNodeSummary.
Return type:	str

backup_vnic_id¶

Gets the backup_vnic_id of this DbNodeSummary. The OCID of the backup VNIC.

Returns:	The backup_vnic_id of this DbNodeSummary.
Return type:	str

cpu_core_count¶

Gets the cpu_core_count of this DbNodeSummary. The number of CPU cores enabled on the Db node.

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

db_node_storage_size_in_gbs¶

Gets the db_node_storage_size_in_gbs of this DbNodeSummary. The allocated local node storage in GBs on the Db node.

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

db_server_id¶

Gets the db_server_id of this DbNodeSummary. The OCID of the Exacc Db server associated with the database node.

Returns:	The db_server_id of this DbNodeSummary.
Return type:	str

db_system_id¶

[Required] Gets the db_system_id of this DbNodeSummary. The OCID of the DB system.

Returns:	The db_system_id of this DbNodeSummary.
Return type:	str

defined_tags¶

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

fault_domain¶

Gets the fault_domain of this DbNodeSummary. The name of the Fault Domain the instance is contained in.

Returns:	The fault_domain of this DbNodeSummary.
Return type:	str

freeform_tags¶

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

host_ip_id¶

Gets the host_ip_id of this DbNodeSummary. The OCID of the host IP address associated with the database node. Use this OCID with either the get_private_ip() or the get_public_ip_by_private_ip_id() API to get the IP address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

Returns:	The host_ip_id of this DbNodeSummary.
Return type:	str

hostname¶

Gets the hostname of this DbNodeSummary. The host name for the database node.

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

id¶

[Required] Gets the id of this DbNodeSummary. The OCID of the database node.

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

lifecycle_details¶

Gets the lifecycle_details of this DbNodeSummary. Information about the current lifecycle state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DbNodeSummary. The current state of the database node.

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

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

maintenance_type¶

Gets the maintenance_type of this DbNodeSummary. The type of database node maintenance.

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

Returns:	The maintenance_type of this DbNodeSummary.
Return type:	str

memory_size_in_gbs¶

Gets the memory_size_in_gbs of this DbNodeSummary. The allocated memory in GBs on the Db node.

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

software_storage_size_in_gb¶

Gets the software_storage_size_in_gb of this DbNodeSummary. The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.

Returns:	The software_storage_size_in_gb of this DbNodeSummary.
Return type:	int

time_created¶

[Required] Gets the time_created of this DbNodeSummary. The date and time that the database node was created.

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

time_maintenance_window_end¶

Gets the time_maintenance_window_end of this DbNodeSummary. End date and time of maintenance window.

Returns:	The time_maintenance_window_end of this DbNodeSummary.
Return type:	datetime

time_maintenance_window_start¶

Gets the time_maintenance_window_start of this DbNodeSummary. Start date and time of maintenance window.

Returns:	The time_maintenance_window_start of this DbNodeSummary.
Return type:	datetime

total_cpu_core_count¶

Gets the total_cpu_core_count of this DbNodeSummary. The total number of CPU cores reserved on the Db node.

Returns:	The total_cpu_core_count of this DbNodeSummary.
Return type:	int

vnic2_id¶

Gets the vnic2_id of this DbNodeSummary. The OCID of the second VNIC.

Note: Applies only to Exadata Cloud Service.

Returns:	The vnic2_id of this DbNodeSummary.
Return type:	str

vnic_id¶

[Required] Gets the vnic_id of this DbNodeSummary. The OCID of the VNIC.

Returns:	The vnic_id of this DbNodeSummary.
Return type:	str