Share via

az vmware workload-network dhcp relay

  • 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 workload-network dhcp relay command. Learn more about extensions.

Commands to manage a DHCP (Data Host Configuration Protocol) workload network.

Commands

Name Description Type Status
az vmware workload-network dhcp relay create

Create DHCP by ID in a private cloud workload network.

 Extension GA
az vmware workload-network dhcp relay delete

Delete DHCP by ID in a private cloud workload network.

 Extension GA
az vmware workload-network dhcp relay update

Create DHCP by ID in a private cloud workload network.

 Extension GA

az vmware workload-network dhcp relay create

Create DHCP by ID in a private cloud workload network.

az vmware workload-network dhcp relay create --dhcp
                                             --private-cloud
                                             --resource-group
                                             [--display-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--revision]
                                             [--server-addresses]

Examples

Create DHCP by ID in a workload network.

az vmware workload-network dhcp relay create --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-addresses 40.1.5.1/24

Required Parameters

--dhcp --name -n

NSX DHCP identifier. Generally the same as the DHCP display name.

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

--display-name

Display name of the DHCP entity.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--revision

NSX revision number.

--server-addresses

DHCP Relay Addresses. Max 3. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 workload-network dhcp relay delete

Delete DHCP by ID in a private cloud workload network.

az vmware workload-network dhcp relay delete [--dhcp]
                                             [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--private-cloud]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

Examples

Delete DHCP by ID in a workload network.

az vmware workload-network dhcp relay delete --resource-group group1 --private-cloud cloud1 --dhcp dhcp1

Optional Parameters

--dhcp --name -n

NSX DHCP identifier. Generally the same as the DHCP display name.

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

--subscription

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

--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 vmware workload-network dhcp relay update

Create DHCP by ID in a private cloud workload network.

az vmware workload-network dhcp relay update [--add]
                                             [--dhcp]
                                             [--display-name]
                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--private-cloud]
                                             [--remove]
                                             [--resource-group]
                                             [--revision]
                                             [--server-addresses]
                                             [--set]
                                             [--subscription]

Examples

Update DHCP by ID in a workload network.

az vmware workload-network dhcp relay update --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-addresses 40.1.5.1/24

Optional Parameters

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

--dhcp --name -n

NSX DHCP identifier. Generally the same as the DHCP display name.

--display-name

Display name of the DHCP entity.

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--remove

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

--resource-group -g

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

--revision

NSX revision number.

--server-addresses

DHCP Relay Addresses. Max 3. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

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