Read Cluster Node Configuration (Deprecated)

Returns information about the specified NSX cluster node.
Deprecated: Deprecated. Use GET /cluster/<node-id> to get cluster node configuration.

Request:

Method:

GET

URI Path(s):

/api/v1/cluster/nodes/{node-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/nodes/4206C988-8227-CEE9-D9AF-1C581AD84A03

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ClusterNodeConfig+

ClusterNodeConfig (schema)

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
appliance_mgmt_ipv6_listen_addr	The IPv6 address for the appliance management API service on this node	string	Readonly
appliance_mgmt_listen_addr	The IP and port for the appliance management API service on this node	string	Readonly
controller_role		ControllerClusterRoleConfig
description	Description of this resource	string	Maximum length: 1024 Sortable
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	Internal identifier provided by the node	string	Readonly
id	Unique identifier of this resource	string	Sortable
manager_role		ManagementClusterRoleConfig
resource_type	Must be set to the value ClusterNodeConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "ClusterNodeConfig", "id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "display_name": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "64b99fac51f5b8996b158fc8c18af8d9379f6faa9b127a933446c701df809d24", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-5d1212b4-6e1e-47d4-b9e7-2e38e018b8f2" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "e4c359bfb8f7ca827173effe52a726cf1df0209b7035a98a773a827a5b3365bd", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "7eda54d0dcee4463573f40b1869552f0e248dd47b9d6b47b727459b0ab0c40ba", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "appliance_connection_info" : { "ip_address" : "192.168.110.49", "port" : 1234, "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "certificate_sha256_thumbprint" : "b53e8e59ea8832d3afdc75a9baa68e73c29c199258c390474afe4fb11f821eec", "service_endpoint_uuid" : "4ed8b446-260a-44ad-9cb7-76b07350ac44", "entities_hosted" : [ { "entity_type" : "MP", "entity_uuid" : "b46041ce-4c34-4639-891a-24b68c33c8dc" } ] }, }, "appliance_mgmt_listen_addr": "192.168.110.48", "external_id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "_create_time": 1445540755333, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445540868201, "_create_user": "admin", "_revision": 5 }

Read Cluster Node Configuration (Deprecated)

Request:

Example Request:

Successful Response:

ClusterNodeConfig (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: