Node

Node
Node
JSON Example
{
    "description": "string",
    "discovered_ip_addresses": [
        "string"
    ],
    "display_name": "string",
    "external_id": "string",
    "fqdn": "string",
    "id": "string",
    "ip_addresses": [
        "string"
    ],
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}
string
description
Optional
Constraints: maxLength: 1024

This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.

array of string
discovered_ip_addresses
Optional

Discovered IP Addresses of the fabric node, version 4 or 6

string
display_name
Optional
Constraints: maxLength: 255

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.

string
external_id
Optional

ID of the Node maintained on the Node and used to recognize the Node

string
fqdn
Optional

Fully qualified domain name of the fabric node

string
id
Optional

Unique identifier of this resource.

array of string
ip_addresses
Optional

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.

string
resource_type
Required

Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'

array of Tag
tags
Optional
Constraints: maxItems: 30

This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.