Lifecycle Management APIs
Operations
GET
Get Backup Config
Get backup configuration
PUT
Configure Backup Config
Configure backup
GET
Get Backup History
Get backup history
GET
Get Backup Overview
Get all backup related information for a site
GET
Get Backup Status
Get backup status
POST
Get Ssh Fingerprint Of Server
Get ssh fingerprint of remote(backup) server
POST
Retry Cluster Restore With Updated Config
Retry any failed restore operation
GET
List Cluster Backup Timestamps
List timestamps of all available Cluster Backups.
GET
Get Restore Config Deprecated
Get Restore configuration
PUT
Configure Restore Config Deprecated
Deprecated. Configure Restore SFTP server credentials
GET
List Restore Instruction Resources
List resources for a given instruction, to be
shown to/executed by users.
GET
Query Cluster Restore Status
Query Restore Request Status
POST
Advance Cluster Restore
Advance any suspended restore operation
POST
Cancel Cluster Restore
Cancel any running restore operation
POST
Retry Cluster Restore
Retry any failed restore operation
POST
Initiate Cluster Restore
Initiate a restore operation
POST
Suspend Cluster Restore
Suspend any running restore operation
GET
Cluster Cluster Node Id Node Get Upgrade Task Status Deprecated
Get upgrade task status
POST
Cluster Cluster Node Id Node Execute Upgrade Task
Execute upgrade task
GET
Cluster Cluster Node Id Node Get Upgrade Progress Status
Get upgrade progress status
GET
Cluster Cluster Node Id Node Get Node Upgrade Status Summary
Get upgrade status summary
POST
Cluster Cluster Node Id Node Trigger Repository Driven Uc Upgrade
Triggers Repository driven Uc Upgrade
POST
Request Onetime Backup
Request one-time backup
POST
Request Onetime Inventory Summary
Request one-time inventory summary.
DELETE
Delete Migration Data File
Delete the migration data file
GET
Get Migration Data Info
Get Migration Data Info.
GET
Download Migration Data
Download migration data
GET
Get Discovered Switches
Get the list of discovered switches (DVS, VSS)
GET
Get Feedback Requests
NSX-V feedback details
PUT
Update Feedback Response
Migration feedback response
POST
Accept Recommended Value In Feedback
Accept default action for feedbacks
GET
Get Feedback Summary
Feedback request summary
GET
Get Grouped Feedback Requests
NSX-V feedback details
GET
Get Logical Construct Migration Stats
Get migration stats for logical constructs phase
GET
List Migrated Resources Deprecated
List migrated resources
GET
Get Migrated Switches
Get the list of migrated switches (DVS, VSS)
GET
Get Migration Unit Groups
Return information of all migration unit groups
POST
Create Migration Unit Group
Create a group
GET
Get Migration Unit Groups Status
Get migration status for migration unit groups
GET
Get Migration Unit Group Aggregate Info
Return aggregate information of all migration unit groups
DELETE
Delete Migration Unit Group
Delete the migration unit group
GET
Get Migration Unit Group
Return migration unit group information
PUT
Update Migration Unit Group
Update the migration unit group
POST
Reorder Migration Unit
Reorder an migration unit within the migration unit group
GET
Get Migration Unit Group Status
Get migration status for group
POST
Add Migration Units To Group
Add migration units to specified migration unit group
POST
Reorder Migration Unit Group
Reorder migration unit group
GET
Get Migration Units
Get migration units
GET
Get Migration Units Stats
Get migration units stats
GET
Get Migration Unit Aggregate Info
Get migration units aggregate-info
GET
Get Migration Unit
Get a specific migration unit
GET
Get MP Policy Promotion History Deprecated
This api is used to get mp policy promotion history. The history contains details about date and time of different promotion
operations like INITIATED, CANCELLED, SUCCESS.
GET
Get MP Policy Promotion State Deprecated
This api is used to get mp policy promotion state.
POST
Migrate MP Data To Policy Deprecated
This will trigger the migration from mp to policy.
POST
Cancel Promotion Deprecated
Cancel migration
GET
Mp2 Policy Migration Feedback Deprecated
To get MP2Policy promotion feedback.
GET
Get MP Policy Post Promotion Mapping Deprecated
This api is used to get mapping of MP and Policy objects after Mp to Policy Migration.
GET
Mp2 Policy Migration Stats Deprecated
To get MP2Policy promotion stats.
GET
Get Migration Nodes
Get list of nodes across all types
GET
Get Migration Nodes Summary
Get summary of nodes
GET
Get Vcenters
Get vCenters
POST
Provide Vcenter Details
Provide vCenter details
PUT
Add Vcenter To Migration Scope
Add vCenter to scope of migration
POST
Get Assessment Units
Get assessment units
POST
Get Assessment Messages
Get assessment messages
POST
Get Vms By Dvpg
Get VMs by DVPG and VnicIpSubnets.
POST
Get Dvpgs
Get DVPGs in vCenter
POST
Get Segment To Dvpgs Mapping
Get segment to DVPGs mapping
POST
Get Vms By Segment
Get VMs by segment
POST
Continue Workflow
Continue workflow
POST
Reset Workflow
Reset workflow
POST
Rollback Workflow
Rollback workflow
POST
Start Workflow
Start workflow.
POST
Get Feedbacks
Get feedbacks
POST
Get Workflow
Get workflow details
POST
Get Workflow Spec
Get workflow spec
POST
Get Vm Aggregate Info List For Vm Group
Get aggregate info for VMs that belong to VM group
POST
Get Dvpg Aggregate Info List
Get DVPG aggregate info list
GET
Get Dvpg Migration Info
Get DVPG migration info
POST
Get Workflows For Dvpg And Segment Pair
Get workflows for DVPG and segment pair
POST
Get Workflow Specs For Dvpg And Segment Pair
Get workflow specs for DVPG and segment pair
GET
Get Vc Workflow Time Stamp List
Get vCenter workflow timestamp list
GET
Get Federation Site Migration State
Get migration-state of all the federation sites.
GET
Get Migration Plan Settings
Get migration plan settings for the component
PUT
Update Migration Plan Settings
Update migration plan settings for the component
POST
Abort Migration
Abort migration
POST
Continue Migration
Continue migration
POST
Finish Migration
Mark completion of a migration cycle
POST
Pause Migration
Pause migration
POST
Reset Migration Plan
Reset migration plan to default plan
POST
Start Rollback Migration
Rollbabck migration
POST
Start Migration
Start migration
POST
Update Federation Site Migration State
Update migration-state of federation site
GET
Get Nsxv Setup Details
NSX-V setup details
PUT
Update Nsxv Setup Details
NSX-V setup details
PUT
Add Alb Info
Add ALB endpoint details for non cross VC migration modes.
PUT
Add V 2t Site Mapping
Add NSX-V to NSX-T site mapping
POST
Migrate Newly Added Host Transport Node
Perform V2T migration steps on newly added Host Transport Node.
PUT
Set Esg To Router Mapping Option
Set the NSX-V ESG to NSX-T Router mapping option.
GET
Get Migration Status Summary
Get migration status summary
GET
Get Migration Summary
Get migration summary
GET
Get Migration Switch
Get the switch set as current scope for migration
PUT
Set Migration Switch
Set the switch as current scope for migration
GET
Get Vm Group Execution Details
Retreives the VM Group Execution Details
POST
Post Vm Group Migrate
Perform steps required after migrating a VM group.
POST
Pre Vm Group Migrate
Perform steps required before migrating a VM group.
POST
Finalize Infra
Perform steps required to finalize the infra.
GET
List Non Migrated Manager Ids
List all non-migrated NSX Manager ids
GET
Node Get Upgrade Task Status Deprecated
Get upgrade task status
POST
Node Execute Upgrade Task
Execute upgrade task
GET
Node Get Upgrade Progress Status
Get upgrade progress status
GET
Node Get Node Upgrade Status Summary
Get upgrade status summary
POST
Node Trigger Repository Driven Uc Upgrade
Triggers Repository driven Uc Upgrade
GET
Get Available Releases
Lists the supported releases , available on VMware Download site to upgrade current system.
POST
Fetch Upgrade Bundle From Url
Fetch upgrade bundle from given url
GET
Get Upgrade Bundle Info
Get uploaded upgrade bundle information
GET
Get Upgrade Bundle Status
Get uploaded upgrade bundle status
GET
Get Upgrade Bundle Upload Status
Get uploaded upgrade bundle upload status
POST
Cancel Upgrade Bundle Upload
Cancel upgrade bundle upload
POST
Upload Upgrade Bundle Async
Upload upgrade bundle
POST
Accept Upgrade EULA
Accept end user license agreement
GET
Get Upgrade EULA Acceptance
Return the acceptance status of end user license agreement
GET
Get Upgrade EULA Content
Return the content of end user license agreement
POST
Get Upgrade Unit Groups By Filter
Return aggregate information of upgrade unit groups filtered using given query.
POST
Get Upgrade Units By Advance Filter
Return aggregate information of upgrade-units filtered using given query.
GET
Get Upgrade Unit Group By Filter
Get upgrade unit groups based on the filter
GET
Get Upgrade Units By Filter
Get upgrade unit based on the filter
GET
Get Uc Functional State
Get functional state of the upgrade coordinator
GET
Get Upgrade History
Get upgrade history
GET
Get Nodes
Get list of nodes across all types
GET
Get Nodes Summary
Get summary of nodes
GET
Get Upgrade Plan Settings
Get upgrade plan settings for the component
PUT
Update Upgrade Plan Settings
Update upgrade plan settings for the component
POST
Continue Upgrade
Continue upgrade
POST
Pause Upgrade
Pause upgrade
POST
Reset Upgrade Plan
Reset upgrade plan to default plan
POST
Stage Upgrade
Stage the upgrade bits
POST
Start Upgrade
Start upgrade
POST
Execute Upgrade
Execute the upgrade
POST
Upgrade Selected Units
Upgrade selected units
GET
Get Pre Upgrade Check Failures
Get Pre-upgrade Check Failures
POST
Pre Upgrade Host Planned Maintenance
Execute checks before entering host into maintenance mode
GET
Get Pre Upgrade Check Success
Get Pre-upgrade Check Success
POST
Acknowledge Pre Upgrade Check
Acknowledge the pre upgrade check.
POST
Auto Resolve Pre Upgrade Check
Auto resolve the pre upgrade check.
GET
Get All Pre Upgrade Checks In Csv Format
Returns pre-upgrade checks in csv format
GET
Get Upgrade Status Summary
Get upgrade status summary
GET
Get Upgrade Summary
Get upgrade summary
GET
Get Uc Bundle Metadata
Get Uc Bundle metadata for last uploaded bundle.
GET
Get Uc Upgrade Metadata
Get Uc Upgrade metadata.
GET
Get Uc Upgrade Status
Get upgrade-coordinator upgrade status
GET
Get Upgrade UI Preferences
Get preferences for rendering the UI.
GET
Get Upgrade Checks Info
Returns information about upgrade checks
GET
Get Upgrade Unit Groups
Return information of all upgrade unit groups
POST
Create Upgrade Unit Group
Create a group
GET
Get Upgrade Unit Groups Status
Get upgrade status for upgrade unit groups
GET
Get Upgrade Unit Group Aggregate Info
Return aggregate information of all upgrade unit groups
DELETE
Delete Upgrade Unit Group
Delete the upgrade unit group
GET
Get Upgrade Unit Group
Return upgrade unit group information
PUT
Update Upgrade Unit Group
Update the upgrade unit group
GET
Get Upgrade Unit Group Status
Get upgrade status for group
POST
Reorder Upgrade Unit
Reorder an upgrade unit within the upgrade unit group
POST
Add Upgrade Units To Group
Add upgrade units to specified upgrade unit group
POST
Reorder Upgrade Unit Group
Reorder upgrade unit group
GET
Get Upgrade Units
Get upgrade units
GET
Get Upgrade Units Stats
Get upgrade units stats
GET
Get Upgrade Unit Aggregate Info
Get upgrade units aggregate-info
GET
Get Upgrade Unit
Get a specific upgrade unit
GET
Get Version Whitelist
Get the version whitelist
GET
Get Version Whitelist By Component
Get the version whitelist for the specified component
PUT
Update Version Whitelist
Update the version whitelist for the specified component type
POST
Execute Post Upgrade Checks
Execute post-upgrade checks
POST
Abort Pre Upgrade Checks
Abort pre-upgrade checks
POST
Execute Pre Upgrade Checks
Execute pre-upgrade checks
POST
Trigger Uc Upgrade
Upgrade the upgrade coordinator.