az scvmm vm nic

  • Reference

Note

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

Managing the NICs of Arc for SCVMM Virtual Machine.

Commands

Name Description Type Status
az scvmm vm nic add

Add a network interface card to a virtual machine.

 Extension GA
az scvmm vm nic delete

Delete NICs of a virtual machine.

 Extension GA
az scvmm vm nic list

Retrieve the list of NICs present in a VM.

 Extension GA
az scvmm vm nic show

Get the details of a NIC present in a VM.

 Extension GA
az scvmm vm nic update

Update a NIC of a VM.

 Extension GA
az scvmm vm nic wait

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

 Extension GA

az scvmm vm nic add

Add a network interface card to a virtual machine.

az scvmm vm nic add --name
                    --resource-group
                    --vm-name
                    [--ipv4-address-type {Dynamic, Static}]
                    [--ipv6-address-type {Dynamic, Static}]
                    [--mac-address]
                    [--mac-address-type {Dynamic, Static}]
                    [--network]
                    [--no-wait]

Examples

Add a NIC to a virtual machine

az scvmm vm nic add --subscription contoso-sub --resource-group contoso-rg --vm-name contoso-vm --name nic_1 --network contoso-vnet --ipv4-address-type Dynamic --mac-address-type Dynamic

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.

Optional Parameters

--ipv4-address-type

The allocation type of the ipv4 address.

Accepted values: Dynamic, Static
Default value: Dynamic
--ipv6-address-type

The allocation type of the ipv6 address.

Accepted values: Dynamic, Static
Default value: Dynamic
--mac-address

MAC address of the NIC.

--mac-address-type

The allocation type of the MAC address.

Accepted values: Dynamic, Static
Default value: Dynamic
--network

Name or Id of the virtual network.

--no-wait

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

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 scvmm vm nic delete

Delete NICs of a virtual machine.

az scvmm vm nic delete --nics
                       --resource-group
                       --vm-name
                       [--no-wait]
                       [--yes]

Examples

Delete NICs of a virtual machine

az scvmm vm nic delete --subscription contoso-sub --resource-group contoso-rg --vm-name contoso-vm --nics nic_1 nic_2

Required Parameters

--nics

Names of the 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.

Optional Parameters

--no-wait

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

Default value: False
--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 scvmm vm nic list

Retrieve the list of NICs present in a VM.

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

Examples

Retrieve the list of NICs present in a VM

az scvmm vm nic list --subscription contoso-sub --resource-group contoso-rg --vm-name contoso-vm

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

Get the details of a NIC present in a VM.

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

Examples

Get details of vm NIC

az scvmm vm nic show --subscription contoso-sub --resource-group contoso-rg --vm-name contoso-vm --name nic_1

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.

az scvmm vm nic update

Update a NIC of a VM.

az scvmm vm nic update --resource-group
                       --vm-name
                       [--disconnect {false, true}]
                       [--ipv4-address-type {Dynamic, Static}]
                       [--ipv6-address-type {Dynamic, Static}]
                       [--mac-address-type {Dynamic, Static}]
                       [--name]
                       [--network]
                       [--nic-id]
                       [--no-wait]

Examples

Update a NIC of a VM

az scvmm vm nic update --subscription contoso-sub --resource-group contoso-rg --vm-name contoso-vm --name nic_1 --network contoso-vnet --ipv4-address-type Dynamic --mac-address-type Dynamic

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.

Optional Parameters

--disconnect

Disconnect the NIC from any virtual network it is connected to.

Accepted values: false, true
Default value: False
--ipv4-address-type

The allocation type of the ipv4 address.

Accepted values: Dynamic, Static
--ipv6-address-type

The allocation type of the ipv6 address.

Accepted values: Dynamic, Static
--mac-address-type

The allocation type of the MAC address.

Accepted values: Dynamic, Static
--name -n

Name of the NIC.

--network

Name or Id of the virtual network.

--nic-id

UUID of the NIC.

--no-wait

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

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 scvmm vm nic wait

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

az scvmm vm nic wait --resource-group
                     --virtual-machine-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Required Parameters

--resource-group -g

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

--virtual-machine-name

Name of the VirtualMachine.

Optional Parameters

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

Polling interval in seconds.

Default value: 30
--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.