Share via

az oracle-database cloud-vm-cluster

  • Reference

Note

This reference is part of the oracle-database extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az oracle-database cloud-vm-cluster command. Learn more about extensions.

Cloud VM Clusters.

Commands

Name Description Type Status
az oracle-database cloud-vm-cluster add-vm

Add VMs to the VM Cluster.

 Extension GA
az oracle-database cloud-vm-cluster create

Create a CloudVmCluster.

 Extension GA
az oracle-database cloud-vm-cluster database-node

Database Nodes.

 Extension GA
az oracle-database cloud-vm-cluster database-node action

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

 Extension GA
az oracle-database cloud-vm-cluster database-node list

List DbNode resources by CloudVmCluster.

 Extension GA
az oracle-database cloud-vm-cluster delete

Delete a CloudVmCluster.

 Extension GA
az oracle-database cloud-vm-cluster list

List CloudVmCluster resources by subscription ID.

 Extension GA
az oracle-database cloud-vm-cluster remove-vm

Remove VMs from the VM Cluster.

 Extension GA
az oracle-database cloud-vm-cluster show

Get a CloudVmCluster.

 Extension GA
az oracle-database cloud-vm-cluster update

Update a CloudVmCluster.

 Extension GA
az oracle-database cloud-vm-cluster wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az oracle-database cloud-vm-cluster add-vm

Add VMs to the VM Cluster.

az oracle-database cloud-vm-cluster add-vm --db-servers
                                           [--cloudvmclustername]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]

Examples

Add VMs to Cluster

az oracle-database cloud-vm-cluster add-vm --cloudvmclustername <vmclustername> --resource-group <Resource group> --db-servers ['ocid1','ocid2']

Required Parameters

--db-servers

Db servers ocids Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--cloudvmclustername

CloudVmCluster name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster create

Create a CloudVmCluster.

az oracle-database cloud-vm-cluster create --cloudvmclustername
                                           --resource-group
                                           [--backup-subnet-cidr]
                                           [--cloud-exadata-infrastructure-id]
                                           [--cluster-name]
                                           [--collection-options]
                                           [--cpu-core-count]
                                           [--data-storage-percentage]
                                           [--data-storage-size-in-tbs]
                                           [--db-node-storage-size-in-gbs]
                                           [--db-servers]
                                           [--display-name]
                                           [--domain]
                                           [--gi-version]
                                           [--hostname]
                                           [--is-local-backup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--is-sparse-diskgroup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--license-model {BringYourOwnLicense, LicenseIncluded}]
                                           [--location]
                                           [--memory-size-in-gbs]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--nsg-cidrs]
                                           [--ocpu-count]
                                           [--scan-listener-port-tcp]
                                           [--scan-listener-port-tcp-ssl]
                                           [--ssh-public-keys]
                                           [--subnet-id]
                                           [--system-version]
                                           [--tags]
                                           [--time-zone]
                                           [--vnet-id]
                                           [--zone-id]

Examples

Create VM Cluster

az oracle-database cloud-vm-cluster create --name <name> --resource-group <resource group> --location <location> --cloud-exadata-infrastructure-id <Exa Infra Id> --cpu-core-count <cpu count> --data-storage-percentage <storage percent> --data-storage-size-in-tbs <storage in TBs> --db-node-storage-size-in-gbs <storage size> --db-servers ['ocid1','ocid2'] --display-name <display name> --gi-version 19.0.0.0 --hostname <host name> --is-local-backup-enabled False --is-sparse-diskgroup-enabled False --license-model <LicenseIncluded/BringYourOwnLicense> --memory-size-in-gbs <memory size> --ssh-public-keys <ssh key> --subnet-id <subnet id> --time-zone <timezeone eg. UTC> --vnet-id <virtual network id>

Required Parameters

--cloudvmclustername --name -n

CloudVmCluster name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--backup-subnet-cidr

Client OCI backup subnet CIDR, default is 192.168.252.0/22.

--cloud-exadata-infrastructure-id --exa-infra-id

Cloud Exadata Infrastructure ID.

--cluster-name

The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

--collection-options --data-collection-options

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cpu-core-count

The number of CPU cores enabled on the cloud VM cluster.

--data-storage-percentage --storage-percent

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

--data-storage-size-in-tbs --storage-tbs

The data disk group size to be allocated in TBs.

--db-node-storage-size-in-gbs --node-storage-gbs

The local node storage to be allocated in GBs.

--db-servers

The list of DB servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--display-name

Display Name.

--domain

The domain name for the cloud VM cluster.

--gi-version

Oracle Grid Infrastructure (GI) software version.

--hostname

The hostname for the cloud VM cluster.

--is-local-backup-enabled --local-backup-enabled

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: False
--is-sparse-diskgroup-enabled --sparse-diskgroup

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: False
--license-model

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Accepted values: BringYourOwnLicense, LicenseIncluded
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--memory-size-in-gbs

The memory to be allocated in GBs.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--nsg-cidrs

CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ocpu-count

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

--scan-listener-port-tcp

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

--scan-listener-port-tcp-ssl --scan-tcps-port

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

--ssh-public-keys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subnet-id

Client subnet.

--system-version

Operating system version of the image.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--time-zone

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

--vnet-id

VNET for network connectivity.

--zone-id

The OCID of the zone the cloud VM cluster is associated with.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster delete

Delete a CloudVmCluster.

az oracle-database cloud-vm-cluster delete [--cloudvmclustername]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete VM Cluster

az oracle-database cloud-vm-cluster delete --name <name> --resource-group <resource group>

Optional Parameters

--cloudvmclustername --name -n

CloudVmCluster name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster list

List CloudVmCluster resources by subscription ID.

az oracle-database cloud-vm-cluster list [--max-items]
                                         [--next-token]
                                         [--resource-group]

Examples

List Vm Clusters

az oracle-database cloud-vm-cluster list --resource-group <resource group>

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster remove-vm

Remove VMs from the VM Cluster.

az oracle-database cloud-vm-cluster remove-vm --db-servers
                                              [--cloudvmclustername]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]

Examples

Remove VM from Cluster

az oracle-database cloud-vm-cluster remove-vm --cloudvmclustername <vmclustername> --resource-group <Resource group> --db-servers ['ocid1','ocid2']

Required Parameters

--db-servers

Db servers ocids Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--cloudvmclustername

CloudVmCluster name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster show

Get a CloudVmCluster.

az oracle-database cloud-vm-cluster show [--cloudvmclustername]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

Get a VM Cluster

az oracle-database cloud-vm-cluster show --cloudvmclustername <vmclustername> --resource-group <Resource group>

Optional Parameters

--cloudvmclustername --name -n

CloudVmCluster name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster update

Update a CloudVmCluster.

az oracle-database cloud-vm-cluster update [--add]
                                           [--cloudvmclustername]
                                           [--collection-options]
                                           [--compute-nodes]
                                           [--cpu-core-count]
                                           [--data-storage-size-in-tbs]
                                           [--db-node-storage-size-in-gbs]
                                           [--display-name]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--license-model {BringYourOwnLicense, LicenseIncluded}]
                                           [--memory-size-in-gbs]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ocpu-count]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--ssh-public-keys]
                                           [--storage-size-in-gbs]
                                           [--subscription]
                                           [--tags]

Examples

Update VM Cluster

az oracle-database cloud-vm-cluster update --cloudvmclustername <vmclustername> --resource-group <Resource group> --tags {tagv1:tagk1}

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--cloudvmclustername --name -n

CloudVmCluster name.

--collection-options --data-collection-options

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--compute-nodes

The list of compute servers to be added to the cloud VM cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cpu-core-count

The number of CPU cores enabled on the cloud VM cluster.

--data-storage-size-in-tbs --storage-tbs

The data disk group size to be allocated in TBs.

--db-node-storage-size-in-gbs --node-storage-gbs

The local node storage to be allocated in GBs.

--display-name

Display Name.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--license-model

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Accepted values: BringYourOwnLicense, LicenseIncluded
--memory-size-in-gbs

The memory to be allocated in GBs.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ocpu-count

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--ssh-public-keys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--storage-size-in-gbs

The data disk group size to be allocated in GBs per VM.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az oracle-database cloud-vm-cluster wait

Place the CLI in a waiting state until a condition is met.

az oracle-database cloud-vm-cluster wait [--cloudvmclustername]
                                         [--created]
                                         [--custom]
                                         [--deleted]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

Optional Parameters

--cloudvmclustername --name -n

CloudVmCluster name.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.