List Host Switch 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

URI

GET

https://nsxmanager.your.domain/api/v1/host-switch-profiles

COPY

Query Parameters

string

hostswitch_profile_type

Optional

Supported HostSwitch profiles.

Possible values are : UplinkHostSwitchProfile, LldpHostSwitchProfile,

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

sort_by

Optional

Field by which records are sorted

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

include_system_owned

Optional

Whether the list result contains system resources

boolean

sort_ascending

Optional

sort_ascending

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns HostSwitchProfilesListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineHostSwitchProfilesListResult1

{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "required_capabilities": [
                "string"
            ],
            "_revision": 0,
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_schema": "string",
            "_create_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "resource_type": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "_create_user": "string"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Network Transport Operations

POST

Create Bridge Cluster

POST

Create Bridge Endpoint

POST

Create Cluster Profile

POST

Create Edge Cluster

POST

Create Host Switch Profile

POST

Create Transport Node

POST

Create Transport Zone

POST

Create Transport Zone Profile

DELETE

Delete Bridge Cluster

DELETE

Delete Bridge Endpoint

DELETE

Delete Cluster Profile

DELETE

Delete Edge Cluster

DELETE

Delete Host Switch Profile

DELETE

Delete Transport Node