NSX-T Data Center REST API

Update NSX install-upgrade service properties

Request:

Method:

PUT

URI Path(s):

/api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
/api/v1/node/services/install-upgrade

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeInstallUpgradeServiceProperties+

NodeInstallUpgradeServiceProperties (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
service_name	Service name	string	Required
service_properties	install-upgrade Service properties	InstallUpgradeServiceProperties

Example Request:

PUT https://<nsx-mgr>/api/v1/node/services/install-upgrade { "service_name": "install-upgrade", "service_properties": { "enabled": false } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeInstallUpgradeServiceProperties+

NodeInstallUpgradeServiceProperties (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
service_name	Service name	string	Required
service_properties	install-upgrade Service properties	InstallUpgradeServiceProperties

Example Response:

{ "_schema": "NodeInstallUpgradeServiceProperties", "_self": "/node/services/install-upgrade", "service_name": "install-upgrade", "service_properties": { "enabled": false, "enabled_on": "None" } }

Required Permissions:

crud

Feature:

system_administration

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