Share via

az csvmware vm nic

  • Preview
  • Reference

Note

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

Command group 'csvmware' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage VMware virtual machine's Network Interface Cards.

Commands

Name Description Type Status
az csvmware vm nic add

Add NIC to a VMware virtual machine.

 Extension Preview
az csvmware vm nic delete

Delete NICs from a VM.

 Extension Preview
az csvmware vm nic list

List details of NICs available on a VMware virtual machine.

 Extension Preview
az csvmware vm nic show

Get the details of a VMware virtual machine's NIC.

 Extension Preview

az csvmware vm nic add

Preview

Command group 'csvmware' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add NIC to a VMware virtual machine.

az csvmware vm nic add --resource-group
                       --virtual-network
                       --vm-name
                       [--adapter {E1000, E1000E, PCNET32, VMXNET, VMXNET2, VMXNET3}]
                       [--power-on-boot {false, true}]

Examples

Add a NIC with default parameters in a VM.

az csvmware vm nic add --vm-name MyVm -g MyResourceGroup --virtual-network MyVirtualNetwork

Add a NIC with E1000E adapter that powers on boot in a VM.

az csvmware vm nic add --vm-name MyVm -g MyResourceGroup --virtual-network MyVirtualNetwork --adapter E1000E --power-on-boot true

Required Parameters

--resource-group -g

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

--virtual-network

ID of the virtual network. You can also pass the basename of the ID.

--vm-name

Name of the virtual machine.

Optional Parameters

--adapter

The adapter for the NIC.

Accepted values: E1000, E1000E, PCNET32, VMXNET, VMXNET2, VMXNET3
Default value: VMXNET3
--power-on-boot

Will power on the NIC at boot time.

Accepted values: false, true
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 csvmware vm nic delete

Preview

Command group 'csvmware' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete NICs from a VM.

az csvmware vm nic delete --nics
                          --resource-group
                          --vm-name

Examples

Delete two NICs from a VM.

az csvmware vm nic delete --vm-name MyVm -g MyResourceGroup --nics "My NIC Name 1" "My NIC Name 2"

Required Parameters

--nics

Names of NICs.

--resource-group -g

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

--vm-name

Name of the virtual machine.

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 csvmware vm nic list

Preview

Command group 'csvmware' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List details of NICs available on a VMware virtual machine.

az csvmware vm nic list --resource-group
                        --vm-name

Examples

List details of NICs in a VM.

az csvmware vm nic list --vm-name MyVm -g MyResourceGroup

Required Parameters

--resource-group -g

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

--vm-name

Name of the virtual machine.

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

Preview

Command group 'csvmware' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a VMware virtual machine's NIC.

az csvmware vm nic show --name
                        --resource-group
                        --vm-name

Examples

Get the details of a NIC in a VM.

az csvmware vm nic show --vm-name MyVm -g MyResourceGroup -n "My NIC Name"

Required Parameters

--name -n

Name of the NIC.

--resource-group -g

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

--vm-name

Name of the virtual machine.

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.