NSX-T Data Center REST API

Update a DHCP server's IP pool (Deprecated)

Update a specific ip pool of a given logical DHCP server.

Request:

Method:

PUT

URI Path(s):

/api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

DhcpIpPool+

DhcpIpPool (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_ranges	Ip-ranges Ip-ranges to define dynamic ip allocation ranges.	array of IpPoolRange	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
error_threshold	Error threshold, valid [80-100], default 100 Error threshold. Alert will be raised if the pool usage reaches the given threshold.	integer	Minimum: 80 Maximum: 100 Default: "100"
gateway_ip	Gateway ip Gateway ip address of the allocation.	IPAddress
id	Unique identifier of this resource	string	Sortable
lease_time	Lease time Lease time, in seconds, [60-(2^32-1)]. Default is 86400.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
options	DHCP options If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level.	DhcpOptions
resource_type	Must be set to the value DhcpIpPool	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
warning_threshold	Warning threshold, valid [50-80], default 80 Warning threshold. Alert will be raised if the pool usage reaches the given threshold.	integer	Minimum: 50 Maximum: 80 Default: "80"

Example Request:

PUT /api/v1/dhcp/servers/d7f425da-25d2-4e5e-ae9e-ea112375971d/ip-pools/1b6cb97f-ffa3-407c-b2ed-a9616feb95dd { "display_name" : "DHCP-ip-pool-3", "gateway_ip" : "192.168.150.1", "allocation_ranges" : [ { "start" : "192.168.150.100", "end" : "192.168.150.200" } ], "_revision" : 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpIpPool+

DhcpIpPool (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_ranges	Ip-ranges Ip-ranges to define dynamic ip allocation ranges.	array of IpPoolRange	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
error_threshold	Error threshold, valid [80-100], default 100 Error threshold. Alert will be raised if the pool usage reaches the given threshold.	integer	Minimum: 80 Maximum: 100 Default: "100"
gateway_ip	Gateway ip Gateway ip address of the allocation.	IPAddress
id	Unique identifier of this resource	string	Sortable
lease_time	Lease time Lease time, in seconds, [60-(2^32-1)]. Default is 86400.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
options	DHCP options If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level.	DhcpOptions
resource_type	Must be set to the value DhcpIpPool	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
warning_threshold	Warning threshold, valid [50-80], default 80 Warning threshold. Alert will be raised if the pool usage reaches the given threshold.	integer	Minimum: 50 Maximum: 80 Default: "80"

Example Response:

{ "resource_type" : "DhcpIpPool", "id" : "1b6cb97f-ffa3-407c-b2ed-a9616feb95dd", "display_name" : "DHCP-ip-pool-3", "lease_time" : 86400, "gateway_ip" : "192.168.150.1", "allocation_ranges" : [ { "start" : "192.168.150.100", "end" : "192.168.150.200" } ], "error_threshold" : 100, "warning_threshold" : 80, "_last_modified_user" : "admin", "_last_modified_time" : 1478306403854, "_revision" : 1 }

Required Permissions:

crud

Feature:

dhcp_servers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable