az vmware vm

  • Reference

Note

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

Commands to manage Virtual Machines.

Commands

Name Description Type Status
az vmware vm list

List of virtual machines in a private cloud cluster.

 Extension GA
az vmware vm restrict-movement

Enable or disable DRS-driven VM movement restriction.

 Extension GA
az vmware vm show

Get a virtual machine by id in a private cloud cluster.

 Extension GA

az vmware vm list

List of virtual machines in a private cloud cluster.

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

Examples

List of virtual machines.

az vmware vm list --resource-group group1 --private-cloud cloud1 --cluster-name cluster1

Required Parameters

--cluster-name

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

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 vm restrict-movement

Enable or disable DRS-driven VM movement restriction.

az vmware vm restrict-movement [--cluster-name]
                               [--ids]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--private-cloud]
                               [--resource-group]
                               [--restrict-movement {Disabled, Enabled}]
                               [--subscription]
                               [--virtual-machine]

Examples

Enable or disable DRS-driven VM movement restriction.

az vmware vm restrict-movement --resource-group group1 --private-cloud cloud1 --cluster-name cluster1 --virtual-machine vm-209 --restrict-movement Enabled

Optional Parameters

--cluster-name

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

--restrict-movement

Whether VM DRS-driven movement is restricted (enabled) or not (disabled).

accepted values: Disabled, Enabled
--subscription

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

--virtual-machine

Virtual Machine identifier.

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

Get a virtual machine by id in a private cloud cluster.

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

Examples

Get a virtual machine by ID.

az vmware vm show --resource-group group1 --private-cloud cloud1 --cluster-name cluster1 --virtual-machine vm-209

Optional Parameters

--cluster-name

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.

--name --virtual-machine -n

Virtual Machine identifier.

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