NSX-T Data Center REST API

Node (type)

{
  "id": "Node", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "description": {
      "can_sort": true, 
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'display_name' must be used instead. For HostNode, this field defaults to ID if not set. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "description": "Unique identifier of this resource.", 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "deprecated": true, 
      "description": "This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.", 
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}