NSX-T Data Center REST API

HostNode (type)

{
  "additionalProperties": false,
  "description": "Host node",
  "extends": {
    "$ref": "Node"
  },
  "id": "HostNode",
  "module_id": "FabricNode",
  "polymorphic-type-descriptor": {
    "type-identifier": "HostNode"
  },
  "properties": {
    "compute_collection_id": {
      "description": "Id of the compute collection to which discovered node belongs.",
      "readonly": true,
      "required": false,
      "title": "Compute collection id",
      "type": "string"
    },
    "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"
    },
    "discovered_node_id": {
      "description": "Id of discovered node which was converted to create this node",
      "readonly": true,
      "required": false,
      "title": "Discovered node id",
      "type": "string"
    },
    "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"
    },
    "dpu": {
      "description": "Specify list of DPU information.",
      "items": {
        "$ref": "DpuInfo"
      },
      "readonly": true,
      "required": false,
      "title": "List of DPU information",
      "type": "array"
    },
    "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"
    },
    "host_credential": {
      "$ref": "HostNodeLoginCredential",
      "description": "Login credentials for the host. It is mandatory to provide credentials while adding host to MP to create transport node.",
      "required": false,
      "title": "Host login credentials"
    },
    "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"
    },
    "maintenance_mode_state": {
      "description": "Indicates host node's maintenance mode state. The state is ENTERING when a task to put the host in maintenance-mode is in progress.",
      "enum": [
        "OFF",
        "ENTERING",
        "ON"
      ],
      "readonly": true,
      "required": false,
      "title": "Maintenance mode state",
      "type": "string"
    },
    "managed_by_server": {
      "description": "The id of the vCenter server managing the ESXi type HostNode",
      "readonly": true,
      "required": false,
      "title": "Id of vCenter server managing the HostNode",
      "type": "string"
    },
    "os_type": {
      "description": "Hypervisor type, for example ESXi",
      "enum": [
        "ESXI",
        "RHELSERVER",
        "WINDOWSSERVER",
        "RHELCONTAINER",
        "UBUNTUSERVER",
        "HYPERV",
        "CENTOSSERVER",
        "CENTOSCONTAINER",
        "SLESSERVER",
        "OELSERVER"
      ],
      "required": true,
      "title": "Hypervisor OS type",
      "type": "string"
    },
    "os_version": {
      "description": "Version of the hypervisor operating system",
      "required": false,
      "title": "Hypervisor OS version",
      "type": "string"
    },
    "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"
    },
    "windows_install_location": {
      "description": "Specify an installation folder to install the NSX kernel modules for Windows Server. By default, it is C:\\Program Files\\VMware\\NSX\\.",
      "required": false,
      "title": "Install location of Windows Server on baremetal being managed by NSX",
      "type": "string"
    }
  },
  "title": "Host node",
  "type": "object"
}