Create Transport Node With Deployment Info

Transport nodes are hypervisor hosts and NSX Edges that will participate in an NSX-T overlay. For a hypervisor host, this means that it hosts VMs that will communicate over NSX-T logical switches. For NSX Edges, this means that it will have logical router uplinks and downlinks.

This API creates transport node for a host node (hypervisor) or edge node (router) in the transport network.

When you run this command for a host, NSX Manager attempts to install the NSX kernel modules, which are packaged as VIB, RPM, or DEB files. For the installation to succeed, you must provide the host login credentials and the host thumbprint.

To get the ESXi host thumbprint, SSH to the host and run the openssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha256 -noout command.

To generate host key thumbprint using SHA-256 algorithm please follow the steps below.

Log into the host, making sure that the connection is not vulnerable to a man in the middle attack. Check whether a public key already exists. Host public key is generally located at '/etc/ssh/ssh_host_rsa_key.pub'. If the key is not present then generate a new key by running the following command and follow the instructions.

ssh-keygen -t rsa

Now generate a SHA256 hash of the key using the following command. Please make sure to pass the appropriate file name if the public key is stored with a different file name other than the default 'id_rsa.pub'.

awk '{print $2}' id_rsa.pub | base64 -d | sha256sum -b | sed 's/ .*$//' | xxd -r -p | base64

Additional documentation on creating a transport node can be found in the NSX-T Installation Guide.

In order for the transport node to forward packets, the host_switch_spec property must be specified.

Host switches (called bridges in OVS on KVM hypervisors) are the individual switches within the host virtual switch. Virtual machines are connected to the host switches.

When creating a transport node, you need to specify if the host switches are already manually preconfigured on the node, or if NSX should create and manage the host switches. You specify this choice by the type of host switches you pass in the host_switch_spec property of the TransportNode request payload.

For a KVM host, you can preconfigure the host switch, or you can have NSX Manager perform the configuration. For an ESXi host or NSX Edge node, NSX Manager always configures the host switch.

To preconfigure the host switches on a KVM host, pass an array of PreconfiguredHostSwitchSpec objects that describes those host switches. In the current NSX-T release, only one prefonfigured host switch can be specified. See the PreconfiguredHostSwitchSpec schema definition for documentation on the properties that must be provided. Preconfigured host switches are only supported on KVM hosts, not on ESXi hosts or NSX Edge nodes.

To allow NSX to manage the host switch configuration on KVM hosts, ESXi hosts, or NSX Edge nodes, pass an array of StandardHostSwitchSpec objects in the host_switch_spec property, and NSX will automatically create host switches with the properties you provide. In the current NSX-T release, up to 16 host switches can be automatically managed. See the StandardHostSwitchSpec schema definition for documentation on the properties that must be provided.

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] & [2] show old/existing client request and response by populating transport_zone_endpoints property at TransportNode level. Example [3] shows TransportNode creation request/response by populating transport_zone_endpoints property at StandardHostSwitch level and other new properties.

The node_id field is marked as deprecated and to convert the edge node into transport node use the below PUT API https://<nsx-mgr>/api/v1/transport-nodes/.

If the host node (hypervisor) or edge node (router) is already added in system then it can be converted to transport node by providing node_id in request.

If host node (hypervisor) or edge node (router) is not already present in system then information should be provided under node_deployment_info.

Request

URI

POST

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

COPY

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

201

Created

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