cloud_vm_clusters

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

Overview

Name	cloud_vm_clusters
Type	Resource
Id	google.oracledatabase.cloud_vm_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
backupOdbSubnet	string	Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
backupSubnetCidr	string	Optional. CIDR range of the backup subnet.
cidr	string	Optional. Network settings. CIDR to use for cluster IP allocation.
createTime	string (google-datetime)	Output only. The date and time that the VM cluster was created.
displayName	string	Optional. User friendly name for this resource.
exadataInfrastructure	string	Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}
exascaleDbStorageVault	string	Optional. The name of ExascaleDbStorageVault associated with the VM Cluster. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
gcpOracleZone	string	Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.
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. Labels or tags associated with the VM Cluster.
network	string	Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}
odbNetwork	string	Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.
odbSubnet	string	Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
properties	object	Optional. Various properties of the VM Cluster. (id: CloudVmClusterProperties)

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, cloudVmClustersId		Gets details of a single VM Cluster.
list	select	projectsId, locationsId	pageToken, filter, pageSize	Lists the VM Clusters in a given project and location.
create	insert	projectsId, locationsId	requestId, cloudVmClusterId	Creates a new VM Cluster in a given project and location.
delete	delete	projectsId, locationsId, cloudVmClustersId	requestId, force	Deletes a single 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
cloudVmClustersId	string
locationsId	string
projectsId	string
cloudVmClusterId	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single VM Cluster.

SELECT
name,
backupOdbSubnet,
backupSubnetCidr,
cidr,
createTime,
displayName,
exadataInfrastructure,
exascaleDbStorageVault,
gcpOracleZone,
identityConnector,
labels,
network,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.cloud_vm_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND cloudVmClustersId = '{{ cloudVmClustersId }}' -- required
;

list

Lists the VM Clusters in a given project and location.

SELECT
*
FROM google.oracledatabase.cloud_vm_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Creates a new VM Cluster in a given project and location.

INSERT INTO google.oracledatabase.cloud_vm_clusters (
data__properties,
data__exascaleDbStorageVault,
data__backupSubnetCidr,
data__network,
data__cidr,
data__exadataInfrastructure,
data__labels,
data__displayName,
data__odbSubnet,
data__odbNetwork,
data__backupOdbSubnet,
data__name,
projectsId,
locationsId,
requestId,
cloudVmClusterId
)
SELECT 
'{{ properties }}',
'{{ exascaleDbStorageVault }}',
'{{ backupSubnetCidr }}',
'{{ network }}',
'{{ cidr }}',
'{{ exadataInfrastructure }}',
'{{ labels }}',
'{{ displayName }}',
'{{ odbSubnet }}',
'{{ odbNetwork }}',
'{{ backupOdbSubnet }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ cloudVmClusterId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: cloud_vm_clusters
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the cloud_vm_clusters resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the cloud_vm_clusters resource.
  - name: properties
    description: |
      Optional. Various properties of the VM Cluster.
    value:
      licenseType: "{{ licenseType }}"
      hostname: "{{ hostname }}"
      dbServerOcids:
        - "{{ dbServerOcids }}"
      memorySizeGb: {{ memorySizeGb }}
      systemVersion: "{{ systemVersion }}"
      cpuCoreCount: {{ cpuCoreCount }}
      computeModel: "{{ computeModel }}"
      storageManagementType: "{{ storageManagementType }}"
      scanDns: "{{ scanDns }}"
      ocid: "{{ ocid }}"
      sparseDiskgroupEnabled: {{ sparseDiskgroupEnabled }}
      localBackupEnabled: {{ localBackupEnabled }}
      diagnosticsDataCollectionOptions:
        healthMonitoringEnabled: {{ healthMonitoringEnabled }}
        incidentLogsEnabled: {{ incidentLogsEnabled }}
        diagnosticsEventsEnabled: {{ diagnosticsEventsEnabled }}
      ocpuCount: {{ ocpuCount }}
      storageSizeGb: {{ storageSizeGb }}
      hostnamePrefix: "{{ hostnamePrefix }}"
      scanDnsRecordId: "{{ scanDnsRecordId }}"
      scanListenerPortTcpSsl: {{ scanListenerPortTcpSsl }}
      scanListenerPortTcp: {{ scanListenerPortTcp }}
      sshPublicKeys:
        - "{{ sshPublicKeys }}"
      compartmentId: "{{ compartmentId }}"
      state: "{{ state }}"
      ociUrl: "{{ ociUrl }}"
      timeZone:
        id: "{{ id }}"
        version: "{{ version }}"
      dnsListenerIp: "{{ dnsListenerIp }}"
      dbNodeStorageSizeGb: {{ dbNodeStorageSizeGb }}
      dataStorageSizeTb: {{ dataStorageSizeTb }}
      diskRedundancy: "{{ diskRedundancy }}"
      scanIpIds:
        - "{{ scanIpIds }}"
      clusterName: "{{ clusterName }}"
      nodeCount: {{ nodeCount }}
      giVersion: "{{ giVersion }}"
      shape: "{{ shape }}"
      domain: "{{ domain }}"
  - name: exascaleDbStorageVault
    value: "{{ exascaleDbStorageVault }}"
    description: |
      Optional. The name of ExascaleDbStorageVault associated with the VM Cluster. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
  - name: backupSubnetCidr
    value: "{{ backupSubnetCidr }}"
    description: |
      Optional. CIDR range of the backup subnet.
  - name: network
    value: "{{ network }}"
    description: |
      Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}
  - name: cidr
    value: "{{ cidr }}"
    description: |
      Optional. Network settings. CIDR to use for cluster IP allocation.
  - name: exadataInfrastructure
    value: "{{ exadataInfrastructure }}"
    description: |
      Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels or tags associated with the VM Cluster.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. User friendly name for this resource.
  - name: odbSubnet
    value: "{{ odbSubnet }}"
    description: |
      Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: odbNetwork
    value: "{{ odbNetwork }}"
    description: |
      Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.
  - name: backupOdbSubnet
    value: "{{ backupOdbSubnet }}"
    description: |
      Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}
  - name: requestId
    value: "{{ requestId }}"
  - name: cloudVmClusterId
    value: "{{ cloudVmClusterId }}"

DELETE examples

delete

Deletes a single VM Cluster.

DELETE FROM google.oracledatabase.cloud_vm_clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND cloudVmClustersId = '{{ cloudVmClustersId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;