Pre Upgrade Host Planned Maintenance

Pre Upgrade Host Planned Maintenance

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
URI
POST
https://nsxmanager.your.domain/api/v1/upgrade/pre-upgrade-checks/host/planned-maintenance
COPY
Request Body
PreUpgradeHealthCheckRequest of type(s) application/json
Required 
{
    "entity-id": "string",
    "vcenter-uuid": "string"
}
string
entity-id
Required

Unique identifier of host moref.

string
vcenter-uuid
Required

Instance uuid of vCenter. To get the instance id refer the instanceUuid field of https://<nsx-mgr>/api/v1/fabric/compute-managers API response.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PreUpgradeHostHealthCheckStatuses of type(s) application/json 
"PreUpgradeHostHealthCheckStatuses Object"
array of object
check_statuses
Required
Constraints: default:

List of pre check statuses.

string
status
Optional

Aggregated status of all individual checks. It will be OK only when all executed checks return OK.

Possible values are : OK, WAIT, NOT_OK,
integer As int32 As int32
wait_duration
Optional

Duration in milliseconds to wait before issuing status check again. This field is optional and is only populated when status is WAIT.


400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404
Returns NotFound of type(s) application/json
Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"entity-id:"string","vcenter-uuid:"string"}' https://{api_host}/api/v1/upgrade/pre-upgrade-checks/host/planned-maintenance
On This Page
System Administration Operations
GET
Get Backup Config
PUT
Configure Backup Config
GET
Get Backup History
GET
Get Backup Overview
GET
Get Backup Status
POST
Get Ssh Fingerprint Of Server
POST
Retry Cluster Restore With Updated Config
GET
List Cluster Backup Timestamps
GET
Get Restore Config
Deprecated
PUT
Configure Restore Config
Deprecated
GET
List Restore Instruction Resources
GET
Query Cluster Restore Status
POST
Advance Cluster Restore
POST
Cancel Cluster Restore
POST
Retry Cluster Restore
POST
Initiate Cluster Restore
POST
Suspend Cluster Restore
GET
Cluster Cluster Node Id Node Get Upgrade Task Status
Deprecated
POST
Cluster Cluster Node Id Node Execute Upgrade Task
GET
Cluster Cluster Node Id Node Get Upgrade Progress Status
GET
Cluster Cluster Node Id Node Get Node Upgrade Status Summary
POST
Cluster Cluster Node Id Node Trigger Repository Driven Uc Upgrade
POST
Request Onetime Backup
POST
Request Onetime Inventory Summary
DELETE
Delete Migration Data File
GET
Get Migration Data Info
GET
Download Migration Data
GET
Get Discovered Switches
GET
Get Feedback Requests
PUT
Update Feedback Response
POST
Accept Recommended Value In Feedback
GET
Get Feedback Summary
GET
Get Grouped Feedback Requests
GET
Get Logical Construct Migration Stats
GET
List Migrated Resources
Deprecated
GET
Get Migrated Switches
GET
Get Migration Unit Groups
POST
Create Migration Unit Group
GET
Get Migration Unit Groups Status
GET
Get Migration Unit Group Aggregate Info
DELETE
Delete Migration Unit Group
GET
Get Migration Unit Group
PUT
Update Migration Unit Group
POST
Reorder Migration Unit
GET
Get Migration Unit Group Status
POST
Add Migration Units To Group
POST
Reorder Migration Unit Group
GET
Get Migration Units
GET
Get Migration Units Stats
GET
Get Migration Unit Aggregate Info
GET
Get Migration Unit
GET
Get MP Policy Promotion History
Deprecated
GET
Get MP Policy Promotion State
Deprecated
POST
Migrate MP Data To Policy
Deprecated
POST
Cancel Promotion
Deprecated
GET
Mp2 Policy Migration Feedback
Deprecated
GET
Get MP Policy Post Promotion Mapping
Deprecated
GET
Mp2 Policy Migration Stats
Deprecated
GET
Get Migration Nodes
GET
Get Migration Nodes Summary
GET
Get Vcenters
POST
Provide Vcenter Details
PUT
Add Vcenter To Migration Scope
POST
Get Assessment Units
POST
Get Assessment Messages
POST
Get Vms By Dvpg
POST
Get Dvpgs
POST
Get Segment To Dvpgs Mapping
POST
Get Vms By Segment
POST
Continue Workflow
POST
Reset Workflow
POST
Rollback Workflow
POST
Start Workflow
POST
Get Feedbacks
POST
Get Workflow
POST
Get Workflow Spec
POST
Get Vm Aggregate Info List For Vm Group
POST
Get Dvpg Aggregate Info List
GET
Get Dvpg Migration Info
POST
Get Workflows For Dvpg And Segment Pair
POST
Get Workflow Specs For Dvpg And Segment Pair
GET
Get Vc Workflow Time Stamp List
GET
Get Federation Site Migration State
GET
Get Migration Plan Settings
PUT
Update Migration Plan Settings
POST
Abort Migration
POST
Continue Migration
POST
Finish Migration
POST
Pause Migration
POST
Reset Migration Plan
POST
Start Rollback Migration
POST
Start Migration
POST
Update Federation Site Migration State
GET
Get Nsxv Setup Details
PUT
Update Nsxv Setup Details
PUT
Add Alb Info
PUT
Add V 2t Site Mapping
POST
Migrate Newly Added Host Transport Node
PUT
Set Esg To Router Mapping Option
GET
Get Migration Status Summary
GET
Get Migration Summary
GET
Get Migration Switch
PUT
Set Migration Switch
GET
Get Vm Group Execution Details
POST
Post Vm Group Migrate
POST
Pre Vm Group Migrate
POST
Finalize Infra
GET
List Non Migrated Manager Ids
GET
Node Get Upgrade Task Status
Deprecated
POST
Node Execute Upgrade Task
GET
Node Get Upgrade Progress Status
GET
Node Get Node Upgrade Status Summary
POST
Node Trigger Repository Driven Uc Upgrade
GET
Get Available Releases
POST
Fetch Upgrade Bundle From Url
GET
Get Upgrade Bundle Info
GET
Get Upgrade Bundle Status
GET
Get Upgrade Bundle Upload Status
POST
Cancel Upgrade Bundle Upload
POST
Upload Upgrade Bundle Async
POST
Accept Upgrade EULA
GET
Get Upgrade EULA Acceptance
GET
Get Upgrade EULA Content
POST
Get Upgrade Unit Groups By Filter
POST
Get Upgrade Units By Advance Filter
GET
Get Upgrade Unit Group By Filter
GET
Get Upgrade Units By Filter
GET
Get Uc Functional State
GET
Get Upgrade History
GET
Get Nodes
GET
Get Nodes Summary
GET
Get Upgrade Plan Settings
PUT
Update Upgrade Plan Settings
POST
Continue Upgrade
POST
Pause Upgrade
POST
Reset Upgrade Plan
POST
Stage Upgrade
POST
Start Upgrade
POST
Execute Upgrade
POST
Upgrade Selected Units
GET
Get Pre Upgrade Check Failures
POST
Pre Upgrade Host Planned Maintenance
GET
Get Pre Upgrade Check Success
POST
Acknowledge Pre Upgrade Check
POST
Auto Resolve Pre Upgrade Check
GET
Get All Pre Upgrade Checks In Csv Format
GET
Get Upgrade Status Summary
GET
Get Upgrade Summary
GET
Get Uc Bundle Metadata
GET
Get Uc Upgrade Metadata
GET
Get Uc Upgrade Status
GET
Get Upgrade UI Preferences
GET
Get Upgrade Checks Info
GET
Get Upgrade Unit Groups
POST
Create Upgrade Unit Group
GET
Get Upgrade Unit Groups Status
GET
Get Upgrade Unit Group Aggregate Info
DELETE
Delete Upgrade Unit Group
GET
Get Upgrade Unit Group
PUT
Update Upgrade Unit Group
GET
Get Upgrade Unit Group Status
POST
Reorder Upgrade Unit
POST
Add Upgrade Units To Group
POST
Reorder Upgrade Unit Group
GET
Get Upgrade Units
GET
Get Upgrade Units Stats
GET
Get Upgrade Unit Aggregate Info
GET
Get Upgrade Unit
GET
Get Version Whitelist
GET
Get Version Whitelist By Component
PUT
Update Version Whitelist
POST
Execute Post Upgrade Checks
POST
Abort Pre Upgrade Checks
POST
Execute Pre Upgrade Checks
POST
Trigger Uc Upgrade