List Switching Profiles

Returns information about the system-default and user-configured switching profiles. Each switching profile has a unique ID, a display name, and various other read-only and configurable properties. The default switching profiles are assigned automatically to each switch.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/switching-profiles

COPY

Query Parameters

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

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)

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

switching_profile_type

Optional

comma-separated list of switching profile types, e.g. ?switching_profile_type=QosSwitchingProfile,PortMirroringSwitchingProfile

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns SwitchingProfilesListResult of type(s) application/json

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

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

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure