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:

{ "results": [ { "host_switch_spec": { "host_switches": [ { "host_switch_name": "DSwitch2", "host_switch_id": "50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6", "host_switch_type": "VDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "/infra/host-switch-profiles/b7b04576-a249-4842-b21d-59a65ae51ec5" } ], "uplinks": [ { "vds_uplink_name": "Uplink 1", "uplink_name": "uplink-1" }, { "vds_uplink_name": "Uplink 2", "uplink_name": "uplink-2" }, { "vds_uplink_name": "Uplink 3", "uplink_name": "uplink-3" }, { "vds_uplink_name": "Uplink 4", "uplink_name": "uplink-4" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "AssignedByDhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/f82d3923-ce47-419c-8f39-71ef39d47426", "transport_zone_profile_ids": [] }, { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/7cd1b7b6-f1c4-46a1-93a8-8b60ea95e673", "transport_zone_profile_ids": [] } ], "not_ready": false } ], "resource_type": "StandardHostSwitchSpec" }, "ignore_overridden_hosts": false, "resource_type": "PolicyHostTransportNodeProfile", "id": "b065cc94-f2c2-4a21-9fad-9ea86c185eae", "display_name": "tnp.2", "description": "tnp.7161ac0a-a9cd-4210-9035-910d0c408824:domain-c43", "path": "/infra/host-transport-node-profiles/b065cc94-f2c2-4a21-9fad-9ea86c185eae", "relative_path": "b065cc94-f2c2-4a21-9fad-9ea86c185eae", "parent_path": "/infra", "unique_id": "b065cc94-f2c2-4a21-9fad-9ea86c185eae", "realization_id": "b065cc94-f2c2-4a21-9fad-9ea86c185eae", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1643135860595, "_create_user": "system", "_last_modified_time": 1643135860595, "_last_modified_user": "system", "_protection": "NOT_PROTECTED", "_revision": 0 }, { "host_switch_spec": { "host_switches": [ { "host_switch_name": "nsxDefaultHostSwitch", "host_switch_id": "50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6", "host_switch_type": "VDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "/infra/host-switch-profiles/0a26d126-7116-11e5-9d70-feff819cdc9f" } ], "uplinks": [ { "vds_uplink_name": "Uplink 1", "uplink_name": "uplink-1" }, { "vds_uplink_name": "Uplink 2", "uplink_name": "uplink-2" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "AssignedByDhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/a95c914d-748d-497c-94ab-10d4647daeba", "transport_zone_profile_ids": [ { "resource_type": "BfdHealthMonitoringProfile", "profile_id": "/infra/transport-zone-profiles/52035bb3-ab02-4a08-9884-18631312e50a" } ] } ], "not_ready": false } ], "resource_type": "StandardHostSwitchSpec" }, "ignore_overridden_hosts": false, "resource_type": "PolicyHostTransportNodeProfile", "id": "54b6341e-952a-4253-8b38-66a0e4d5e9b9", "display_name": "transport-node-profile-demo", "description": "description for transport-node-profile-demo", "tags": [], "path": "/infra/host-transport-node-profiles/54b6341e-952a-4253-8b38-66a0e4d5e9b9", "relative_path": "54b6341e-952a-4253-8b38-66a0e4d5e9b9", "parent_path": "/infra", "unique_id": "54b6341e-952a-4253-8b38-66a0e4d5e9b9", "realization_id": "54b6341e-952a-4253-8b38-66a0e4d5e9b9", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1643144202008, "_create_user": "admin", "_last_modified_time": 1643144202008, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 2, "sort_by": "create_time", "sort_ascending": true }

List Host Transport Nodes

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

PolicyHostTransportNodeProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: