System Administration > Lifecycle Management

Associated URIs:

API Description API Path

Request one-time inventory summary.


Request one-time inventory summary. The backup will be uploaded using the
same server configuration as for an automatic backup.
POST /api/v1/cluster?action=summarize_inventory_to_remote

Request one-time backup


Request one-time backup. The backup will be uploaded using the
same server configuration as for automatic backup.
POST /api/v1/cluster?action=backup_to_remote

Get ssh fingerprint of remote(backup) server


Get SHA256 fingerprint of ECDSA key of remote server. The caller should
independently verify that the key is trusted.
POST /api/v1/cluster/backups?action=retrieve_ssh_fingerprint

Get backup configuration


Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.
GET /api/v1/cluster/backups/config

Configure backup


Configure file server and timers for automated backup.
If secret fields are omitted (password, passphrase)
then use the previously set value.
PUT /api/v1/cluster/backups/config

Get backup history


Get history of previous backup operations
GET /api/v1/cluster/backups/history

Get all backup related information for a site


Get a configuration of a file server, timers for automated backup,
latest backup status, backups list for a site.
Fields that contain secrets (password, passphrase) are not returned.
GET /api/v1/cluster/backups/overview

Get backup status


Get status of active backup operations
GET /api/v1/cluster/backups/status

Initiate a restore operation


Start the restore of an NSX cluster, from some previously
backed-up configuration. This operation is only valid
when a GET cluster/restore/status returns a status with value NOT_STARTED.
Otherwise, a 409 response is returned.
POST /api/v1/cluster/restore?action=start

Advance any suspended restore operation


Advance any currently suspended restore operation. The operation might
have been suspended because (1) the user had suspended it previously, or
(2) the operation is waiting for user input, to be provided as a
part of the POST request body. This operation is only valid
when a GET cluster/restore/status returns a status with value SUSPENDED.
Otherwise, a 409 response is returned.
POST /api/v1/cluster/restore?action=advance

Cancel any running restore operation


This operation is only valid when a restore is in suspended state. The UI user
can cancel any restore operation when the restore is suspended either due
to an error, or for a user input. The API user would need to monitor the
progression of a restore by calling periodically
"/api/v1/cluster/restore/status" API. The response object
(ClusterRestoreStatus), contains a field "endpoints". The API user can cancel
the restore process if 'cancel' action is shown in the endpoint field. This
operation is only valid when a GET cluster/restore/status returns a status
with value SUSPENDED.
POST /api/v1/cluster/restore?action=cancel

Suspend any running restore operation


Suspend any currently running restore operation. The restore operation is
made up of a number of steps. When this call is issued, any currently
running step is allowed to finish (successfully or with errors), and the
next step (and therefore the entire restore operation) is suspended until
a subsequent resume or cancel call is issued. This operation is only valid
when a GET cluster/restore/status returns a status with value RUNNING.
Otherwise, a 409 response is returned.
POST /api/v1/cluster/restore?action=suspend

Retry any failed restore operation


Retry any currently in-progress, failed restore operation. Only the last
step of the multi-step restore operation would have failed,and only that
step is retried. This operation is only valid when a
GET cluster/restore/status returns a status with value FAILED. Otherwise,
a 409 response is returned.
POST /api/v1/cluster/restore?action=retry

List timestamps of all available Cluster Backups.


Returns timestamps for all backup files that are available
on the SFTP server.
GET /api/v1/cluster/restore/backuptimestamps

Deprecated. Get Restore configuration


Deprecated. Please use API /cluster/backups/config, to get remote file server(where
backuped-up files are stored) details durign restore. In older versions
- Get configuration information for the file server used to store backed-up files.
Fields that contain secrets (password, passphrase) are not returned.
GET /api/v1/cluster/restore/config (Deprecated)

Deprecated. Configure Restore SFTP server credentials


Deprecated. Please use API /cluster/backups/config, to configure
remote file server(where backed-up files are stored) details
during restore. In older versions
- Configure file server where the backed-up files used for the Restore
operation are available.
PUT /api/v1/cluster/restore/config (Deprecated)

List resources for a given instruction, to be shown to/executed by users.


For restore operations requiring user input e.g. performing an action,
accepting/rejecting an action, etc. the information to be conveyed to users
is provided in this call.
GET /api/v1/cluster/restore/instruction-resources

Query Restore Request Status


Returns status information for the specified NSX cluster restore request.
GET /api/v1/cluster/restore/status

Perform steps required to finalize the infra.


Perform steps that are required to finalize the infra such as remove the temporary security groups, remove other
objects created temporarily for the migration.
POST /api/v1/migration?action=finalize_infra

Get Migration Data Info.


Get information about the requested Migration Data file.
GET /api/v1/migration/data

Download migration data


Download the data needed for migration. The call returns after Download
is completed.
GET /api/v1/migration/data/download

Upload migration data


Upload the data needed for migration. The call returns after upload is
completed.
POST /api/v1/migration/data/upload

Get the list of discovered switches (DVS, VSS)


Get the list of discovered switches (DVS, VSS) for the selected VC.
GET /api/v1/migration/discovered-switches

NSX-V feedback details


Get feedback details of NSX-V to be migrated.
GET /api/v1/migration/feedback-requests

Accept default action for feedbacks


Pick default resolution for all feedback items.
POST /api/v1/migration/feedback-response?action=accept-recommended

Migration feedback response


Provide response for feedback queries needed for migration.
PUT /api/v1/migration/feedback-response

Feedback request summary


Get feedback summary of NSX-V to be migrated.
GET /api/v1/migration/feedback-summary

NSX-V feedback details


Get feedback details of NSX-V to be migrated, grouped by feedback type.
GET /api/v1/migration/grouped-feedback-requests

Get migration stats for logical constructs phase


Get migration stats for logical constructs phase. This API can be polled for getting runtime progress of the migration from source to target.
GET /api/v1/migration/logical-constructs/stats

Get the list of migrated switches (DVS, VSS)


Get the list of migrated switches (DVS, VSS) for the selected VC.
GET /api/v1/migration/migrated-switches

Return information of all migration unit groups


Return information of all migration unit groups in the
migration plan. If request parameter summary is set to true, then
only count of migration units will be returned, migration units list
will be empty. If request parameter component type is specified,
then all migration unit groups for that component will be returned.
GET /api/v1/migration/migration-unit-groups

Create a group


Create a group of migration units.
POST /api/v1/migration/migration-unit-groups

Get migration status for migration unit groups


Get migration status for migration unit groups
GET /api/v1/migration/migration-unit-groups-status

Delete the migration unit group


Delete the specified group.
NOTE - A group can be deleted only if it is empty.
If user tries to delete a group containing one
or more migration units, the operation will fail and an error
will be returned.
DELETE /api/v1/migration/migration-unit-groups/<group-id>

Return migration unit group information


Returns information about a specific migration unit group in the
migration plan. If request parameter summary is set to true, then
only count of migration units will be returned, migration units list
will be empty.
GET /api/v1/migration/migration-unit-groups/<group-id>

Add migration units to specified migration unit group


Add migration units to specified migration unit group. The migration
units will be added at the end of the migration unit list.
POST /api/v1/migration/migration-unit-groups/<group-id>?action=add_migration_units

Reorder migration unit group


Reorder an migration unit group by placing it before/after
the specified migration unit group.
POST /api/v1/migration/migration-unit-groups/<group-id>?action=reorder

Update the migration unit group


Update the specified migration unit group. Removal of migration units from the group
using this is not allowed. An error will be returned in that case.
PUT /api/v1/migration/migration-unit-groups/<group-id>

Reorder an migration unit within the migration unit group


Reorder an migration unit within the migration unit group by placing it
before/after the specified migration unit
POST /api/v1/migration/migration-unit-groups/<group-id>/migration-unit/<migration-unit-id>?action=reorder

Get migration status for group


Get migration status for migration units in the specified group. User can
specify whether to show only the migration units with errors.
GET /api/v1/migration/migration-unit-groups/<group-id>/status

Return aggregate information of all migration unit groups


Return information of all migration unit groups in the
migration plan. If request parameter summary is set to true, then
only count of migration units will be returned, migration units list
will be empty. If request parameter component type is specified,
then all migration unit groups for that component will be returned.
GET /api/v1/migration/migration-unit-groups/aggregate-info

Get migration units


Get migration units
GET /api/v1/migration/migration-units

Get migration units stats


Get migration units stats
GET /api/v1/migration/migration-units-stats

Get a specific migration unit


Get a specific migration unit
GET /api/v1/migration/migration-units/<migration-unit-id>

Get migration units aggregate-info


Get migration units aggregate-info
GET /api/v1/migration/migration-units/aggregate-info

Get list of nodes across all types


Get list of nodes. If request parameter component type is specified, then
all nodes for that component will be returned. If request parameter component
version is specified, then all nodes at that version will be returned.
GET /api/v1/migration/nodes

Get summary of nodes


Get summary of nodes, which includes node count for each type and component version.
GET /api/v1/migration/nodes-summary

Mark completion of a migration cycle


This API marks the completion of one execution of migration workflow. This API resets internal
execution state and hence needs to be invoked before starting subsequent workflow run.
POST /api/v1/migration/plan?action=finish

Start migration


Start the migration. Migration will start as per the migration plan.
POST /api/v1/migration/plan?action=start

Pause migration


Pause the migration. Migration will be paused after migration of all
the nodes currently in progress is completed either successfully
or with failure. User can make changes in the migration plan when
the migration is paused.
POST /api/v1/migration/plan?action=pause

Abort migration


Resets all migration steps done so far, so that migration can be restarted
with new setup details.
POST /api/v1/migration/plan?action=abort

Continue migration


Continue the migration. Resumes the migration from the point where
it was paused.
POST /api/v1/migration/plan?action=continue

Reset migration plan to default plan


Reset the migration plan to default plan. User has an option to change
the default plan. But if after making changes, user wants to go
back to the default plan, this is the way to do so.
POST /api/v1/migration/plan?action=reset

Rollbabck migration


Roll back the migration. Changes applied to target NSX will be reverted.
Use the migration status API to monitor progress of roll back.
POST /api/v1/migration/plan?action=rollback

Get migration plan settings for the component


Get the migration plan settings for the component.
GET /api/v1/migration/plan/<component_type>/settings

Update migration plan settings for the component


Update the migration plan settings for the component.
PUT /api/v1/migration/plan/<component_type>/settings

NSX-V setup details


Get setup details of NSX-V to be migrated.
GET /api/v1/migration/setup

NSX-V setup details


Provide setup details of NSX-V to be migrated.
PUT /api/v1/migration/setup

Get migration status summary


Get migration status summary
GET /api/v1/migration/status-summary

Get migration summary


Get migration summary
GET /api/v1/migration/summary

Get the switch set as current scope for migration


The user is returned the switch (DVS/VSS) set as current scope of migration.
GET /api/v1/migration/switch

Set the switch as current scope for migration


The user specifies a DVS / VSS as the current scope of migration.
PUT /api/v1/migration/switch

Perform steps required before migrating a VM group.


For each VM group, the following three high level steps are performed in sequence.
1. Call pre VM group migrate API.
2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC.
3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API.
This API specifically deals with pre VM group migrate API. When pre VM group migrate API is invoked for a VM group
id, MC performs following actions.
- Checks segmentation realization state.
- Creates segment ports.
- Creates temporary security groups.
POST /api/v1/migration/vmgroup?action=pre_migrate

Perform steps required after migrating a VM group.


For each VM group, the following three high level steps are performed in sequence.
1. Call pre VM group migrate API.
2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC.
3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API.
This API specifically deals with post VM group migrate API. When post VM group migrate API is invoked for a VM group
id, MC performs following actions.
- Add security tags on the VMs migrated. For the VMs mentioned in the failed VM instance uuids, this operation is
skipped.
POST /api/v1/migration/vmgroup?action=post_migrate

Get upgrade task status


Get upgrade task status for the given task of the given bundle.
Both bundle_name and task_id must be provided, otherwise you
will receive a 404 NOT FOUND response.
GET /api/v1/node/upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade
GET /api/v1/cluster/<cluster-node-id>/node/upgrade

Execute upgrade task


Execute upgrade task.
POST /api/v1/node/upgrade/performtask
POST /api/v1/transport-nodes/<transport-node-id>/node/upgrade/performtask
POST /api/v1/cluster/<cluster-node-id>/node/upgrade/performtask

Get upgrade progress status


Get progress status of last upgrade step, if upgrade bundle is present.
GET /api/v1/node/upgrade/progress-status
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/progress-status
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/progress-status

Get upgrade status summary


Get status summary of node upgrade, if upgrade bundle is present.
GET /api/v1/node/upgrade/status-summary
GET /api/v1/transport-nodes/<transport-node-id>/node/upgrade/status-summary
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/status-summary

Upgrade the upgrade coordinator.


Upgrade the upgrade coordinator module itself. This call is invoked
after user uploads an upgrade bundle. Once this call is invoked,
upgrade coordinator stops and gets restarted and target version
upgrade coordinator module comes up after restart.
POST /api/v1/upgrade?action=upgrade_uc

Abort pre-upgrade checks


Aborts execution of pre-upgrade checks if already in progress. Halts the
execution of checks awaiting execution at this point and makes best-effort
attempts to stop checks already in execution. Returns without action if
execution of pre-upgrade checks is not in progress.
POST /api/v1/upgrade?action=abort_pre_upgrade_checks

Execute pre-upgrade checks


Run pre-defined checks to identify potential issues which can be
encountered during an upgrade or can cause an upgrade to fail. The results
of the checks are added to the respective upgrade units aggregate-info. The
progress and status of operation is part of upgrade status summary of
individual components.
Returns HTTP status 500 with error code 30953 if execution of pre-upgrade
checks is already in progress.
POST /api/v1/upgrade?action=execute_pre_upgrade_checks

Execute post-upgrade checks


Run pre-defined checks to identify issues after upgrade of a component. The
results of the checks are added to the respective upgrade units
aggregate-info. The progress and status of post-upgrade checks is part of
aggregate-info of individual upgrade unit groups.
Returns HTTP status 500 with error code 30953 if execution of post-upgrade
checks is already in progress.
POST /api/v1/upgrade/<component-type>?action=execute_post_upgrade_checks

Upload upgrade bundle


Upload the upgrade bundle. The call returns after upload is initiated.
User needs to check upload status periodically by retrieving upgrade
bundle upload status to find out if the upload is completed.
This API is deprecated, please use /upgrade/bundles?action=upload API
to upload the upgrade bundle.
POST /api/v1/upgrade/bundle?action=upload (Deprecated)

Upload upgrade bundle


Upload the upgrade bundle. This call returns after upload is completed.
You can check bundle processing status periodically by retrieving upgrade
bundle upload status to find out if the upload and processing is completed.
POST /api/v1/upgrade/bundles?action=upload

Fetch upgrade bundle from given url


Fetches the upgrade bundle from url. The call returns after fetch is initiated.
Check status by periodically retrieving upgrade bundle upload status
using GET /upgrade/bundles//upload-status.
The upload is complete when the status is SUCCESS.
POST /api/v1/upgrade/bundles

Get uploaded upgrade bundle information


Get uploaded upgrade bundle information
GET /api/v1/upgrade/bundles/<bundle-id>

Cancel upgrade bundle upload


Cancel upload of upgrade bundle. This API works only when bundle upload is
in-progress and will not work during post-processing of upgrade bundle. If
bundle upload is in-progress, then the API call returns http OK response
after cancelling the upload and deleting partially uploaded bundle.
POST /api/v1/upgrade/bundles/<bundle-id>?action=cancel_upload

Get uploaded upgrade bundle upload status


Get uploaded upgrade bundle upload status
GET /api/v1/upgrade/bundles/<bundle-id>/upload-status

Accept end user license agreement


Accept end user license agreement
POST /api/v1/upgrade/eula/accept

Return the acceptance status of end user license agreement


Return the acceptance status of end user license agreement
GET /api/v1/upgrade/eula/acceptance

Return the content of end user license agreement


Return the content of end user license agreement in the specified format.
By default, it's pure string without line break
GET /api/v1/upgrade/eula/content

Get functional state of the upgrade coordinator


Get the functional state of the upgrade coordinator.
GET /api/v1/upgrade/functional-state

Get upgrade history


Get upgrade history
GET /api/v1/upgrade/history

Get list of nodes across all types


Get list of nodes. If request parameter component type is specified, then
all nodes for that component will be returned. If request parameter component
version is specified, then all nodes at that version will be returned.
GET /api/v1/upgrade/nodes

Get summary of nodes


Get summary of nodes, which includes node count for each type and component version.
GET /api/v1/upgrade/nodes-summary

Upgrade selected units


Upgrades, Resumes the upgrade of a selected set of units.
POST /api/v1/upgrade/plan?action=upgrade_selected_units

Stage the upgrade bits


This will stage the upgrade bits so that upgrade can be driven
from outside NSX upgrade-coordinator. If component type is not
provided as a request parameter then upgrade staging will be
performed on all the components.
POST /api/v1/upgrade/plan?action=stage-upgrade

Start upgrade


Start the upgrade. Upgrade will start as per the upgrade plan.
POST /api/v1/upgrade/plan?action=start

Pause upgrade


Pause the upgrade. Upgrade will be paused after upgrade of all
the nodes currently in progress is completed either successfully
or with failure. User can make changes in the upgrade plan when
the upgrade is paused.
POST /api/v1/upgrade/plan?action=pause

Reset upgrade plan to default plan


Reset the upgrade plan to default plan. User has an option to change
the default plan. But if after making changes, user wants to go
back to the default plan, this is the way to do so.
POST /api/v1/upgrade/plan?action=reset

Continue upgrade


Continue the upgrade. Resumes the upgrade from the point where
it was paused.
POST /api/v1/upgrade/plan?action=continue

Get upgrade plan settings for the component


Get the upgrade plan settings for the component.
GET /api/v1/upgrade/plan/<component_type>/settings

Update upgrade plan settings for the component


Update the upgrade plan settings for the component.
PUT /api/v1/upgrade/plan/<component_type>/settings

Returns pre-upgrade checks in csv format


Returns pre-upgrade checks in csv format
GET /api/v1/upgrade/pre-upgrade-checks?format=csv

Get Pre-upgrade Check Failures


Get failures resulting from the last execution of pre-upgrade checks. If
the execution of checks is in progress, the response has the list of
failures observed so far.
GET /api/v1/upgrade/pre-upgrade-checks/failures

Get upgrade status summary


Get upgrade status summary
GET /api/v1/upgrade/status-summary

Get upgrade summary


Get upgrade summary
GET /api/v1/upgrade/summary

Get upgrade-coordinator upgrade status


Get upgrade-coordinator upgrade status
GET /api/v1/upgrade/uc-upgrade-status

Returns information about upgrade checks


Returns information of pre-upgrade and post-upgrade checks. If request
parameter component type is specified, then returns information about
all pre-upgrade and post-upgrade for the component. Otherwise returns
information of checks across all component types.
GET /api/v1/upgrade/upgrade-checks-info

Return information of all upgrade unit groups


Return information of all upgrade unit groups in the
upgrade plan. If request parameter summary is set to true, then
only count of upgrade units will be returned, upgrade units list
will be empty. If request parameter component type is specified,
then all upgrade unit groups for that component will be returned.
GET /api/v1/upgrade/upgrade-unit-groups

Create a group


Create a group of upgrade units.
POST /api/v1/upgrade/upgrade-unit-groups

Get upgrade status for upgrade unit groups


Get upgrade status for upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups-status

Delete the upgrade unit group


Delete the specified group.
NOTE - A group can be deleted only if it is empty.
If user tries to delete a group containing one
or more upgrade units, the operation will fail and an error
will be returned.
DELETE /api/v1/upgrade/upgrade-unit-groups/<group-id>

Return upgrade unit group information


Returns information about a specific upgrade unit group in the
upgrade plan. If request parameter summary is set to true, then
only count of upgrade units will be returned, upgrade units list
will be empty.
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>

Add upgrade units to specified upgrade unit group


Add upgrade units to specified upgrade unit group. The upgrade
units will be added at the end of the upgrade unit list.
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=add_upgrade_units

Reorder upgrade unit group


Reorder an upgrade unit group by placing it before/after
the specified upgrade unit group.
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=reorder

Update the upgrade unit group


Update the specified upgrade unit group. Removal of upgrade units from the
group using this is not allowed. An error will be returned in that case.
Following extended_configuration is supported:

Key: upgrade_mode
Supported values: maintenance_mode,in_place
Default: maintenance_mode

Key: maintenance_mode_config_vsan_mode
Supported values: evacuate_all_data, ensure_object_accessibility, no_action
Default: ensure_object_accessibility

Key: maintenance_mode_config_evacuate_powered_off_vms
Supported values: true, false
Default: false

Key: rebootless_upgrade
Supported values: true, false
Default: true
PUT /api/v1/upgrade/upgrade-unit-groups/<group-id>

Get upgrade status for group


Get upgrade status for upgrade units in the specified group. User can
specify whether to show only the upgrade units with errors.
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>/status

Reorder an upgrade unit within the upgrade unit group


Reorder an upgrade unit within the upgrade unit group by placing it
before/after the specified upgrade unit
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>/upgrade-unit/<upgrade-unit-id>?action=reorder

Return aggregate information of all upgrade unit groups


Return information of all upgrade unit groups in the
upgrade plan. If request parameter summary is set to true, then
only count of upgrade units will be returned, upgrade units list
will be empty. If request parameter component type is specified,
then all upgrade unit groups for that component will be returned.
GET /api/v1/upgrade/upgrade-unit-groups/aggregate-info

Get upgrade units


Get upgrade units
GET /api/v1/upgrade/upgrade-units

Get upgrade units stats


Get upgrade units stats
GET /api/v1/upgrade/upgrade-units-stats

Get a specific upgrade unit


Get a specific upgrade unit
GET /api/v1/upgrade/upgrade-units/<upgrade-unit-id>

Get upgrade units aggregate-info


Get upgrade units aggregate-info
GET /api/v1/upgrade/upgrade-units/aggregate-info

Get the version whitelist


Get whitelist of versions for different components
GET /api/v1/upgrade/version-whitelist

Get the version whitelist for the specified component


Get whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP
GET /api/v1/upgrade/version-whitelist/<component_type>

Update the version whitelist for the specified component type


Update the version whitelist for the specified component type (HOST, EDGE, CCP, MP).
PUT /api/v1/upgrade/version-whitelist/<component_type>