TransportNode (schema)

Transport Node

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