Update an IP Pool

Modifies the specified IP address pool. Modifiable parameters include the
description, display_name, and all subnet information.

Request:

Method:

PUT

URI Path(s):

/api/v1/pools/ip-pools/{pool-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IpPool+

IpPool (schema)

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
check_overlap_with_existing_pools	Specifies whether to perform overlap check with existing IP pools If true, a validation error will be thrown if another IP pool is found to be overlapping with this pool. The flag is false by default.	boolean	Default: "False"
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
id	Unique identifier of this resource	string	Sortable
ip_release_delay	IP address release delay in milliseconds Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).	integer
pool_usage	Pool usage statistics	PoolUsage	Readonly
resource_type	Must be set to the value IpPool	string
subnets	The collection of one or more subnet objects in a pool Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.	array of IpPoolSubnet	Maximum items: 5
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/pools/ip-pools/4b1c354d-bf7a-42ce-8e27-57e75e803fa8 { "_revision": 1, "display_name": "ipv4-pool1", "description": "ipv4-pool", "resource_type": "IpPool", "subnets": [ { "dns_nameservers": [ "192.1.1.2" ], "allocation_ranges": [ { "start": "192.168.1.1", "end": "192.168.1.20" }, { "start": "192.168.1.21", "end": "192.168.1.40" } ], "gateway_ip": "192.168.1.254", "cidr": "192.168.1.0/24" } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpPool+

IpPool (schema)

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
check_overlap_with_existing_pools	Specifies whether to perform overlap check with existing IP pools If true, a validation error will be thrown if another IP pool is found to be overlapping with this pool. The flag is false by default.	boolean	Default: "False"
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
id	Unique identifier of this resource	string	Sortable
ip_release_delay	IP address release delay in milliseconds Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).	integer
pool_usage	Pool usage statistics	PoolUsage	Readonly
resource_type	Must be set to the value IpPool	string
subnets	The collection of one or more subnet objects in a pool Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.	array of IpPoolSubnet	Maximum items: 5
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "_revision": 2, "id": "4b1c354d-bf7a-42ce-8e27-57e75e803fa8", "display_name": "ipv4-pool1", "description": "ipv4-pool", "resource_type": "IpPool", "subnets": [ { "dns_nameservers": [ "192.1.1.2" ], "allocation_ranges": [ { "start": "192.168.1.1", "end": "192.168.1.20" }, { "start": "192.168.1.21", "end": "192.168.1.40" } ], "gateway_ip": "192.168.1.254", "cidr": "192.168.1.0/24" } ], "_last_modified_user": "admin", "_last_modified_time": 1414692290422, "_create_time": 1414692027913, "_create_user": "admin" }

Update an IP Pool

Request:

IpPool (schema)

Example Request:

Successful Response:

IpPool (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: