List Host Transport Nodes

Returns information about all host transport node profiles.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/host-transport-node-profiles

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
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
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/host-transport-node-profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyHostTransportNodeProfileListResult+

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	PolicyHostTransportNodeProfile Results	array of PolicyHostTransportNodeProfile	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "displayName", "result_count": 2, "results": [ { "id": "849e339e-64b7-47cb-9480-33068f70dc5a", "display_name": "transport-node-profile-demo", "resource_type": "TransportNodeProfile", "host_switch_spec": { "resource_type": "StandardHostSwitchSpec", "host_switches": [ { "host_switch_profile_ids": [ { "value": "/infra/host-switch-profiles/e331116d-f59e-4004-8cfd-c577aefe563a", "key": "UplinkHostSwitchProfile" }, { "value": "/infra/host-switch-profiles/9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb", "key": "LldpHostSwitchProfile" } ], "host_switch_name": "nsxvswitch", "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink1" } ], "ip_assignment_spec": { "resource_type": "StaticIpPoolSpec", "ip_pool_id": "ecddcdde-4dc5-4026-ad4f-8857995d4c92" }, "vmk_install_migration": [ { "device_name": "vmk1", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" } ], "vmk_uninstall_migration": [ ], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/e14c6b8a-9edd-489f-b624-f9ef12afbd8f", "transport_zone_profile_ids": [ { "profile_id": "/infra/transport-zone-profiles/52035bb3-ab02-4a08-9884-18631312e50a", "resource_type": "BfdHealthMonitoringProfile" } ] } ] } ] }, "_revision": 0, "_create_time": 1415876516683, "_create_user": "admin", "_last_modified_user": "admin", "_last_modified_time": 1415876516683 }, { "id": "a601679e-4f0f-4d96-85c3-094e468ae60e", "display_name": "transport-node-profile-demo-2", "resource_type": "TransportNodeProfile", "host_switch_spec": { "resource_type": "StandardHostSwitchSpec", "host_switches": [ { "host_switch_profile_ids": [ { "value": "/infra/host-switch-profiles/e331116d-f59e-4004-8cfd-c577aefe563a", "key": "UplinkHostSwitchProfile" }, { "value": "/infra/host-switch-profiles/9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb", "key": "LldpHostSwitchProfile" } ], "host_switch_name": "nsxvswitch", "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink1" } ], "ip_assignment_spec": { "resource_type": "StaticIpPoolSpec", "ip_pool_id": "ecddcdde-4dc5-4026-ad4f-8857995d4c92" }, "vmk_install_migration": [ { "device_name": "vmk1", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" } ], "vmk_uninstall_migration": [ ], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/e14c6b8a-9edd-489f-b624-f9ef12afbd8f", "transport_zone_profile_ids": [ { "profile_id": "/infra/transport-zone-profiles/52035bb3-ab02-4a08-9884-18631312e50a", "resource_type": "BfdHealthMonitoringProfile" } ] } ] } ] }, "_revision": 0, "_create_time": 1415876516522, "_create_user": "admin", "_last_modified_user": "admin", "_last_modified_time": 1415876516522 } ] }

List Host Transport Nodes

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

PolicyHostTransportNodeProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: