Skip to main content

cloud_vm_clusters

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

Overview​

Namecloud_vm_clusters
TypeResource
Idaws.odb.cloud_vm_clusters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
cloud_exadata_infrastructure_arnstringThe Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to. (pattern: <code>arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}</code>)
cloud_exadata_infrastructure_idstringThe unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloud_vm_cluster_arnstringThe Amazon Resource Name (ARN) of the VM cluster.
cloud_vm_cluster_idstringThe unique identifier of the VM cluster. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
cluster_namestringThe name of the Grid Infrastructure (GI) cluster.
compute_modelstringThe OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled. (ECPU, OCPU)
cpu_core_countintegerThe number of CPU cores enabled on the VM cluster.
created_atstring (date-time)The date and time when the VM cluster was created.
data_collection_optionsobjectThe set of diagnostic collection options enabled for the VM cluster.
data_storage_size_in_tbsnumber (double)The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
db_node_storage_size_in_gbsintegerThe amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
db_serversarrayThe list of database servers for the VM cluster.
disk_redundancystringThe type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. (HIGH, NORMAL)
display_namestringThe user-friendly name for the VM cluster.
domainstringThe domain of the VM cluster.
gi_versionstringThe software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostnamestringThe host name for the VM cluster.
iam_rolesarrayThe Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster.
iorm_config_cacheobjectThe ExadataIormConfig cache details for the VM cluster.
is_local_backup_enabledbooleanIndicates whether database backups to local Exadata storage is enabled for the VM cluster.
is_sparse_diskgroup_enabledbooleanIndicates whether the VM cluster is configured with a sparse disk group.
last_update_history_entry_idstringThe Oracle Cloud ID (OCID) of the last maintenance update history entry.
license_modelstringThe Oracle license model applied to the VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED)
listener_portintegerThe port number configured for the listener on the VM cluster.
memory_size_in_gbsintegerThe amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
node_countintegerThe number of nodes in the VM cluster.
oci_resource_anchor_namestringThe name of the OCI resource anchor for the VM cluster.
oci_urlstringThe HTTPS link to the VM cluster in OCI.
ocidstringThe OCID of the VM cluster.
odb_network_arnstringThe Amazon Resource Name (ARN) of the ODB network associated with this VM cluster. (pattern: <code>arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}</code>)
odb_network_idstringThe unique identifier of the ODB network for the VM cluster. (pattern: <code>(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
percent_progressnumber (float)The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
scan_dns_namestringThe fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scan_dns_record_idstringThe OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scan_ip_idsarrayThe OCID of the SCAN IP addresses that are associated with the VM cluster.
shapestringThe hardware model name of the Exadata infrastructure that's running the VM cluster.
ssh_public_keysarrayThe public key portion of one or more key pairs used for SSH access to the VM cluster.
statusstringThe current status of the VM cluster. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reasonstringAdditional information about the status of the VM cluster.
storage_size_in_gbsintegerThe amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
system_versionstringThe operating system version of the image chosen for the VM cluster.
time_zonestringThe time zone of the VM cluster.
vip_idsarrayThe virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_cloud_vm_clusterselectregionReturns information about the specified VM cluster.
list_cloud_vm_clustersselectregionReturns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
create_cloud_vm_clusterinsertregion, cloudExadataInfrastructureId, cpuCoreCount, displayName, giVersion, hostname, sshPublicKeys, odbNetworkIdCreates a VM cluster on the specified Exadata infrastructure.
delete_cloud_vm_clusterdeleteregionDeletes the specified VM cluster.
reboot_db_nodeexecregion, dbNodeIdReboots the specified DB node in a VM cluster.
start_db_nodeexecregion, dbNodeIdStarts the specified DB node in a VM cluster.
stop_db_nodeexecregion, dbNodeIdStops the specified DB node in a VM cluster.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about the specified VM cluster.

SELECT
cloud_exadata_infrastructure_arn,
cloud_exadata_infrastructure_id,
cloud_vm_cluster_arn,
cloud_vm_cluster_id,
cluster_name,
compute_model,
cpu_core_count,
created_at,
data_collection_options,
data_storage_size_in_tbs,
db_node_storage_size_in_gbs,
db_servers,
disk_redundancy,
display_name,
domain,
gi_version,
hostname,
iam_roles,
iorm_config_cache,
is_local_backup_enabled,
is_sparse_diskgroup_enabled,
last_update_history_entry_id,
license_model,
listener_port,
memory_size_in_gbs,
node_count,
oci_resource_anchor_name,
oci_url,
ocid,
odb_network_arn,
odb_network_id,
percent_progress,
scan_dns_name,
scan_dns_record_id,
scan_ip_ids,
shape,
ssh_public_keys,
status,
status_reason,
storage_size_in_gbs,
system_version,
time_zone,
vip_ids
FROM aws.odb.cloud_vm_clusters
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a VM cluster on the specified Exadata infrastructure.

INSERT INTO aws.odb.cloud_vm_clusters (
cloudExadataInfrastructureId,
cpuCoreCount,
displayName,
giVersion,
hostname,
sshPublicKeys,
odbNetworkId,
clusterName,
dataCollectionOptions,
dataStorageSizeInTBs,
dbNodeStorageSizeInGBs,
dbServers,
tags,
isLocalBackupEnabled,
isSparseDiskgroupEnabled,
licenseModel,
memorySizeInGBs,
systemVersion,
timeZone,
clientToken,
scanListenerPortTcp,
region
)
SELECT 
'{{ cloudExadataInfrastructureId }}' /* required */,
{{ cpuCoreCount }} /* required */,
'{{ displayName }}' /* required */,
'{{ giVersion }}' /* required */,
'{{ hostname }}' /* required */,
'{{ sshPublicKeys }}' /* required */,
'{{ odbNetworkId }}' /* required */,
'{{ clusterName }}',
'{{ dataCollectionOptions }}',
{{ dataStorageSizeInTBs }},
{{ dbNodeStorageSizeInGBs }},
'{{ dbServers }}',
'{{ tags }}',
{{ isLocalBackupEnabled }},
{{ isSparseDiskgroupEnabled }},
'{{ licenseModel }}',
{{ memorySizeInGBs }},
'{{ systemVersion }}',
'{{ timeZone }}',
'{{ clientToken }}',
{{ scanListenerPortTcp }},
'{{ region }}'
RETURNING
cloud_vm_cluster_id,
display_name,
status,
status_reason
;

DELETE examples​

Deletes the specified VM cluster.

DELETE FROM aws.odb.cloud_vm_clusters
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Reboots the specified DB node in a VM cluster.

EXEC aws.odb.cloud_vm_clusters.reboot_db_node 
@region='{{ region }}' --required 
@@json=
'{
"cloudVmClusterId": "{{ cloudVmClusterId }}", 
"exadbVmClusterId": "{{ exadbVmClusterId }}", 
"dbNodeId": "{{ dbNodeId }}"
}'
;
Last updated on