NSX-T Data Center REST API

EdgeNodeSettings (type)

{
  "additionalProperties": false,
  "description": "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",
  "id": "EdgeNodeSettings",
  "module_id": "FabricNode",
  "properties": {
    "advanced_configuration": {
      "description": "Array of additional specific properties for advanced or cloud- specific deployments in key-value format.",
      "items": {
        "$ref": "KeyValuePair"
      },
      "readonly": false,
      "required": false,
      "title": "Advanced configuration",
      "type": "array"
    },
    "allow_ssh_root_login": {
      "default": false,
      "description": "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.",
      "required": false,
      "title": "Allow root SSH logins.",
      "type": "boolean"
    },
    "core_allocation_profile": {
      "$ref": "CoreAllocationProfile",
      "description": "This attribute enables the creation of an edge transport node using a core allocation profile, with the understanding that the edge is initially outside the cluster and must be added later. For redeployment and update operations: If the edge transport node is already part of a cluster, the core allocation profile defined at the edge cluster level will be applied to that node. The API will throw a validation error if the cluster-level and node-level core allocation profile values are not identical.",
      "nsx_feature": "ConfigureEdgeCoreAllocationProfiles",
      "required": false,
      "title": "Core Allocation Profile"
    },
    "dns_servers": {
      "description": "List of DNS servers.",
      "items": {
        "$ref": "IPAddress"
      },
      "required": false,
      "title": "DNS servers.",
      "type": "array"
    },
    "enable_ssh": {
      "default": false,
      "description": "Enabling SSH service is not recommended for security reasons.",
      "required": false,
      "title": "Enable SSH.",
      "type": "boolean"
    },
    "enable_upt_mode": {
      "default": false,
      "description": "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/<transport-node-id>/state to monitor realization of UPT.",
      "readonly": false,
      "required": false,
      "title": "Enable Uniform Passthrough mode.",
      "type": "boolean"
    },
    "hostname": {
      "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])?)*?$",
      "required": true,
      "title": "Host name or FQDN for edge node.",
      "type": "string"
    },
    "ntp_servers": {
      "description": "List of NTP servers.",
      "items": {
        "$ref": "HostnameOrIPAddress"
      },
      "required": false,
      "title": "NTP servers.",
      "type": "array"
    },
    "search_domains": {
      "description": "List of domain names that are used to complete unqualified host names.",
      "items": {
        "type": "string"
      },
      "required": false,
      "title": "Search domain names.",
      "type": "array"
    },
    "syslog_servers": {
      "description": "List of Syslog server configuration.",
      "items": {
        "$ref": "SyslogConfiguration"
      },
      "maxItems": 5,
      "required": false,
      "title": "Syslog servers",
      "type": "array"
    }
  },
  "type": "object"
}