Update node properties

Modifies NSX appliance properties. Modifiable properties include the
timezone, message of the day (motd), and hostname. The NSX appliance
node_version, system_time, and kernel_version are read only and cannot be
modified with this method.

Request:

Method:

PUT

URI Path(s):

/api/v1/node
/api/v1/cluster/<cluster-node-id>/node
/api/v1/transport-nodes/<transport-node-id>/node

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeProperties+

NodeProperties (schema)

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cli_history_size	NSX CLI command history limit, set to 0 to configure no history size limit	integer	Minimum: 0
cli_output_datetime	NSX CLI display datetime stamp in command output	boolean
cli_timeout	NSX CLI inactivity timeout, set to 0 to configure no timeout	integer	Minimum: 0
export_type	Export restrictions in effect, if any	string	Readonly Enum: RESTRICTED, UNRESTRICTED
fully_qualified_domain_name	Fully qualified domain name	string	Readonly
hostname	Host name or fully qualified domain name of node	SystemHostname
kernel_version	Kernel version	string	Readonly
motd	Message of the day to display when users login to node using the NSX CLI	string or null
node_type	Node type	string	Readonly Enum: NSX Manager, NSX Global Manager, NSX Edge, NSX Autonomous Edge, NSX Cloud Service Manager, NSX Public Cloud Gateway
node_uuid	Node Unique Identifier	string	Readonly Maximum length: 36
node_version	Node version	string	Readonly
product_version	Product version	string	Readonly
system_datetime	System date time in UTC	DatetimeUTC
system_time	Current time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
timezone	Timezone	string

Example Request:

PUT https://<nsx-mgr>/api/v1/node { "motd":"Welcome to the NSX Manager" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeProperties+

NodeProperties (schema)

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cli_history_size	NSX CLI command history limit, set to 0 to configure no history size limit	integer	Minimum: 0
cli_output_datetime	NSX CLI display datetime stamp in command output	boolean
cli_timeout	NSX CLI inactivity timeout, set to 0 to configure no timeout	integer	Minimum: 0
export_type	Export restrictions in effect, if any	string	Readonly Enum: RESTRICTED, UNRESTRICTED
fully_qualified_domain_name	Fully qualified domain name	string	Readonly
hostname	Host name or fully qualified domain name of node	SystemHostname
kernel_version	Kernel version	string	Readonly
motd	Message of the day to display when users login to node using the NSX CLI	string or null
node_type	Node type	string	Readonly Enum: NSX Manager, NSX Global Manager, NSX Edge, NSX Autonomous Edge, NSX Cloud Service Manager, NSX Public Cloud Gateway
node_uuid	Node Unique Identifier	string	Readonly Maximum length: 36
node_version	Node version	string	Readonly
product_version	Product version	string	Readonly
system_datetime	System date time in UTC	DatetimeUTC
system_time	Current time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
timezone	Timezone	string

Example Response:

{ "cli_timeout": 600, "cli_output_datetime": true, "hostname": "VMware_NSX_Manager", "kernel_version": "3.14.17-nn1-server", "motd": "Welcome to the NSX Manager", "node_version": "1.0.0.0.0.3063398", "system_time": 1442277530217, "timezone": "Etc/UTC" }

Update node properties

Request:

NodeProperties (schema)

Example Request:

Successful Response:

NodeProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: