NSX-T Data Center REST API

List Hostswitch Profiles

Returns information about the configured hostswitch profiles. Hostswitch
profiles define networking policies for hostswitches (sometimes referred to
as bridges in OVS). Currently, following profiles are supported.
UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile.
Uplink profile - teaming defined in this profile allows NSX to load balance traffic across
different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are
supported, including LACP active, LACP passive, load balancing based on source ID, and
failover order.
Lldp profile - Activate or deactivate sending LLDP packets
NiocProfile - Network I/O Control settings: defines limits, shares and reservations for
various host traffic types.
ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/host-switch-profiles
Request Headers:
n/a
Query Parameters:
PolicyHostSwitchProfileListRequestParameters+
Request Body:
n/a

Example Request:

hostswitch_profile_type=PolicyUplinkHostSwitchProfile& include_system_owned=true& node_type=EdgeNode& deployment_type=VIRTUAL_MACHINE& max_active_uplink_count=2

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PolicyHostSwitchProfilesListResult+

Example Response:

{ "TODO" : "Add all 4 profile examples" "results" : [ { "lags": [ { "name": "lag1", "id": "7535", "mode": "ACTIVE", "load_balance_algorithm": "SRCMAC", "number_of_uplinks": 2, "uplinks": [ { "uplink_name": "lag1-0", "uplink_type": "PNIC" }, { "uplink_name": "lag1-1", "uplink_type": "PNIC" } ], "timeout_type": "FAST" } ], "teaming": { "policy": "LOADBALANCE_SRC_MAC", "active_list": [ { "uplink_name": "lag1", "uplink_type": "LAG" } ] }, "transport_vlan": 19, "overlay_encap": "GENEVE", "resource_type": "PolicyUplinkHostSwitchProfile", "id": "uplinkProfile1", "display_name": "Custom-uplinkProfile1", "path": "/infra/host-switch-profiles/uplinkProfile1", "relative_path": "uplinkProfile1", "parent_path": "/infra", "unique_id": "0a72be13-046f-4872-97a3-785841b9df28", "marked_for_delete": false, "overridden": false, "_create_user": "unknown", "_create_time": 1612465522414, "_last_modified_user": "unknown", "_last_modified_time": 1612465522414, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "send_enabled": true, "resource_type": "LldpHostSwitchProfile", "id": "lldpProfile1", "display_name": "Custom-lldpProfile1", "path": "/infra/host-switch-profiles/lldpProfile1", "relative_path": "lldpProfile1", "parent_path": "/infra", "unique_id": "b84d93ce-43e1-4930-8e74-bef8ad1c8f18", "marked_for_delete": false, "overridden": false, "_create_user": "unknown", "_create_time": 1612464678118, "_last_modified_user": "unknown", "_last_modified_time": 1612464678118, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "host_infra_traffic_res": [ { "traffic_type": { "traffic_name": "FAULT_TOLERANCE" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "HBR" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "ISCSI" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "MANAGEMENT" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "NFS" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "VDP" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "VIRTUAL_MACHINE" }, "limit": -1.0, "shares": 100, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "VMOTION" }, "limit": -1.0, "shares": 50, "reservation": 0.0 }, { "traffic_type": { "traffic_name": "VSAN" }, "limit": -1.0, "shares": 50, "reservation": 0.0 } ], "enabled": true, "resource_type": "NiocProfile", "id": "niocProfile1", "display_name": "Custom-niocProfile1", "path": "/infra/host-switch-profiles/niocProfile1", "relative_path": "niocProfile1", "parent_path": "/infra", "unique_id": "32ea1c6a-96c8-466b-ac51-3486efdbf153", "marked_for_delete": false, "overridden": false, "_create_user": "unknown", "_create_time": 1612468369585, "_last_modified_user": "unknown", "_last_modified_time": 1612468369585, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "extra_configs": [ { "config_pair": { "key": "sampleKey", "value": "sampleValue" } } ], "resource_type": "ExtraConfigHostSwitchProfile", "id": "extraConfigProfile1", "display_name": "Custom-extraConfigProfile1", "path": "/infra/host-switch-profiles/extraConfigProfile1", "relative_path": "extraConfigProfile1", "parent_path": "/infra", "unique_id": "609673e1-a33f-4aef-ad0d-48e39715df4b", "marked_for_delete": false, "overridden": false, "_create_user": "unknown", "_create_time": 1612410420180, "_last_modified_user": "unknown", "_last_modified_time": 1612410420180, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 4, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

profiles_host_switch_profiles

Additional Errors: