NSX-T Data Center REST API

Created Transport Node for Discovered Node

NSX components are installaed on host and transport node is created with given configurations.

Request:

Method:

POST

URI Path(s):

/api/v1/fabric/discovered-nodes/{node-ext-id}?action=create_transport_node

Request Headers:

n/a

Query Parameters:

ManagedObjectOwnershipRequestParameters+

ManagedObjectOwnershipRequestParameters (schema)

Name	Description	Type	Notes
override_nsx_ownership	Override NSX Ownership Flag indicating whether the NSX ownership constraints (on Managed Objects like Host/Cluster/DVS) should be overridden/bypassed. Note: Overriding/bypassing NSX ownership constraints is not recommended at all. This indicates, you want to use/configure/own certain Managed Objects (like Cluster, Host or DVS) which seem to be already in use/configured/owned by some other NSX instance. This option should be used with caution. It should only be used to come out of situations where: a. The other NSX instance no longer intends to use the Managed Objects (and has already unconfigured NSX configurations) but the ownership still lies with it (incorrectly) and you want those Managed Objects to be used/configured/owned by this NSX instance. b. The other NSX instance has crashed or decommisioned but the ownership still lies with it and you want those Managed Objects to be used/configured/owned by this NSX instance. Enabling this option, while the Managed Objects affected by this operation are actively used by other NSX, can lead to problematic states on both the NSX instances. For example, if a TN is forcefully reconfigured by this NSX instance (using override_nsx_ownership=true), while it was already configured and in use by the other NSX instance, it could corrupt the HostSwitch configurations pushed down by the other NSX instance.	boolean	Default: "False"

Request Body:

TransportNode+

TransportNode (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
failure_domain_id	Id of the failure domain Set failure domain of edge transport node which will help in auto placement of TIER1 logical routers, DHCP Servers and MDProxies, if failure domain based allocation is enabled in edge cluster API. It is only supported for edge transport node and not for host transport node. In case failure domain is not set by user explicitly, it will be always assigned with default system created failure domain.	string
host_switch_spec	Transport node host switch specification This property is used to either create standard host switches or to inform NSX about preconfigured host switches that already exist on the transport node. Pass an array of either StandardHostSwitchSpec objects or PreconfiguredHostSwitchSpec objects. It is an error to pass an array containing different types of HostSwitchSpec objects.	HostSwitchSpec (Abstract type: pass one of the following concrete types) PreconfiguredHostSwitchSpec StandardHostSwitchSpec
id	Unique identifier of this resource	string	Sortable
is_overridden	Indicates if config is different than compute collection. This flag is relevant to only those hosts which are part of a compute collection which has transport node profile (TNP) applied on it. If you change the transport node configuration and it is different than cluster level TNP then this flag will be set to true	boolean	Readonly
maintenance_mode	transport node maintenance mode desired state The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call.	string	Readonly Enum: ENABLED, FORCE_ENABLED, DISABLED
node_deployment_info		Node (Abstract type: pass one of the following concrete types) EdgeNode HostNode Node PublicCloudGatewayNode
node_id	Unique Id of the fabric node	string	Deprecated Readonly
remote_tunnel_endpoint	Configuration for a remote tunnel endpoint This should be configured only on a single host switch. It is only supported for edge transport nodes and not for host transport nodes. This configuration will be used by overlay traffic that is meant to be sent between NSX intersite domains.	TransportNodeRemoteTunnelEndpointConfig
resource_type	Must be set to the value TransportNode	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/fabric/discovered-nodes/5c669dc6-47a8-4508-3077-6a48f26c5a4g?action=create_transport_node { "resource_type": "TransportNode", "description": "", "display_name":"TN2", "host_switch_spec":{ "resource_type":"StandardHostSwitchSpec", "host_switches":[ { "host_switch_name":"nsxvswitch", "host_switch_profile_ids":[ { "key":"UplinkHostSwitchProfile", "value":"0a26d126-7116-11e5-9d70-feff819cdc9f" } ], "pnics":[ { "device_name":"vmnic3", "uplink_name":"uplink-1" } ], "ip_assignment_spec":{ "resource_type":"AssignedByDhcp" } } ] }, "transport_zone_endpoints":[ { "transport_zone_id":"3ed51543-7fd4-4885-8fe8-55d8317b4777" } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNode+

TransportNode (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
failure_domain_id	Id of the failure domain Set failure domain of edge transport node which will help in auto placement of TIER1 logical routers, DHCP Servers and MDProxies, if failure domain based allocation is enabled in edge cluster API. It is only supported for edge transport node and not for host transport node. In case failure domain is not set by user explicitly, it will be always assigned with default system created failure domain.	string
host_switch_spec	Transport node host switch specification This property is used to either create standard host switches or to inform NSX about preconfigured host switches that already exist on the transport node. Pass an array of either StandardHostSwitchSpec objects or PreconfiguredHostSwitchSpec objects. It is an error to pass an array containing different types of HostSwitchSpec objects.	HostSwitchSpec (Abstract type: pass one of the following concrete types) PreconfiguredHostSwitchSpec StandardHostSwitchSpec
id	Unique identifier of this resource	string	Sortable
is_overridden	Indicates if config is different than compute collection. This flag is relevant to only those hosts which are part of a compute collection which has transport node profile (TNP) applied on it. If you change the transport node configuration and it is different than cluster level TNP then this flag will be set to true	boolean	Readonly
maintenance_mode	transport node maintenance mode desired state The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call.	string	Readonly Enum: ENABLED, FORCE_ENABLED, DISABLED
node_deployment_info		Node (Abstract type: pass one of the following concrete types) EdgeNode HostNode Node PublicCloudGatewayNode
node_id	Unique Id of the fabric node	string	Deprecated Readonly
remote_tunnel_endpoint	Configuration for a remote tunnel endpoint This should be configured only on a single host switch. It is only supported for edge transport nodes and not for host transport nodes. This configuration will be used by overlay traffic that is meant to be sent between NSX intersite domains.	TransportNodeRemoteTunnelEndpointConfig
resource_type	Must be set to the value TransportNode	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "TransportNode", "description": "Updated NSX configured Test Transport Node", "id": "77816de2-39c3-436c-b891-54d31f580961", "display_name": "NSX Configured TN", "host_switch_spec": { "resource_type": "StandardHostSwitchSpec", "host_switches": [ { "host_switch_profile_ids": [ { "value": "e331116d-f59e-4004-8cfd-c577aefe563a", "key": "UplinkHostSwitchProfile" }, { "value": "9e0b4d2d-d155-4b4b-8947-fbfe5b79f7cb", "key": "LldpHostSwitchProfile" } ], "host_switch_name": "nsxvswitch", "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink1" } ], "ip_assignment_spec": { "resource_type": "StaticIpPoolSpec", "ip_pool_id": "ecddcdde-4dc5-4026-ad4f-8857995d4c92" }, "vmknics": [ { "device_name": "vmk1", "logical_switch_id": "849e339e-64b7-47cb-9480-33068f70dc5a" } ] } ] }, "transport_zone_endpoints": [ { "transport_zone_id": "e14c6b8a-9edd-489f-b624-f9ef12afbd8f", "transport_zone_profile_ids": [] } ], "node_id": "41a4eebd-d6b9-11e6-b722-875041b9955d", "node_deployment_info": { "resource_type": "HostNode", "id": "41a4eebd-d6b9-11e6-b722-875041b9955d", "display_name": "FN1", "fqdn": "sc2-rdops-vm03-dhcp-110-133.eng.vmware.com", "ip_addresses": [ "10.192.156.199" ], "external_id": "a5113680-6a56-4386-9017-adffbe56c99e", "discovered_ip_addresses": [], "os_type": "ESXI", "os_version": "", "managed_by_server": "", "_create_time": 1538632396987, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_last_modified_time": 1538632396987, "_create_user": "admin", "_revision": 0 }, "_create_time": 1485299990773, "_last_modified_user": "admin", "_last_modified_time": 1485301913130, "_create_user": "admin", "_revision": 0 }

Required Permissions:

crud

Feature:

nodes_transport_nodes

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable