az vmware cluster

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the vmware extension for the Azure CLI (version 2.11.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 clusters in a private cloud.

Commands

az vmware cluster create	Create a cluster in a private cloud. The maximum number of clusters is 4.
az vmware cluster delete	Delete a cluster in a private cloud.
az vmware cluster list	List clusters in a private cloud.
az vmware cluster show	Show details of a cluster in a private cloud.
az vmware cluster update	Update a cluster in a private cloud.

az vmware cluster create

Create a cluster in a private cloud. The maximum number of clusters is 4.

az vmware cluster create --hosts
                         --name
                         --private-cloud
                         --resource-group
                         --size
                         --sku

Required Parameters

--hosts

A cluster's hosts in the private cloud.

--name -n

Name of the cluster.

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

--size

Number of hosts for the cluster. Minimum of 3 and a maximum of 16.

--sku

The product SKU.

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.

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

az vmware cluster delete --name
                         --private-cloud
                         --resource-group
                         [--yes]

Required Parameters

--name -n

Name of the cluster.

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

--yes

Delete without confirmation.

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.

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

az vmware cluster list --private-cloud
                       --resource-group

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

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.

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

Show details of a cluster in a private cloud.

az vmware cluster show --name
                       --private-cloud
                       --resource-group

Required Parameters

--name -n

Name of the cluster.

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

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.

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

az vmware cluster update --name
                         --private-cloud
                         --resource-group
                         [--hosts]
                         [--size]

Required Parameters

--name -n

Name of the cluster.

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

--hosts

A cluster's hosts in the private cloud.

--size

Number of hosts for the cluster. Minimum of 3 and a maximum of 16.

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.

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