NSX-T Data Center REST API

Update maintenance mode or runtime state of a service VM

Set service VM either in or out of maintenance mode for maintenance mode, or in service or out
of service for runtime state. Only one value can be set at one time.

Request:

Method:

POST

URI Path(s):

/api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes/<instance-runtime-id>

Request Headers:

n/a

Query Parameters:

ServiceVMStateParameters+

ServiceVMStateParameters (schema)

Name	Description	Type	Notes
action	You could use this parameter to set a servcie VM in maintenance mode or exit from maintenance mode, or set a service VM health state to indicate whether the service VM is running properly or not. 'enable_maintenance_mode' will set service VM in maintenance mode. 'disable_maintenance_mode' will exit from maintenance mode. 'is_healthy' will set runtime health state by partner of a service VM to be healthy. 'is_stopped' will set runtime health state by partner of a service VM to be stopped. 'is_not_responding' will set runtime health state by partner of a service VM to be not responding.	string	Enum: enable_maintenance_mode, disable_maintenance_mode, is_healthy, is_stopped, is_not_responding
unhealthy_reason	Reason for the unhealthy state Reason for the unhealthy state.	string	Maximum length: 500

Request Body:

n/a

Example Request:

POST https://<nsx-mgr>/api/v1/serviceinsertion/services/564dab50-63a0-8b4f-a1f8-20e4d36efc3b/service-instances/564dab50-63a0-8b4f-a1f8-20e4d36efc3c/instance-runtimes/564dab50-63a0-8b4f-a1f8-20e4d36efc3d?action=enable_maintenance_mode

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Required Permissions:

crud

Feature:

service_insertion_deployment

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