[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create Or Replace DHCP Server Config

Description

If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, replace the DHCP server config instance with this object. Realized entities of this API can be found using the path of Tier-0 that this config is applied on.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
Copy

Path Parameters

Path Parameters

string
dhcp-server-config-id Required

DHCP server config ID


Request Body

Request Body

DhcpServerConfig of type(s) application/json Required
This request body class requires all of the following: PolicyConfigResource, InlineDhcpServerConfig1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DhcpServerConfig of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineDhcpServerConfig1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$DhcpServerConfig = Initialize-DhcpServerConfig -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -EdgeClusterPath "MyEdgeClusterPath" -EnableStandbyRelocation $false -LeaseTime 0 -PreferredEdgePaths "MyPreferredEdgePaths" -ServerAddress "MyServerAddress" -ServerAddresses "MyServerAddresses"
Invoke-CreateOrReplaceDhcpServerConfig -dhcpServerConfigId "MydhcpServerConfigId" -dhcpServerConfig $dhcpServerConfig

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-or-replace-dhcp-server-config
x-vmw-nsx-module: PolicyConnectivity


Feedback

Was this page helpful?