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

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.
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)

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.
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	pageSize, pageToken, filter, orderBy	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	updateMask, requestId	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

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

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

list

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

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

INSERT examples

create

Creates a new Exadb (Exascale) VM Cluster resource.

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

Manifest

# Description fields are for documentation purposes
- name: exadb_vm_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the exadb_vm_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the exadb_vm_clusters resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
        
    - name: properties
      value: object
      description: >
        Required. The properties of the ExadbVmCluster.
        
    - name: labels
      value: object
      description: >
        Optional. The labels or tags associated with the ExadbVmCluster.
        
    - name: odbNetwork
      value: string
      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: odbSubnet
      value: string
      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: backupOdbSubnet
      value: string
      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: displayName
      value: string
      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: exadbVmClusterId
      value: string
    - name: requestId
      value: string

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__properties = '{{ properties }}',
data__labels = '{{ labels }}',
data__odbNetwork = '{{ odbNetwork }}',
data__odbSubnet = '{{ odbSubnet }}',
data__backupOdbSubnet = '{{ backupOdbSubnet }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND exadbVmClustersId = '{{ exadbVmClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
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 }}'
;