Share via

az vmware workload-network dhcp server

Note

This reference is part of the vmware extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az vmware workload-network dhcp server 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 server create

Create DHCP by ID in a private cloud workload network.

 Extension GA
az vmware workload-network dhcp server delete

Delete DHCP by ID in a private cloud workload network.

 Extension GA
az vmware workload-network dhcp server update

Update DHCP by ID in a private cloud workload network.

 Extension GA

az vmware workload-network dhcp server create

Create DHCP by ID in a private cloud workload network.

az vmware workload-network dhcp server create --dhcp --name
                                              --private-cloud
                                              --resource-group
                                              [--display-name]
                                              [--lease-time]
                                              [--revision]
                                              [--server-address]

Examples

Create DHCP by ID in a workload network.

az vmware workload-network dhcp server create --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-address 40.1.5.1/24 --lease-time 86400

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--display-name

Display name of the DHCP entity.

Property Value
Parameter group: Properties Arguments
--lease-time

DHCP Server Lease Time.

--revision

NSX revision number.

Property Value
Parameter group: Properties Arguments
--server-address

DHCP Server Address.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az vmware workload-network dhcp server delete

Delete DHCP by ID in a private cloud workload network.

az vmware workload-network dhcp server delete [--dhcp --name]
                                              [--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 server delete --resource-group group1 --private-cloud cloud1 --dhcp dhcp1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--dhcp --name -n

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

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az vmware workload-network dhcp server update

Update DHCP by ID in a private cloud workload network.

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

Examples

Update DHCP by ID in a workload network.

az vmware workload-network dhcp server update --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-address 40.1.5.1/24 --lease-time 86400

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--dhcp --name -n

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

Property Value
Parameter group: Resource Id Arguments
--display-name

Display name of the DHCP entity.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--lease-time

DHCP Server Lease Time.

--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--revision

NSX revision number.

Property Value
Parameter group: Properties Arguments
--server-address

DHCP Server Address.

--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False