Share via

az vmware cluster

  • Reference

Note

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

Commands to manage all the clusters in a private cloud, excluding the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.

Commands

Name Description Type Status
az vmware cluster create

Create a cluster in a private cloud.

 Extension GA
az vmware cluster delete

Delete a cluster in a private cloud, excluding the first cluster which is the default management cluster.

 Extension GA
az vmware cluster list

List clusters in a private cloud, excluding the first cluster which is the default management cluster.

 Extension GA
az vmware cluster list-zones

List hosts by zone in a cluster in a private cloud, including the first cluster which is the default management cluster.

 Extension GA
az vmware cluster show

Get a cluster by name in a private cloud, excluding the first cluster which is the default management cluster.

 Extension GA
az vmware cluster update

Update a cluster in a private cloud, excluding the first cluster which is the default management cluster.

 Extension GA
az vmware cluster wait

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

 Extension GA

az vmware cluster create

Create a cluster in a private cloud.

The maximum number of clusters is 4.

az vmware cluster create --cluster-name
                         --private-cloud
                         --resource-group
                         --sku
                         [--cluster-size]
                         [--hosts]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--vsan-datastore-name]

Required Parameters

--cluster-name --name -n

Name of the cluster in the private cloud.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

--sku

The name of the SKU. E.g. P3. It is typically a letter+number code.

Optional Parameters

--cluster-size --size

The cluster size.

--hosts

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--vsan-datastore-name

Name of the vsan datastore associated with the cluster.

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 vmware cluster delete

Delete a cluster in a private cloud, excluding the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.

az vmware cluster delete [--cluster-name]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--private-cloud]
                         [--resource-group]
                         [--subscription]
                         [--yes]

Optional Parameters

--cluster-name --name -n

Name of the cluster in the private cloud.

--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
--private-cloud -c

Name of the private cloud.

--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 vmware cluster list

List clusters in a private cloud, excluding the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.

az vmware cluster list --private-cloud
                       --resource-group
                       [--max-items]
                       [--next-token]

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

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.

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 vmware cluster list-zones

List hosts by zone in a cluster in a private cloud, including the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud.

az vmware cluster list-zones [--cluster-name]
                             [--ids]
                             [--private-cloud]
                             [--resource-group]
                             [--subscription]

Optional Parameters

--cluster-name --name -n

Name of the cluster in the private cloud.

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

--private-cloud -c

Name of the private cloud.

--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 vmware cluster show

Get a cluster by name in a private cloud, excluding the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.

az vmware cluster show [--cluster-name]
                       [--ids]
                       [--private-cloud]
                       [--resource-group]
                       [--subscription]

Optional Parameters

--cluster-name --name -n

Name of the cluster in the private cloud.

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

--private-cloud -c

Name of the private cloud.

--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 vmware cluster update

Update a cluster in a private cloud, excluding the first cluster which is the default management cluster.

The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.

az vmware cluster update [--add]
                         [--cluster-name]
                         [--cluster-size]
                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                         [--hosts]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--private-cloud]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--subscription]
                         [--vsan-datastore-name]

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

--cluster-name --name -n

Name of the cluster in the private cloud.

--cluster-size --size

The cluster size.

--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
--hosts

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

--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
--private-cloud -c

Name of the private cloud.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--subscription

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

--vsan-datastore-name

Name of the vsan datastore associated with the cluster.

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 vmware cluster wait

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

az vmware cluster wait [--cluster-name]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--private-cloud]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

Optional Parameters

--cluster-name --name -n

Name of the cluster in the private cloud.

--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
--private-cloud -c

Name of the private cloud.

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