NSX-T Data Center REST API

Update a DHCP IPv6 server's IP pool (Deprecated)

Update a specific ip pool of a given logical DHCP IPv6 server. Deprecated: Please use Policy API: PUT /policy/api/v1/infra/segments/{segment-id} { "display_name" : "segment-1", "subnets": [ { "gateway_address": "2019::200.1.0.1/128", "dhcp_ranges": [ "2019::200.1.0.0-2019::200.255.255.255" ], "dhcp_config": { "resource_type": "SegmentDhcpV6Config", "lease_time": 84600 }, "network": "2019::200.1.1.1/128" } ], "dhcp_config_path" : "/infra/dhcp-server-configs/dhcp-server-profile", "connectivity_path": "/infra/tier-1s/mgw", "_revision" : 0 }

Request:

Method:

PUT

URI Path(s):

/api/v1/dhcp/servers/{server-id}/ipv6-ip-pools/{pool-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

DhcpV6IpPool+

DhcpV6IpPool (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
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
dns_nameservers	DNS ips Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property.	array of IPv6Address	Minimum items: 0 Maximum items: 2
domain_names	Domain name Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property.	array of string
excluded_ranges	Excluded range of IPv6 addresses Excluded addresses to define dynamic ip allocation ranges.	array of IpPoolRange	Minimum items: 0 Maximum items: 128
id	Unique identifier of this resource	string	Sortable
lease_time	Lease time Lease time, in seconds.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
preferred_time	Preferred time Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.	integer	Minimum: 48 Maximum: 4294967295
ranges	Ip address ranges Ip address ranges to define dynamic ip allocation ranges.	array of IpPoolRange	Minimum items: 0 Maximum items: 128
resource_type	Must be set to the value DhcpV6IpPool	string
sntp_servers	SNTP server ips SNTP server ips.	array of IPv6Address	Minimum items: 0 Maximum items: 2
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "display_name" : "DHCP-ip-pool-3", "ranges" : [ { "start" : "2019::200.1.0.0", "end" : "2019::200.255.255.255" }], "_revision" : 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpV6IpPool+

DhcpV6IpPool (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
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
dns_nameservers	DNS ips Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property.	array of IPv6Address	Minimum items: 0 Maximum items: 2
domain_names	Domain name Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property.	array of string
excluded_ranges	Excluded range of IPv6 addresses Excluded addresses to define dynamic ip allocation ranges.	array of IpPoolRange	Minimum items: 0 Maximum items: 128
id	Unique identifier of this resource	string	Sortable
lease_time	Lease time Lease time, in seconds.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
preferred_time	Preferred time Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.	integer	Minimum: 48 Maximum: 4294967295
ranges	Ip address ranges Ip address ranges to define dynamic ip allocation ranges.	array of IpPoolRange	Minimum items: 0 Maximum items: 128
resource_type	Must be set to the value DhcpV6IpPool	string
sntp_servers	SNTP server ips SNTP server ips.	array of IPv6Address	Minimum items: 0 Maximum items: 2
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "DhcpIpPool", "id" : "1b6cb97f-ffa3-407c-b2ed-a9616feb95dd", "display_name" : "DHCP-ip-pool-3", "ranges" : [ { "start" : "2019::200.1.0.0", "end" : "2019::200.255.255.255" }], "_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