exadb_vm_clusters

Creates, updates, deletes, gets or lists an exadb_vm_clusters resource.

Overview

Name	`exadb_vm_clusters`
Type	Resource
Id	`google.oracledatabase.exadb_vm_clusters`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
`backupOdbSubnet`	`string`	Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`createTime`	`string (google-datetime)`	Output only. The date and time that the ExadbVmCluster was created.
`displayName`	`string`	Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
`entitlementId`	`string`	Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
`gcpOracleZone`	`string`	Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
`identityConnector`	`object`	Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. (id: IdentityConnector)
`labels`	`object`	Optional. The labels or tags associated with the ExadbVmCluster.
`odbNetwork`	`string`	Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
`odbSubnet`	`string`	Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`properties`	`object`	Required. The properties of the ExadbVmCluster. (id: ExadbVmClusterProperties)

Name	Datatype	Description
`name`	`string`	Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
`backupOdbSubnet`	`string`	Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`createTime`	`string (google-datetime)`	Output only. The date and time that the ExadbVmCluster was created.
`displayName`	`string`	Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
`entitlementId`	`string`	Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
`gcpOracleZone`	`string`	Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
`identityConnector`	`object`	Output only. The identity connector details which will allow OCI to securely access the resources in the customer project. (id: IdentityConnector)
`labels`	`object`	Optional. The labels or tags associated with the ExadbVmCluster.
`odbNetwork`	`string`	Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
`odbSubnet`	`string`	Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
`properties`	`object`	Required. The properties of the ExadbVmCluster. (id: ExadbVmClusterProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `exadbVmClustersId`		Gets details of a single Exadb (Exascale) VM Cluster.
`list`	`select`	`projectsId`, `locationsId`	`filter`, `pageSize`, `orderBy`, `pageToken`	Lists all the Exadb (Exascale) VM Clusters for the given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`exadbVmClusterId`, `requestId`	Creates a new Exadb (Exascale) VM Cluster resource.
`patch`	`update`	`projectsId`, `locationsId`, `exadbVmClustersId`	`requestId`, `updateMask`	Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.
`delete`	`delete`	`projectsId`, `locationsId`, `exadbVmClustersId`	`requestId`	Deletes a single Exadb (Exascale) 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.

Name	Datatype	Description
`exadbVmClustersId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`exadbVmClusterId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of a single Exadb (Exascale) VM Cluster.

SELECT
name,
backupOdbSubnet,
createTime,
displayName,
entitlementId,
gcpOracleZone,
identityConnector,
labels,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.exadb_vm_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND exadbVmClustersId = '{{ exadbVmClustersId }}' -- required
;

Lists all the Exadb (Exascale) VM Clusters for the given project and location.

SELECT
name,
backupOdbSubnet,
createTime,
displayName,
entitlementId,
gcpOracleZone,
identityConnector,
labels,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.exadb_vm_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Creates a new Exadb (Exascale) VM Cluster resource.

INSERT INTO google.oracledatabase.exadb_vm_clusters (
data__name,
data__labels,
data__displayName,
data__odbSubnet,
data__odbNetwork,
data__properties,
data__backupOdbSubnet,
projectsId,
locationsId,
exadbVmClusterId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ odbSubnet }}',
'{{ odbNetwork }}',
'{{ properties }}',
'{{ backupOdbSubnet }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ exadbVmClusterId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: exadb_vm_clusters
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the exadb_vm_clusters resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the exadb_vm_clusters resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels or tags associated with the ExadbVmCluster.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
  - name: odbSubnet
    value: "{{ odbSubnet }}"
    description: |
      Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: odbNetwork
    value: "{{ odbNetwork }}"
    description: |
      Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
  - name: properties
    description: |
      Required. The properties of the ExadbVmCluster.
    value:
      exascaleDbStorageVault: "{{ exascaleDbStorageVault }}"
      gridImageId: "{{ gridImageId }}"
      lifecycleState: "{{ lifecycleState }}"
      hostnamePrefix: "{{ hostnamePrefix }}"
      shapeAttribute: "{{ shapeAttribute }}"
      dataCollectionOptions:
        isDiagnosticsEventsEnabled: {{ isDiagnosticsEventsEnabled }}
        isHealthMonitoringEnabled: {{ isHealthMonitoringEnabled }}
        isIncidentLogsEnabled: {{ isIncidentLogsEnabled }}
      clusterName: "{{ clusterName }}"
      giVersion: "{{ giVersion }}"
      nodeCount: {{ nodeCount }}
      scanListenerPortTcp: {{ scanListenerPortTcp }}
      licenseModel: "{{ licenseModel }}"
      hostname: "{{ hostname }}"
      ociUri: "{{ ociUri }}"
      additionalEcpuCountPerNode: {{ additionalEcpuCountPerNode }}
      enabledEcpuCountPerNode: {{ enabledEcpuCountPerNode }}
      sshPublicKeys:
        - "{{ sshPublicKeys }}"
      memorySizeGb: {{ memorySizeGb }}
      vmFileSystemStorage:
        sizeInGbsPerNode: {{ sizeInGbsPerNode }}
      timeZone:
        id: "{{ id }}"
        version: "{{ version }}"
  - name: backupOdbSubnet
    value: "{{ backupOdbSubnet }}"
    description: |
      Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: exadbVmClusterId
    value: "{{ exadbVmClusterId }}"
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.

UPDATE google.oracledatabase.exadb_vm_clusters
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__odbSubnet = '{{ odbSubnet }}',
data__odbNetwork = '{{ odbNetwork }}',
data__properties = '{{ properties }}',
data__backupOdbSubnet = '{{ backupOdbSubnet }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND exadbVmClustersId = '{{ exadbVmClustersId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single Exadb (Exascale) VM Cluster.

DELETE FROM google.oracledatabase.exadb_vm_clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND exadbVmClustersId = '{{ exadbVmClustersId }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​