Update Transport Node

Modifies the transport node information. Modifiable parameters include the host_switches and transport_zone_endpoints. The host_switch_name field must match the host_switch_name value specified in the transport zone (API: transport-zones). You must create the associated uplink profile (API: host-switch-profiles) before you can specify an uplink_name here. If the host is an ESX and has only one physical NIC being used by a vSphere standard switch, TransportNodeUpdateParameters should be used to migrate the management interface and the physical NIC into a logical switch that is in a transport zone this tranport node will join or has already joined. If the migration is already done, TransportNodeUpdateParameters can also be used to migrate the management interface and the physical NIC back to a vSphere standard switch. In other cases, the TransportNodeUpdateParameters should NOT be used.

Request

URI

PUT

https://nsxmanager.your.domain/api/v1/transport-nodes/{transportnode-id}

COPY

Path Parameters

string

transportnode-id

Required

transportnode-id

Query Parameters

string

esx_mgmt_if_migration_dest

Optional

The ID of the network to which the management interface on ESX will be migrated. Only logical switch UUID or vSphere Standard Switch portgroup name is supported.

string

if_id

Optional

The ID (for example, vmk0) of the management interface on ESX to migrate.

Request Body

TransportNode of type(s) application/json

Optional

This request body class requires all of the following: ManagedResource , InlineTransportNode1

{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "host_switches": [
        {
            "pnics": [
                {
                    "uplink_name": "string",
                    "device_name": "string"
                }
            ],
            "host_switch_name": "string",
            "static_ip_pool_id": "string",
            "host_switch_profile_ids": [
                {
                    "value": "string",
                    "key": "string"
                }
            ]
        }
    ],
    "host_switch_spec": {
        "resource_type": "string"
    },
    "node_id": "string",
    "transport_zone_endpoints": [
        {
            "transport_zone_id": "string",
            "transport_zone_profile_ids": [
                {
                    "profile_id": "string",
                    "resource_type": "string"
                }
            ]
        }
    ]
}

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns TransportNode of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineTransportNode1

{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "host_switches": [
        {
            "pnics": [
                {
                    "uplink_name": "string",
                    "device_name": "string"
                }
            ],
            "host_switch_name": "string",
            "static_ip_pool_id": "string",
            "host_switch_profile_ids": [
                {
                    "value": "string",
                    "key": "string"
                }
            ]
        }
    ],
    "host_switch_spec": {
        "resource_type": "string"
    },
    "node_id": "string",
    "transport_zone_endpoints": [
        {
            "transport_zone_id": "string",
            "transport_zone_profile_ids": [
                {
                    "profile_id": "string",
                    "resource_type": "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

Path Parameters

Query Parameters

Request Body

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