NSX-T Data Center REST API

Execute checks before entering host into maintenance mode

This API will accept the host identification information(vCenter instance uuid and host moref id).
Will execute the host and edge pre-checks that ensure host is ok to enter maintenance mode.
The progress and status of upgrade unit returns status OK, if check has passed. Otherwise will return the NOT_OK.
if status returns WAIT, In that case system expects client to wait and poll the API after every 1 minute till checks
reach terminal state OK or NOT_OK after 8 minutes.

Request:

Method:
POST
URI Path(s):
/api/v1/upgrade/pre-upgrade-checks/host/planned-maintenance
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PreUpgradeHealthCheckRequest+

Example Request:

{ "vcenter-uuid": "bd8f31e9-b9fa-45ff-86e7-4566d60d2245", "entity-id": "host-16" }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PreUpgradeHostHealthCheckStatuses+

Example Response:

{ "check_statuses": [ { "status": "OK", "issues": [], "info": { "check": "com.vmware.nsxt.MpaConnectivityCheck", "name": { "default_message": "Manager connectivity check", "id": "", "localized": "Manager connectivity check" }, "description": { "default_message": "Check for connectivity between host and NSX Manager", "id": "", "localized": "Check for connectivity between host and NSX Manager" } } }, { "status": "OK", "issues": [], "info": { "check": "com.vmware.nsxt.PeerEdgesOnSameHostCheck", "name": { "default_message": "Peer edges on same host check", "id": "", "localized": "Peer edges on same host check" }, "description": { "default_message": "This precheck ensures edges hosting peer LRs are not on same host under upgrade", "id": "", "localized": "This precheck ensures edges hosting peer LRs are not on same host under upgrade" } } }, { "status": "NOT_OK", "issues": [ { "default_message": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found problem(s) [Edge MP-MPA connection down, Edge node status invalid in edge cluster status, Edge node property pnic connection null or undefined, Edge node property control connection null or undefined] on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944 hosting standby instances.", "id": "36007", "localized": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found problem(s) [Edge MP-MPA connection down, Edge node status invalid in edge cluster status, Edge node property pnic connection null or undefined, Edge node property control connection null or undefined] on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944 hosting standby instances." } ], "info": { "check": "com.vmware.nsxt.PeerEdgeHealthCheckHostCheck", "name": { "default_message": "Peer edges health check task", "id": "", "localized": "Peer edges health check task" }, "description": { "default_message": "This precheck ensures peers of edges which are on the host under upgrade are healthy", "id": "", "localized": "This precheck ensures peers of edges which are on the host under upgrade are healthy" } } }, { "status": "NOT_OK", "issues": [ { "default_message": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found edge health status problem(s) on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944. Skipping Peer LR checks.", "id": "36008", "localized": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found edge health status problem(s) on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944. Skipping Peer LR checks." } ], "info": { "check": "com.vmware.nsxt.PeerLRStatusHostCheck", "name": { "default_message": "LR status check on peer edges", "id": "", "localized": "LR status check on peer edges" }, "description": { "default_message": "This precheck ensures LRs of edges on the host under upgrade have a healthy peer if fail over happens", "id": "", "localized": "This precheck ensures LRs of edges on the host under upgrade have a healthy peer if fail over happens" } } }, { "status": "NOT_OK", "issues": [ { "default_message": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found edge health status problem(s) on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944. Skipping Peer BGP checks.", "id": "36008", "localized": "While checking failover readiness of cc98674e-f122-46d3-9295-0ab68384a351 found edge health status problem(s) on peer edge 7772a430-dfe7-4934-8e1b-1cb0ffee5944. Skipping Peer BGP checks." } ], "info": { "check": "com.vmware.nsxt.PeerLRBgpNeighbourHostCheck", "name": { "default_message": "BGP status check on peer edge", "id": "", "localized": "BGP status check on peer edge" }, "description": { "default_message": "This precheck ensures BGP neighbours of edges on the host under upgrade have a healthy peer if fail over happens", "id": "", "localized": "This precheck ensures BGP neighbours of edges on the host under upgrade have a healthy peer if fail over happens" } } }, { "status": "OK", "issues": [], "info": { "check": "com.vmware.nsxt.MpFqdnCheck", "name": { "default_message": "MP FQDN resolution check", "id": "", "localized": "MP FQDN resolution check" }, "description": { "default_message": "This precheck ensures the MP fqdn is resolvable from the host", "id": "", "localized": "This precheck ensures the MP fqdn is resolvable from the host" } } }, { "status": "OK", "issues": [], "info": { "check": "com.vmware.nsxt.UpgradeEvaluationToolCheck", "name": { "default_message": "Upgrade Evaluation Tool execution check", "id": "", "localized": "Upgrade Evaluation Tool execution check" }, "description": { "default_message": "Prompts user to execute Upgrade Evaluation Tool before proceeding with upgrade.", "id": "", "localized": "Prompts user to execute Upgrade Evaluation Tool before proceeding with upgrade." } } } ], "status": "NOT_OK" }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: