DbNode¶

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

Bases: object

DbNode model.

Attributes:

`AVAILABLE_ACTIONS_FORCERESET`	A constant which can be used with the available_actions property of a DbNode.
`AVAILABLE_ACTIONS_FORCESTOP`	A constant which can be used with the available_actions property of a DbNode.
`AVAILABLE_ACTIONS_RESET`	A constant which can be used with the available_actions property of a DbNode.
`AVAILABLE_ACTIONS_SOFTRESET`	A constant which can be used with the available_actions property of a DbNode.
`AVAILABLE_ACTIONS_START`	A constant which can be used with the available_actions property of a DbNode.
`AVAILABLE_ACTIONS_STOP`	A constant which can be used with the available_actions property of a DbNode.
`COMPUTE_MODEL_ECPU`	A constant which can be used with the compute_model property of a DbNode.
`COMPUTE_MODEL_OCPU`	A constant which can be used with the compute_model property of a DbNode.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DbNode.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DbNode.
`MAINTENANCE_TYPE_EXADBXS_REBOOT_MIGRATION`	A constant which can be used with the maintenance_type property of a DbNode.
`MAINTENANCE_TYPE_VMDB_REBOOT_MIGRATION`	A constant which can be used with the maintenance_type property of a DbNode.
`additional_details`	Gets the additional_details of this DbNode.
`available_actions`	Gets the available_actions of this DbNode.
`backup_ip_id`	Gets the backup_ip_id of this DbNode.
`backup_ipv6_id`	Gets the backup_ipv6_id of this DbNode.
`backup_vnic2_id`	Gets the backup_vnic2_id of this DbNode.
`backup_vnic_id`	Gets the backup_vnic_id of this DbNode.
`compute_count`	Gets the compute_count of this DbNode.
`compute_model`	Gets the compute_model of this DbNode.
`cpu_core_count`	Gets the cpu_core_count of this DbNode.
`db_node_storage_size_in_gbs`	Gets the db_node_storage_size_in_gbs of this DbNode.
`db_server_id`	Gets the db_server_id of this DbNode.
`db_system_id`	[Required] Gets the db_system_id of this DbNode.
`defined_tags`	Gets the defined_tags of this DbNode.
`fault_domain`	Gets the fault_domain of this DbNode.
`freeform_tags`	Gets the freeform_tags of this DbNode.
`host_ip_id`	Gets the host_ip_id of this DbNode.
`host_ipv6_id`	Gets the host_ipv6_id of this DbNode.
`hostname`	Gets the hostname of this DbNode.
`id`	[Required] Gets the id of this DbNode.
`is_os_patch_reboot_required`	Gets the is_os_patch_reboot_required of this DbNode.
`lifecycle_details`	Gets the lifecycle_details of this DbNode.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DbNode.
`maintenance_type`	Gets the maintenance_type of this DbNode.
`memory_size_in_gbs`	Gets the memory_size_in_gbs of this DbNode.
`software_storage_size_in_gb`	Gets the software_storage_size_in_gb of this DbNode.
`system_tags`	Gets the system_tags of this DbNode.
`time_created`	[Required] Gets the time_created of this DbNode.
`time_maintenance_window_end`	Gets the time_maintenance_window_end of this DbNode.
`time_maintenance_window_start`	Gets the time_maintenance_window_start of this DbNode.
`total_cpu_core_count`	Gets the total_cpu_core_count of this DbNode.
`vnic2_id`	Gets the vnic2_id of this DbNode.
`vnic_id`	[Required] Gets the vnic_id of this DbNode.

Methods:

__init__(**kwargs)

Initializes a new DbNode object with values from keyword arguments.

AVAILABLE_ACTIONS_FORCERESET = 'FORCERESET'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “FORCERESET”

AVAILABLE_ACTIONS_FORCESTOP = 'FORCESTOP'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “FORCESTOP”

AVAILABLE_ACTIONS_RESET = 'RESET'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “RESET”

AVAILABLE_ACTIONS_SOFTRESET = 'SOFTRESET'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “SOFTRESET”

AVAILABLE_ACTIONS_START = 'START'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “START”

AVAILABLE_ACTIONS_STOP = 'STOP'¶: A constant which can be used with the available_actions property of a DbNode. This constant has a value of “STOP”

COMPUTE_MODEL_ECPU = 'ECPU'¶: A constant which can be used with the compute_model property of a DbNode. This constant has a value of “ECPU”

COMPUTE_MODEL_OCPU = 'OCPU'¶: A constant which can be used with the compute_model property of a DbNode. This constant has a value of “OCPU”

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

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

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

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

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

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

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

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DbNode. 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 DbNode. 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 DbNode. This constant has a value of “VMDB_REBOOT_MIGRATION”

__init__(**kwargs)¶

Initializes a new DbNode 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 DbNode.
db_system_id (str) – The value to assign to the db_system_id property of this DbNode.
vnic_id (str) – The value to assign to the vnic_id property of this DbNode.
backup_vnic_id (str) – The value to assign to the backup_vnic_id property of this DbNode.
host_ip_id (str) – The value to assign to the host_ip_id property of this DbNode.
backup_ip_id (str) – The value to assign to the backup_ip_id property of this DbNode.
host_ipv6_id (str) – The value to assign to the host_ipv6_id property of this DbNode.
backup_ipv6_id (str) – The value to assign to the backup_ipv6_id property of this DbNode.
vnic2_id (str) – The value to assign to the vnic2_id property of this DbNode.
backup_vnic2_id (str) – The value to assign to the backup_vnic2_id property of this DbNode.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbNode. 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’.
available_actions (list[str]) – The value to assign to the available_actions property of this DbNode. Allowed values for items in this list are: “STOP”, “FORCESTOP”, “FORCERESET”, “START”, “SOFTRESET”, “RESET”, ‘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 DbNode.
fault_domain (str) – The value to assign to the fault_domain property of this DbNode.
time_created (datetime) – The value to assign to the time_created property of this DbNode.
software_storage_size_in_gb (int) – The value to assign to the software_storage_size_in_gb property of this DbNode.
maintenance_type (str) – The value to assign to the maintenance_type property of this DbNode. 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 DbNode.
time_maintenance_window_end (datetime) – The value to assign to the time_maintenance_window_end property of this DbNode.
additional_details (str) – The value to assign to the additional_details property of this DbNode.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbNode.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbNode.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DbNode.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DbNode.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this DbNode.
memory_size_in_gbs (int) – The value to assign to the memory_size_in_gbs property of this DbNode.
db_node_storage_size_in_gbs (int) – The value to assign to the db_node_storage_size_in_gbs property of this DbNode.
total_cpu_core_count (int) – The value to assign to the total_cpu_core_count property of this DbNode.
db_server_id (str) – The value to assign to the db_server_id property of this DbNode.
compute_model (str) – The value to assign to the compute_model property of this DbNode. Allowed values for this property are: “ECPU”, “OCPU”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compute_count (int) – The value to assign to the compute_count property of this DbNode.
is_os_patch_reboot_required (bool) – The value to assign to the is_os_patch_reboot_required property of this DbNode.

property additional_details¶

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

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

property available_actions¶

Gets the available_actions of this DbNode. Actions that can be performed on the database node, depending on its current lifecycle state.

Allowed values for items in this list are: “STOP”, “FORCESTOP”, “FORCERESET”, “START”, “SOFTRESET”, “RESET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The available_actions of this DbNode.
Return type: list[str]

property backup_ip_id¶

Gets the backup_ip_id of this DbNode. The OCID of the backup IPv4 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 IPv4 address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

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

property backup_ipv6_id¶

Gets the backup_ipv6_id of this DbNode. The OCID of the backup IPv6 address associated with the database node. Use this OCID with the get_ipv6() API to get the IPv6 address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

Returns: The backup_ipv6_id of this DbNode.
Return type: str

property backup_vnic2_id¶

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

Note: Applies only to Exadata Cloud Service.

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

property backup_vnic_id¶

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

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

property compute_count¶

Gets the compute_count of this DbNode. The number of compute servers for the DB system.

Returns: The compute_count of this DbNode.
Return type: int

property compute_model¶

Gets the compute_model of this DbNode. The compute model for Base Database Service. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy.

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

Returns: The compute_model of this DbNode.
Return type: str

property cpu_core_count¶

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

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

property db_node_storage_size_in_gbs¶

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

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

property db_server_id¶

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

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

property db_system_id¶

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

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

property defined_tags¶

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

property fault_domain¶

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

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

property freeform_tags¶

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

property host_ip_id¶

Gets the host_ip_id of this DbNode. The OCID of the host IPv4 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 IPv4 address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

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

property host_ipv6_id¶

Gets the host_ipv6_id of this DbNode. The OCID of the host IPv6 address associated with the database node. Use this OCID with the get_ipv6() API to get the IPv6 address needed to make a database connection.

Note: Applies only to Exadata Cloud Service.

Returns: The host_ipv6_id of this DbNode.
Return type: str

property hostname¶

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

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

property id¶

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

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

property is_os_patch_reboot_required¶

Gets the is_os_patch_reboot_required of this DbNode. Indicates whether the database node must be rebooted after applying Operating System patches. This flag becomes true after operations such as OS/kernel updates to indicate that a reboot of the node is required. After a successful reboot, this value is expected to return to false.

Returns: The is_os_patch_reboot_required of this DbNode.
Return type: bool

property lifecycle_details¶

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

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

property lifecycle_state¶

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

property maintenance_type¶

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

property memory_size_in_gbs¶

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

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

property software_storage_size_in_gb¶

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

property system_tags¶

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

property time_created¶

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

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

property time_maintenance_window_end¶

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

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

property time_maintenance_window_start¶

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

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

property total_cpu_core_count¶

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

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

property vnic2_id¶

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

Note: Applies only to Exadata Cloud Service.

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

property vnic_id¶

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

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