Update Transport Node With Deployment Info

Modifies the transport node information. 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 transport 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. When updating transport node you should follow pattern where you should fetch the existing transport node and then only modify the required properties keeping other properties as is.

It also modifies attributes of node (host or edge).

Note: Previous versions of NSX-T also used a property named transport_zone_endpoints at TransportNode level. This property is deprecated which creates some combinations of new client along with old client payloads. Examples [1] shows old/existing client request and response by populating transport_zone_endpoints property at TransportNode level. Example [2] shows TransportNode updating TransportNode from exmaple [1] request/response by adding a new StandardHostSwitch by populating transport_zone_endpoints at StandardHostSwitch level. TransportNode level transport_zone_endpoints will ONLY have TransportZoneEndpoints that were originally specified here during create/update operation and does not include TransportZoneEndpoints that were directly specified at StandardHostSwitch level.

If api response is 200 OK, user will have to wait for config to get realised, and realisation of the intent can be tracked using /api/v1/transport-nodes//state API.

Request

URI

PUT

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

COPY

Path Parameters

string

transport-node-id

Required

transport-node-id

Query Parameters

string

esx_mgmt_if_migration_dest

Optional

The network ids to which the ESX vmk interfaces will be migrated

string

if_id

Optional

The ESX vmk interfaces to migrate

boolean

override_nsx_ownership

Optional

Constraints: default: false

Override NSX Ownership

string

ping_ip

Optional

IP Addresses to ping right after ESX vmk interfaces were migrated.

boolean

skip_validation

Optional

Constraints: default: false

Whether to skip front-end validation for vmk/vnic/pnic migration

string

vnic

Optional

The ESX vmk interfaces and/or VM NIC to migrate

string

vnic_migration_dest

Optional

The migration destinations of ESX vmk interfaces and/or VM NIC

Request Body

TransportNode of type(s) application/json

Optional

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "_revision": 0,
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_protection": "string",
    "_system_owned": false,
    "description": "string",
    "display_name": "string",
    "id": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "failure_domain_id": "string",
    "host_switch_spec": {
        "resource_type": "string"
    },
    "is_overridden": false,
    "maintenance_mode": "string",
    "node_deployment_info": {
        "description": "string",
        "discovered_ip_addresses": [
            "string"
        ],
        "display_name": "string",
        "external_id": "string",
        "fqdn": "string",
        "id": "string",
        "ip_addresses": [
            "string"
        ],
        "resource_type": "string",
        "tags": [
            {
                "scope": "string",
                "tag": "string"
            }
        ]
    },
    "node_id": "string",
    "remote_tunnel_endpoint": {
        "host_switch_name": "string",
        "ip_assignment_spec": {
            "resource_type": "string"
        },
        "named_teaming_policy": "string",
        "rtep_vlan": 0
    }
}

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns TransportNode of type(s) application/json

This response body class contains all of the following: InlineTransportNode1

"TransportNode Object"

400

Returns BadRequest of type(s) application/json