Get Switching Profile

Get Switching Profile

Returns information about a specified switching profile.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/switching-profiles/{switching-profile-id}
COPY
Path Parameters
string
switching-profile-id
Required

switching-profile-id

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns BaseSwitchingProfile of type(s) application/json 
{
    "_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"
}
SelfResourceLink
_self
Optional

_self

boolean
_system_owned
Optional

Indicates system owned resource

string
display_name
Optional

Defaults to ID if not set

string
description
Optional

description

array of string
required_capabilities
Optional

required_capabilities

integer As int64 As int64
_revision
Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

array of Tag
tags
Optional

tags

string
_schema
Optional

_schema

integer As int64 As int64
_create_time
Optional

Timestamp of resource creation

array of ResourceLink
_links
Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

string
resource_type
Required

resource_type

integer As int64 As int64
_last_modified_time
Optional

Timestamp of last modification

string
_last_modified_user
Optional

ID of the user who last modified this resource

string
id
Optional

id

string
_create_user
Optional

ID of the user who created this resource


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
Logical Switching Operations
POST
Create Logical Port
POST
Create Logical Switch
POST
Create Switching Profile
DELETE
Delete Logical Port
DELETE
Delete Logical Switch
DELETE
Delete Switching Profile
GET
Get Logical Port
GET
Get Logical Port Operational Status
GET
Get Logical Port State
GET
Get Logical Port Statistics
GET
Get Logical Port Status Summary
GET
Get Logical Switch
GET
Get Logical Switch Mac Table
GET
Get Logical Switch Mac Table In Csv Format
GET
Get Logical Switch State
GET
Get Logical Switch Statistics
GET
Get Logical Switch Status
GET
Get Logical Switch Status Summary
GET
Get Logical Switch Vtep Table
GET
Get Logical Switch Vtep Table In Csv Format
GET
Get Switching Profile
GET
Get Switching Profile Status
GET
List Logical Ports
GET
List Logical Switches
GET
List Logical Switches By State
GET
List Switching Profiles
PUT
Update Logical Port
PUT
Update Logical Switch
PUT
Update Switching Profile