System Administration >
Configuration
>
Fabric
>
Pool Management
>
IP Pools
Delete an IP Pool
Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass "force=true" as query param to force delete the IpPool
Request:
Method:
DELETE
URI Path(s):
/api/v1/pools/ip-pools/{pool-id}
Request Headers:
n/a
Query Parameters:
IpPoolDeleteRequestParameters
+
IpPoolDeleteRequestParameters
(
schema
)
Name
Description
Type
Notes
force
Force delete the resource even if it is being used somewhere
If true, deleting the resource succeeds even if it is being
referred as a resource reference.
boolean
Default: "False"
Request Body:
n/a
Example Request:
DELETE https://<nsx-mgr>/api/v1/pools/ip-pools/4b1c354d-bf7a-42ce-8e27-57e75e803fa8 DELETE https://<nsx-mgr>/api/v1/pools/ip-pools/4b1c354d-bf7a-42ce-8e27-57e75e803fa8?force=true
Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a
Required Permissions:
crud
Feature:
groups_ip_pools
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable