db_nodes

Creates, updates, deletes, gets or lists a db_nodes resource.

Overview

Name	`db_nodes`
Type	Resource
Id	`oci.database.db_nodes`

Fields

The following fields are returned by SELECT queries:

get
list

The database node information is retrieved.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the database node.
`additionalDetails`	`string`	Additional information about the planned maintenance.
`backupIpId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IP address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address needed to make a database connection. Note: Applies only to Exadata Cloud Service.
`backupVnic2Id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the second backup VNIC. Note: Applies only to Exadata Cloud Service.
`backupVnicId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup VNIC.
`computeCount`	`integer (int32)`	The number of compute servers for the DB system.
`computeModel`	`string`	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. (ECPU, OCPU)
`cpuCoreCount`	`integer`	The number of CPU cores enabled on the Db node.
`dbNodeStorageSizeInGBs`	`integer`	The allocated local node storage in GBs on the Db node.
`dbServerId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server associated with the database node.
`dbSystemId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system.
`faultDomain`	`string`	The name of the Fault Domain the instance is contained in.
`hostIpId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the host IP address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address needed to make a database connection. Note: Applies only to Exadata Cloud Service.
`hostname`	`string`	The host name for the database node.
`isForceActionInProgress`	`boolean`	Indicates whether the node is in the process of being forcefully stopped or rebooted.
`isOsPatchRebootRequired`	`boolean`	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.
`lifecycleState`	`string`	The current state of the database node. (PROVISIONING, AVAILABLE, UPDATING, STOPPING, STOPPED, STARTING, TERMINATING, TERMINATED, FAILED)
`maintenanceType`	`string`	The type of database node maintenance. (VMDB_REBOOT_MIGRATION, EXADBXS_REBOOT_MIGRATION)
`memorySizeInGBs`	`integer`	The allocated memory in GBs on the Db node.
`softwareStorageSizeInGB`	`integer`	The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.
`timeCreated`	`string (date-time)`	The date and time that the database node was created.
`timeMaintenanceWindowEnd`	`string (date-time)`	End date and time of maintenance window.
`timeMaintenanceWindowStart`	`string (date-time)`	Start date and time of maintenance window.
`totalCpuCoreCount`	`integer`	The total number of CPU cores reserved on the Db node.
`vnic2Id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the second VNIC. Note: Applies only to Exadata Cloud Service.
`vnicId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC.

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](/Content/Identity/Concepts/policygetstarted.htm). Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the database node.
`additionalDetails`	`string`	Additional information about the planned maintenance.
`backupIpId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup IP address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address needed to make a database connection. Note: Applies only to Exadata Cloud Service.
`backupVnic2Id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the second backup VNIC. Note: Applies only to Exadata Cloud Service.
`backupVnicId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the backup VNIC.
`computeCount`	`integer (int32)`	The number of compute servers for the DB system.
`computeModel`	`string`	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. (ECPU, OCPU)
`cpuCoreCount`	`integer`	The number of CPU cores enabled on the Db node.
`dbNodeStorageSizeInGBs`	`integer`	The allocated local node storage in GBs on the Db node.
`dbServerId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server associated with the database node.
`dbSystemId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system.
`faultDomain`	`string`	The name of the Fault Domain the instance is contained in.
`hostIpId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the host IP address associated with the database node. Use this OCID with either the [GetPrivateIp](#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IP address needed to make a database connection. Note: Applies only to Exadata Cloud Service.
`hostname`	`string`	The host name for the database node.
`isForceActionInProgress`	`boolean`	Indicates whether the node is in the process of being forcefully stopped or rebooted.
`isOsPatchRebootRequired`	`boolean`	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.
`lifecycleState`	`string`	The current state of the database node. (PROVISIONING, AVAILABLE, UPDATING, STOPPING, STOPPED, STARTING, TERMINATING, TERMINATED, FAILED)
`maintenanceType`	`string`	The type of database node maintenance. (VMDB_REBOOT_MIGRATION, EXADBXS_REBOOT_MIGRATION)
`memorySizeInGBs`	`integer`	The allocated memory in GBs on the Db node.
`softwareStorageSizeInGB`	`integer`	The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.
`timeCreated`	`string (date-time)`	The date and time that the database node was created.
`timeMaintenanceWindowEnd`	`string (date-time)`	End date and time of maintenance window.
`timeMaintenanceWindowStart`	`string (date-time)`	Start date and time of maintenance window.
`totalCpuCoreCount`	`integer`	The total number of CPU cores reserved on the Db node.
`vnic2Id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the second VNIC. Note: Applies only to Exadata Cloud Service.
`vnicId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`dbNodeId`, `region`		Gets information about the specified database node.
`list`	`select`	`compartmentId`, `region`	`dbSystemId`, `vmClusterId`, `limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`, `dbServerId`	Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either '--db-system-id' or '--vm-cluster-id' also must be provided, depending on the service being accessed.<br />
`db_node_action`	`exec`	`dbNodeId`, `action`, `region`	`opc-retry-token`, `if-match`	Performs one of the following power actions on the specified DB node:<br />- start - power on<br />- stop - power off gracefully<br />- forcestop - power off forcefully<br />- forcereset - ACPI shutdown and power on forcefully<br />- softreset - ACPI shutdown and power on<br />- reset - power off and power on<br /><br />Note: Stopping a node affects billing differently, depending on the type of DB system:<br />Bare metal and Exadata systems - The stop state has no effect on the resources you consume.<br />Billing continues for DB nodes that you stop, and related resources continue<br />to apply against any relevant quotas. You must terminate the DB system<br />([TerminateDbSystem](#/en/database/latest/DbSystem/TerminateDbSystem))<br />to remove its resources from billing and quotas.<br />Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`action`	`string`	The action to perform on the DB Node.
`compartmentId`	`string`	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
`dbNodeId`	`string`	The database node [OCID](/Content/General/Concepts/identifiers.htm).
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`dbServerId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exacc Db server.
`dbSystemId`	`string`	The DB system [OCID](/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the given lifecycle state exactly.
`limit`	`integer`	The maximum number of items to return per page.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	The pagination token to continue listing from.
`sortBy`	`string`	Sort by TIMECREATED. Default order for TIMECREATED is descending.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`).
`vmClusterId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster.

`SELECT` examples

get
list

Gets information about the specified database node.

SELECT
id,
additionalDetails,
backupIpId,
backupVnic2Id,
backupVnicId,
computeCount,
computeModel,
cpuCoreCount,
dbNodeStorageSizeInGBs,
dbServerId,
dbSystemId,
faultDomain,
hostIpId,
hostname,
isForceActionInProgress,
isOsPatchRebootRequired,
lifecycleState,
maintenanceType,
memorySizeInGBs,
softwareStorageSizeInGB,
timeCreated,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
totalCpuCoreCount,
vnic2Id,
vnicId
FROM oci.database.db_nodes
WHERE dbNodeId = '{{ dbNodeId }}' -- required
AND region = '{{ region }}' -- required
;

Lists the database nodes in the specified DB system and compartment. In addition to the other required parameters, either '--db-system-id' or '--vm-cluster-id' also must be provided, depending on the service being accessed.

SELECT
id,
additionalDetails,
backupIpId,
backupVnic2Id,
backupVnicId,
computeCount,
computeModel,
cpuCoreCount,
dbNodeStorageSizeInGBs,
dbServerId,
dbSystemId,
faultDomain,
hostIpId,
hostname,
isForceActionInProgress,
isOsPatchRebootRequired,
lifecycleState,
maintenanceType,
memorySizeInGBs,
softwareStorageSizeInGB,
timeCreated,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
totalCpuCoreCount,
vnic2Id,
vnicId
FROM oci.database.db_nodes
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND dbSystemId = '{{ dbSystemId }}'
AND vmClusterId = '{{ vmClusterId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND dbServerId = '{{ dbServerId }}'
;

Lifecycle Methods

db_node_action

Performs one of the following power actions on the specified DB node: - start - power on - stop - power off gracefully - forcestop - power off forcefully - forcereset - ACPI shutdown and power on forcefully - softreset - ACPI shutdown and power on - reset - power off and power on Note: Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata systems - The stop state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system ([TerminateDbSystem](#/en/database/latest/DbSystem/TerminateDbSystem)) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

EXEC oci.database.db_nodes.db_node_action 
@dbNodeId='{{ dbNodeId }}' --required, 
@action='{{ action }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Lifecycle Methods​