System Administration > Configuration > Fabric > Nodes > Fabric Nodes
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| allocation_list | Allocation list List of logical router ids to which this edge node is allocated. |
array of string | Readonly |
| deployment_config | Config for automatic deployment of edge node virtual machine. When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE will be deployed and registered with MP. |
EdgeNodeDeploymentConfig | |
| deployment_type | EdgeDeploymentType | Readonly | |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| discovered_ip_addresses | Discovered IP Addresses of the fabric node, version 4 or 6 | array of IPAddress | Readonly |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| 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 |
| id | 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 | |
| node_settings | Current configuration on edge node. Reports the current configuration of the SSH, DHS, NTP and host name on this edge node. The deployment_config property is used during deployment and this counterpart property shows current values. |
EdgeNodeSettings | |
| resource_type | Must be set to the value EdgeNode | string | Required |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| description | Description of this resource | string | 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 Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| 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 | 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 KVM |
string | Required Enum: ESXI, RHELKVM, RHELSERVER, WINDOWSSERVER, RHELCONTAINER, UBUNTUKVM, UBUNTUSERVER, HYPERV, CENTOSKVM, CENTOSSERVER, CENTOSCONTAINER, SLESKVM, SLESSERVER |
| 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 | array of Tag | 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 |
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| discovered_ip_addresses | Discovered IP Addresses of the fabric node, version 4 or 6 | array of IPAddress | Readonly |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| 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 |
| id | 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 | |
| resource_type | Must be set to the value Node | string | Required |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| allocation_list | Allocation list List of logical router ids to which this edge node is allocated. |
array of string | Readonly |
| deployment_config | Config for automatic deployment of edge node virtual machine. When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE will be deployed and registered with MP. |
EdgeNodeDeploymentConfig | |
| deployment_type | EdgeDeploymentType | Readonly | |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| discovered_ip_addresses | Discovered IP Addresses of the fabric node, version 4 or 6 | array of IPAddress | Readonly |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| 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 |
| id | 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 | |
| node_settings | Current configuration on edge node. Reports the current configuration of the SSH, DHS, NTP and host name on this edge node. The deployment_config property is used during deployment and this counterpart property shows current values. |
EdgeNodeSettings | |
| resource_type | Must be set to the value PublicCloudGatewayNode | string | Required |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |