NSX-T Data Center REST API

Endpoint (type)

{
  "description": "An Endpoint object is part of HostSwitch configuration in TransportNode",
  "id": "Endpoint",
  "module_id": "TransportNode",
  "properties": {
    "default_gateway": {
      "$ref": "IPAddress",
      "readonly": true,
      "title": "Gateway IP"
    },
    "device_name": {
      "readonly": true,
      "title": "Name of the virtual tunnel endpoint",
      "type": "string"
    },
    "ip": {
      "$ref": "IPAddress",
      "description": "Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.",
      "readonly": true,
      "title": "IP Address of this virtual tunnel endpoint"
    },
    "ipv6": {
      "$ref": "IPv6EndPoint",
      "readonly": true,
      "required": false,
      "title": "IPv6 endpoint"
    },
    "label": {
      "readonly": true,
      "required": false,
      "title": "Unique label for this Endpoint",
      "type": "int"
    },
    "mac": {
      "$ref": "MACAddress",
      "readonly": true,
      "title": "MAC address"
    },
    "net_stack_instance_key": {
      "description": "This field captures the name of the netstack where the vtep was realized. It may change based on where the vmk is currently connected to and when the next TN realization happens.",
      "nsx_feature": "VcpVcenterVtepSupport",
      "readonly": true,
      "title": "Name of the netstack where the vtep was realized",
      "type": "string"
    },
    "subnet_mask": {
      "$ref": "IPAddress",
      "readonly": true,
      "title": "Subnet mask"
    }
  },
  "title": "Tunnel endpoint configuration",
  "type": "object"
}