NSX-T Data Center REST API

Get the subnet within an IP block

Returns information about the subnet with specified id within a given
IP address block. Information includes display_name, description, cidr and
allocation_ranges.

Request:

Method:

GET

URI Path(s):

/api/v1/pools/ip-subnets/<subnet-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/pools/ip-subnets /4a1c354d-bf7a-42ce-8e27-57e75e803fa0

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpBlockSubnet+

IpBlockSubnet (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
allocation_ranges	A collection of IPv4/IPv6 IP ranges used for IP allocation.	array of IpPoolRange	Readonly
block_id	Block id for which the subnet is created.	string	Required
cidr	Represents network address and the prefix length which will be associated with a layer-2 broadcast domain	string	Readonly Format: ip-cidr-block
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
resource_type	Must be set to the value IpBlockSubnet	string
size	Represents the size or number of ip addresses in the subnet	integer	Required
start_ip	Represents start ip address of the subnet For internal system use Only. Represents start ip address of the subnet from IP block. Subnet ip adddress will start from this ip address.	IPAddress
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "_revision": 0, "id": "4a1c354d-bf7a-42ce-8e27-57e75e803fa0", "display_name": "IPBlock-1-Subnet-1", "description": "IPBlock-1-Subnet-1 Description", "resource_type": "IpBlockSubnet", "cidr": "192.168.1.0/24", "allocation_ranges": [ { "start": "192.168.1.1", "end": "192.168.1.255" } ], "_last_modified_user": "admin", "_last_modified_time": 1514691880507, "_create_time": 1514691880507, "_create_user": "admin" }

NSX-T Data Center REST API

Get the subnet within an IP block

Request:

Example Request:

Successful Response:

IpBlockSubnet (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: