Create Transport Node

Enables a fabric node to act as a transport node. A fabric node is a node that contains host switches. Any node can serve as a transport node if it contains a vswitch. Such nodes include but are not limited to hypervisor hosts. Host switches (also known as bridges in OVS) are the individual switches within the vswitch. Virtual machines are connected to the host switches. A transport node is a node that is capable of participating in an NSX overlay or NSX VLAN networking. The required parameter to create a transport node is the node_id. A node ID is created when you add a host with the POST fabric/nodes API or when you register a node with the NSX Manager (using the register-node CLI command). Some of the optional parameters are host_switches, transport_zone_endpoints, and static_ip_pool_id. The transport_zone_endpoints parameter is an array of host switches and their associated transport zones. Each transport zone has one designated host switch to handle traffic. The static-ip-pool_id is the UUID of an IP pool. When a virtual machine is hosted on a hypervisor that is serving as a transport node, and when you connect the virtual machine's network adapter to an NSX logical switch, the resulting virtual tunnel endpoint (VTEP) IP address is assigned from the IP pool specified in the static_ip_pool_id parameter. Before you can use these configuration parameters in the POST transport-nodes API, you must gather the following UUIDs: fabric host or fabric edge node, IP pool, host switch profile (also known as an uplink profile), and transport zone.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/transport-nodes

COPY

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

201

Resource created successfully

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

Request Body

Authentication

Response

201 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