list_ip_pools
Retrieve all IP address pools with subnet details and usage summaries to manage network resources in VMware NSX environments.
Instructions
List all IP address pools with subnets and usage summary.
Args: target: Optional NSX Manager target name from config. Uses default if omitted.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| target | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- vmware_nsx/ops/networking.py:214-228 (handler)The implementation of the list_ip_pools tool, which queries the NSX Policy API to list IP pools and sanitizes the output.
def list_ip_pools(client: NsxClient) -> list[dict]: """List all IP pools. Returns: List of IP pool dicts with id, display_name, and usage summary. """ items = client.get_all("/policy/api/v1/infra/ip-pools") return [ { "id": _sanitize(p.get("id", "")), "display_name": _sanitize(p.get("display_name", "")), "pool_usage": p.get("pool_usage", {}), } for p in items ]