az vmware cluster

Note

This reference is part of the vmware extension for the Azure CLI (version 2.70.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 host	Commands to list and show host resources.	Extension	GA
az vmware cluster host list	List hosts in a cluster.	Extension	GA
az vmware cluster host show	Get a host by name in a 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 --name
                         --private-cloud
                         --resource-group
                         --sku
                         [--cluster-size --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.

Property	Value
Parameter group:	Sku Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-size --size

The cluster size.

Property	Value
Parameter group:	Properties Arguments

--hosts

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--vsan-datastore-name

Name of the vsan datastore associated with the cluster.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --name]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--private-cloud]
                         [--resource-group]
                         [--subscription]
                         [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

Name of the cluster in the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --name]
                             [--ids]
                             [--private-cloud]
                             [--resource-group]
                             [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

Name of the cluster in the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --name]
                       [--ids]
                       [--private-cloud]
                       [--resource-group]
                       [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

Name of the cluster in the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --name]
                         [--cluster-size --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--cluster-name --name -n

Name of the cluster in the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--cluster-size --size

The cluster size.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--vsan-datastore-name

Name of the vsan datastore associated with the cluster.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az vmware cluster wait

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

Name of the cluster in the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--private-cloud -c

Name of the private cloud.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az vmware cluster

Commands

az vmware cluster create

Required Parameters

Optional Parameters

az vmware cluster delete

Optional Parameters

az vmware cluster list

Required Parameters

Optional Parameters

az vmware cluster list-zones

Optional Parameters

az vmware cluster show

Optional Parameters

az vmware cluster update

Optional Parameters

az vmware cluster wait

Optional Parameters

Feedback