EdgeNodeSettings (schema)

The settings are used during deployment and consequent update of an edge,
unless indicated otherwise.
These settings are editable for manually deployed edge nodes as well.
If using DHCP, you must leave the following fields unset: search_domains,
management_port_subnets, dns_servers and default_gateway_addresses.
EdgeNodeSettings reports current values configured on the edge node.
If the settings lag with actual state on the edge,
these may be refreshed at NSX Manager using API POST api/v1/transport-nodes
/<transport-node-id>?action=refresh_node_configuration&resource_type=
EdgeNode

Name Description Type Notes

advanced_configuration Advanced configuration

Array of additional specific properties for advanced or cloud-
specific deployments in key-value format.
array of KeyValuePair

allow_ssh_root_login Allow root SSH logins.

Allowing root SSH logins is not recommended for security reasons.
Edit of this property is not supported when updating transport node.
Use the CLI to change this property.
boolean Default: "False"

dns_servers DNS servers.

List of DNS servers.
array of IPAddress

enable_ssh Enable SSH.

Enabling SSH service is not recommended for security reasons.
boolean Default: "False"

enable_upt_mode Enable Uniform Passthrough mode.

Enable Uniform Passthrough ( UPT ) on VMXNET 3 devices to improve
overall system performance and reduces latency.
Caution: This involves restart of the edge
dataplane and hence may lead to network disruption.
Use GET api/v1/transport-nodes//state
to monitor realization of UPT.
boolean Default: "False"

hostname Host name or FQDN for edge node. string Required
Pattern: "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*?$"

ntp_servers NTP servers.

List of NTP servers.
array of HostnameOrIPv4Address

search_domains Search domain names.

List of domain names that are used to complete unqualified host names.
array of string

syslog_servers Syslog servers

List of Syslog server configuration.
array of SyslogConfiguration Maximum items: 5

Name	Description	Type	Notes
advanced_configuration	Advanced configuration Array of additional specific properties for advanced or cloud- specific deployments in key-value format.	array of KeyValuePair
allow_ssh_root_login	Allow root SSH logins. Allowing root SSH logins is not recommended for security reasons. Edit of this property is not supported when updating transport node. Use the CLI to change this property.	boolean	Default: "False"
dns_servers	DNS servers. List of DNS servers.	array of IPAddress
enable_ssh	Enable SSH. Enabling SSH service is not recommended for security reasons.	boolean	Default: "False"
enable_upt_mode	Enable Uniform Passthrough mode. Enable Uniform Passthrough ( UPT ) on VMXNET 3 devices to improve overall system performance and reduces latency. Caution: This involves restart of the edge dataplane and hence may lead to network disruption. Use GET api/v1/transport-nodes//state to monitor realization of UPT.	boolean	Default: "False"
hostname	Host name or FQDN for edge node.	string	Required Pattern: "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]\|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]\|-){0,61}[0-9A-Za-z])?)*?$"
ntp_servers	NTP servers. List of NTP servers.	array of HostnameOrIPv4Address
search_domains	Search domain names. List of domain names that are used to complete unqualified host names.	array of string
syslog_servers	Syslog servers List of Syslog server configuration.	array of SyslogConfiguration	Maximum items: 5