HostNode (schema)

Host node

Host node
Name Description Type Notes
compute_collection_id Compute collection id

Id of the compute collection to which discovered node belongs.
string Readonly
description Description of this resource

This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
string Deprecated
Maximum length: 1024
Sortable
discovered_ip_addresses Discovered IP Addresses of the fabric node, version 4 or 6 array of IPAddress Readonly
discovered_node_id Discovered node id

Id of discovered node which was converted to create this node
string Readonly
display_name Identifier to use when displaying entity in logs or GUI

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 Deprecated
Maximum length: 255
Sortable
dpu List of DPU information

Specify list of DPU information.
array of DpuInfo Readonly
external_id ID of the Node maintained on the Node and used to recognize the Node string
fqdn Fully qualified domain name of the fabric node string Readonly
host_credential Host login credentials

Login credentials for the host. It is mandatory to provide
credentials while adding host to MP to create transport node.
HostNodeLoginCredential
id Unique identifier of this resource

Unique identifier of this resource.
string Sortable
ip_addresses IP Addresses of the Node, version 4 or 6

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.
array of IPAddress
maintenance_mode_state Maintenance mode state

Indicates host node's maintenance mode state. The state is ENTERING
when a task to put the host in maintenance-mode is in progress.
string Readonly
Enum: OFF, ENTERING, ON
managed_by_server Id of vCenter server managing the HostNode

The id of the vCenter server managing the ESXi type HostNode
string Readonly
os_type Hypervisor OS type

Hypervisor type, for example ESXi or RHEL Container
string Required
Enum: ESXI, RHELSERVER, WINDOWSSERVER, RHELCONTAINER, UBUNTUSERVER, HYPERV, CENTOSSERVER, CENTOSCONTAINER, SLESSERVER, OELSERVER
os_version Hypervisor OS version

Version of the hypervisor operating system
string
resource_type Must be set to the value HostNode string Required
tags Opaque identifiers meaningful to the API user

This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
array of Tag Deprecated
Maximum items: 30
windows_install_location Install location of Windows Server on baremetal being managed by NSX

Specify an installation folder to install the NSX kernel modules for Windows Server. By default, it is C:\Program Files\VMware\NSX\.
string