NSX-T Data Center REST API

Set Edge maintenance mode

Request:

Method:

PUT

URI Path(s):

/api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

MaintenanceModePropertiesRequest+

MaintenanceModePropertiesRequest (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
maintenance_mode	current maintenance mode	boolean
notify_mpa	send notification to MPA	boolean	Default: "True"

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MaintenanceModePropertiesReply+

MaintenanceModePropertiesReply (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
maintenance_mode	current maintenance mode	string	Readonly Enum: enabled, disabled Default: "disabled"

Required Permissions:

crud

Feature:

system_administration Description:

Set the maintenance mode of the edge node directly, without updating the desired state on the NSX manager. To set the desired maintenance mode state of the edge node, use the APIs: POST /api/v1/transport-nodes/<node-id>?action=enter_maintenance_mode POST /api/v1/transport-nodes/<node-id>?action=exit_maintenance_mode

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