db_nodes

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

Overview

Name	db_nodes
Type	Resource
Id	azure_isv.oracledatabase.db_nodes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	string	Additional information about the planned maintenance.
backupIpId	string	The OCID of the backup IP address associated with the database node.
backupVnic2Id	string	The OCID of the second backup VNIC.
backupVnicId	string	The OCID of the backup VNIC.
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 of the Exacc Db server associated with the database node.
dbSystemId	string	The OCID of the DB system. Required.
faultDomain	string	The name of the Fault Domain the instance is contained in.
hostIpId	string	The OCID of the host IP address associated with the database node.
hostname	string	The host name for the database node.
lifecycleDetails	string	Lifecycle details of Db Node.
lifecycleState	string	The current state of the database node. Required. Known values are: "Provisioning", "Available", "Updating", "Stopping", "Stopped", "Starting", "Terminating", "Terminated", and "Failed". (Provisioning, Available, Updating, Stopping, Stopped, Starting, Terminating, Terminated, Failed)
maintenanceType	string	The type of database node maintenance. "VmdbRebootMigration" (VmdbRebootMigration)
memorySizeInGbs	integer	The allocated memory in GBs on the Db node.
ocid	string	DbNode OCID. Required.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The date and time that the database node was created. Required.
timeMaintenanceWindowEnd	string (date-time)	End date and time of maintenance window.
timeMaintenanceWindowStart	string (date-time)	Start date and time of maintenance window.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnic2Id	string	The OCID of the second VNIC.
vnicId	string	The OCID of the VNIC. Required.

list_by_parent

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	string	Additional information about the planned maintenance.
backupIpId	string	The OCID of the backup IP address associated with the database node.
backupVnic2Id	string	The OCID of the second backup VNIC.
backupVnicId	string	The OCID of the backup VNIC.
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 of the Exacc Db server associated with the database node.
dbSystemId	string	The OCID of the DB system. Required.
faultDomain	string	The name of the Fault Domain the instance is contained in.
hostIpId	string	The OCID of the host IP address associated with the database node.
hostname	string	The host name for the database node.
lifecycleDetails	string	Lifecycle details of Db Node.
lifecycleState	string	The current state of the database node. Required. Known values are: "Provisioning", "Available", "Updating", "Stopping", "Stopped", "Starting", "Terminating", "Terminated", and "Failed". (Provisioning, Available, Updating, Stopping, Stopped, Starting, Terminating, Terminated, Failed)
maintenanceType	string	The type of database node maintenance. "VmdbRebootMigration" (VmdbRebootMigration)
memorySizeInGbs	integer	The allocated memory in GBs on the Db node.
ocid	string	DbNode OCID. Required.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
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.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The date and time that the database node was created. Required.
timeMaintenanceWindowEnd	string (date-time)	End date and time of maintenance window.
timeMaintenanceWindowStart	string (date-time)	Start date and time of maintenance window.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnic2Id	string	The OCID of the second VNIC.
vnicId	string	The OCID of the VNIC. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cloudvmclustername, dbnodeocid, subscription_id		Get a DbNode.
list_by_parent	select	resource_group_name, cloudvmclustername, subscription_id		List DbNode resources by CloudVmCluster.
action	exec	resource_group_name, cloudvmclustername, dbnodeocid, subscription_id, action		VM actions on DbNode of VM Cluster by the provided filter.

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
cloudvmclustername	string	CloudVmCluster name. Required.
dbnodeocid	string	DbNode OCID. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a DbNode.

SELECT
id,
name,
additionalDetails,
backupIpId,
backupVnic2Id,
backupVnicId,
cpuCoreCount,
dbNodeStorageSizeInGbs,
dbServerId,
dbSystemId,
faultDomain,
hostIpId,
hostname,
lifecycleDetails,
lifecycleState,
maintenanceType,
memorySizeInGbs,
ocid,
provisioningState,
softwareStorageSizeInGb,
systemData,
timeCreated,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
type,
vnic2Id,
vnicId
FROM azure_isv.oracledatabase.db_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudvmclustername = '{{ cloudvmclustername }}' -- required
AND dbnodeocid = '{{ dbnodeocid }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List DbNode resources by CloudVmCluster.

SELECT
id,
name,
additionalDetails,
backupIpId,
backupVnic2Id,
backupVnicId,
cpuCoreCount,
dbNodeStorageSizeInGbs,
dbServerId,
dbSystemId,
faultDomain,
hostIpId,
hostname,
lifecycleDetails,
lifecycleState,
maintenanceType,
memorySizeInGbs,
ocid,
provisioningState,
softwareStorageSizeInGb,
systemData,
timeCreated,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
type,
vnic2Id,
vnicId
FROM azure_isv.oracledatabase.db_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudvmclustername = '{{ cloudvmclustername }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

action

VM actions on DbNode of VM Cluster by the provided filter.

EXEC azure_isv.oracledatabase.db_nodes.action 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloudvmclustername='{{ cloudvmclustername }}' --required, 
@dbnodeocid='{{ dbnodeocid }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"action": "{{ action }}"
}'
;