EdgeNodeSettings

EdgeNodeSettings
EdgeNodeSettings

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

JSON Example
{
    "advanced_configuration": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "allow_ssh_root_login": false,
    "dns_servers": [
        "string"
    ],
    "enable_ssh": false,
    "enable_upt_mode": false,
    "hostname": "string",
    "ntp_servers": [
        "string"
    ],
    "search_domains": [
        "string"
    ],
    "syslog_servers": [
        {
            "facility": [
                "string"
            ],
            "log_level": "string",
            "message_id": [
                "string"
            ],
            "name": "string",
            "port": "string",
            "protocol": "string",
            "server": "string",
            "structured_data": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ]
}
advanced_configuration
Optional

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

boolean
allow_ssh_root_login
Optional

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.

array of string
dns_servers
Optional

List of DNS servers.

boolean
enable_ssh
Optional

Enabling SSH service is not recommended for security reasons.

boolean
enable_upt_mode
Optional

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.

string As /^(?=.{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])?)*?$/
hostname
Required

Host name or FQDN for edge node.

array of string
ntp_servers
Optional

List of NTP servers.

array of string
search_domains
Optional

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

syslog_servers
Optional
Constraints: maxItems: 5

List of Syslog server configuration.