create_ip_pool
Create an IP address pool with a static subnet and allocation range for NSX tunnel endpoints. Provide pool ID, display name, start/end IP, and CIDR.
Instructions
[WRITE] Create an IP address pool with one static subnet and allocation range.
IP pools supply addresses to NSX consumers such as tunnel endpoints (TEPs). Check list_ip_pools first to avoid overlapping ranges; start_ip and end_ip must both fall inside cidr. Re-running with the same pool_id overwrites it (PUT semantics). Returns the created pool dict; verify consumption later with get_ip_pool_usage. On failure returns {"error", "hint"}. Recorded in the audit log (~/.vmware/audit.db).
Args: pool_id: Unique pool identifier (alphanumerics, hyphens, underscores only); becomes policy path /infra/ip-pools/. display_name: Human-readable name shown in the NSX UI. start_ip: First allocatable IPv4 address, e.g. "192.168.1.10". end_ip: Last allocatable IPv4 address, e.g. "192.168.1.100". cidr: Subnet containing the range, in CIDR notation, e.g. "192.168.1.0/24". gateway_ip: Default gateway IP for the subnet, e.g. "192.168.1.1". Optional. target: NSX Manager name from config.yaml. Uses the default target if omitted.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cidr | Yes | ||
| end_ip | Yes | ||
| target | No | ||
| pool_id | Yes | ||
| start_ip | Yes | ||
| gateway_ip | No | ||
| display_name | Yes |