NSX-T Data Center REST API

Update NSX Management nodes global configuration

Modifies the NSX Management nodes global configuration.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/configs/management
/api/v1/configs/management

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ManagementConfig+

ManagementConfig (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
_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
publish_fqdns	True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.	boolean	Required

Example Request:

PUT https://<nsx-mgr>/api/v1/configs/management { "publish_fqdns": true, "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ManagementConfig+

ManagementConfig (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
_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
publish_fqdns	True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.	boolean	Required

Example Response:

{ "publish_fqdns": true, "_revision": 1 }

Required Permissions:

crud

Feature:

manager

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable