[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Get NSX-T IP Address Pool

Description

Get a NSX-T IP address pool

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{nsxt-cluster-id}/ip-address-pools/{name}
Copy

Path Parameters

Path Parameters

string
nsxt-cluster-id Required

NSX-T cluster ID


string
name Required

IP address pool name


Response

Response

Response Body

Response Body

200 OK returns NsxtIpAddressPool of type(s) application/json
{
	"availableIpAddresses": 0,
	"blockSubnets": [
		{
			"cidr": "string",
			"gatewayAssigned": false,
			"size": 0
		}
	],
	"description": "string",
	"name": "string",
	"staticSubnets": [
		{
			"cidr": "string",
			"gateway": "string",
			"ipAddressPoolRanges": [
				{
					"end": "string",
					"start": "string"
				}
			]
		}
	],
	"totalIpAddresses": 0
}
integer as int32
availableIpAddresses Optional

The number of IP addresses available in the IP address pool


blockSubnets Optional

The list of IP address pool block subnets


string
description Optional

Description of the IP address pool


string
name Optional

Name of the IP address pool


staticSubnets Optional

The list of IP address pool static subnets


integer as int32
totalIpAddresses Optional

The total number of IP addresses in the IP address pool

Errors

Errors

404

IP address pool not found


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{nsxt-cluster-id}/ip-address-pools/{name}


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?