{
"additionalProperties": false,
"description": "Host node",
"extends": {
"$ref": "Node
},
"id": "HostNode",
"module_id": "FabricNode",
"polymorphic-type-descriptor": {
"type-identifier": "HostNode"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"description": {
"can_sort": true,
"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,
"description": "Defaults to ID if not set",
"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"
},
"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,
"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 or RHEL KVM",
"enum": [
"ESXI",
"RHELKVM",
"RHELSERVER",
"WINDOWSSERVER",
"RHELCONTAINER",
"UBUNTUKVM",
"UBUNTUSERVER",
"HYPERV",
"CENTOSKVM",
"CENTOSSERVER",
"CENTOSCONTAINER",
"SLESKVM",
"SLESSERVER"
],
"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": {
"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"
}