NSX-T Data Center REST API

Returns the state of the public cloud routing tables from a VPN point of view.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/vpn/routing-tables/state

Request Headers:

n/a

Query Parameters:

VpnRoutingTablesStateListRequestParameters+

VpnRoutingTablesStateListRequestParameters (schema)

Name	Description	Type	Notes
account_id	Identifier for account based on which routing tables are to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
managed_for_vpn	Flag to identify whether the routing table is actually managed by NSX for VPN	boolean
network_id	Identifier for a network based on which the list is to be filtered	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
reason_for_not_managed	Reason why a routing table is not being managed for VPN	string	Enum: RT_CONTAINS_MGMT_SUBNET, RT_CONTAINS_UPLINK_SUBNET, RT_CONTAINS_MGMT_UPLINK_SUBNET, NONSELECTED
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/vpn/routing-tables/state

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VpnRoutingTableStateListResult+

VpnRoutingTableStateListResult (schema)

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Public Cloud Routing State Tables Set of public cloud routing tables and their state	array of VpnRoutingTableState	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "0008236", "sort_ascending": true, "result_count": 3, "resource_type": "VpnRoutingTableStateListResult", "results": [ { "id" : "rtb-fa00d882", "managed_for_vpn" : true }, { "id" : "rtb-9f7b06e7", "managed_for_vpn" : false, "reason_for_not_managed" : "RT_CONTAINS_UPLINK_SUBNET" }, { "id" : "rtb-ac08dcd4", "managed_for_vpn" : false, "reason_for_not_managed" : "UNSELECTED" } ], "_last_modified_user": "admin", "_last_modified_time": 1435284879143, "_create_time": 1435284566908, "_create_user": "admin", "_revision": 1 }

Required Permissions:

read

Feature:

cloud_resources

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable