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, only uplink teaming is supported. Uplink
teaming 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.

Request:

Method:

GET

URI Path(s):

/api/v1/host-switch-profiles

Request Headers:

n/a

Query Parameters:

HostSwitchProfileListParameters+

HostSwitchProfileListParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
deployment_type	Deployment type of EdgeNode or PublicCloudGatewayNode If the node_type is specified, then deployment_type may be specified to filter uplink profiles applicable to only PHYSICAL_MACHINE or VIRTUAL_MACHINE deployments of these nodes.	EdgeDeploymentType
hostswitch_profile_type	Type of host switch profile	HostSwitchProfileType
include_system_owned	Whether the list result contains system resources	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
node_type	Fabric node type for which uplink profiles are to be listed The fabric node type is the resource_type of the Node such as EdgeNode and PublicCloudGatewayNode. If a fabric node type is given, uplink profiles that apply for nodes of the given type will be returned.	string	Enum: EdgeNode, PublicCloudGatewayNode
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
uplink_teaming_policy_name	The host switch profile's uplink teaming policy name If populated, only UplinkHostSwitchProfiles with the specified uplink teaming policy name are returned. Otherwise, any HostSwitchProfile can be returned.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/host-switch-profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

HostSwitchProfilesListResult+

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	HostSwitch Profile Results	array of BaseHostSwitchProfile (Abstract type: pass one of the following concrete types) ExtraConfigHostSwitchProfile LldpHostSwitchProfile NiocProfile UplinkHostSwitchProfile	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:

{ "result_count" : 2, "results" : [ { "resource_type" : "LldpHostSwitchProfile", "id" : "9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb", "display_name" : "LLDP [Send Packet Disabled]", "resource_type" : "LldpHostSwitchProfile", "send_enabled" : false, "_last_modified_user" : "system", "_last_modified_time" : 1433451663106, "_create_time" : 1433451663106, "_system_owned" : true, "_create_user" : "system", "_revision" : 0 }, { "resource_type" : "UplinkHostSwitchProfile", "id" : "4228a9e1-982c-4753-b386-44b9e3b42ca0", "display_name" : "uplinkProfile1", "resource_type" : "UplinkHostSwitchProfile", "mtu" : 1600, "teaming" : { "standby_list" : [ { "uplink_name" : "uplink2", "uplink_type" : "PNIC" } ], "active_list" : [ { "uplink_name" : "uplink1", "uplink_type" : "PNIC" } ], "policy" : "FAILOVER_ORDER" }, "transport_vlan" : 0, "_last_modified_user" : "admin", "_last_modified_time" : 1433452542652, "_create_time" : 1433452542652, "_create_user" : "admin", "_revision" : 0 } ] }

List Hostswitch Profiles

Request:

HostSwitchProfileListParameters (schema)

Example Request:

Successful Response:

HostSwitchProfilesListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: