Initiate Cluster Restore

Initiate Cluster Restore

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.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/cluster/restore?action=start

COPY

Request Body

InitiateClusterRestoreRequest of type(s) application/json

Required

{
    "ip_address": "string",
    "ipv6_address": "string",
    "node_id": "string",
    "timestamp": 0
}

string As hostname-or-ip As hostname-or-ip

ip_address

Optional

IP address or FQDN of the node from which the backup was taken

string As hostname-or-ip As hostname-or-ip

ipv6_address

Optional

IPv6 address or FQDNv6 of the node which would be used for the restoration. This should be same as the one on which backup was taken

string

node_id

Optional

Unique id of the backed-up configuration from which the appliance will be restored

integer As int64 As int64

timestamp

Optional

Timestamp of the backed-up configuration from which the appliance will be restored

Authentication

This operation uses the following authentication methods.

Responses

200

OK

Returns ClusterRestoreStatus of type(s) application/json

"ClusterRestoreStatus Object"

array of string

allowed_actions

Optional

Constraints: default:

List of actions that are allowed.

integer As int64 As int64

backup_timestamp

Optional

Timestamp when backup was initiated in epoch millisecond

array of object

endpoints

Optional

The list of allowed endpoints, based on the current state of the restore process

string

id

Optional

Unique id for backup request

array of object

instructions

Optional

Instructions for users to reconcile Restore operations

array of string

not_allowed_actions

Optional

Constraints: default:

List of actions that are not allowed

integer As int64 As int64

restore_end_time

Optional

Timestamp when restore was completed in epoch millisecond

integer As int64 As int64

restore_start_time

Optional

Timestamp when restore was started in epoch millisecond

object

status

Optional

Overall restore process status

object

step

Optional

Restore step info

integer As int64 As int64

total_steps

Optional

Total number of steps in the entire restore process

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

409

Conflict

Returns ClusterRestoreStatus of type(s) application/json

"ClusterRestoreStatus Object"

array of string

allowed_actions

Optional

Constraints: default:

List of actions that are allowed.

integer As int64 As int64

backup_timestamp

Optional

Timestamp when backup was initiated in epoch millisecond

array of object

endpoints

Optional

The list of allowed endpoints, based on the current state of the restore process

string

id

Optional

Unique id for backup request

array of object

instructions

Optional

Instructions for users to reconcile Restore operations

array of string

not_allowed_actions

Optional

Constraints: default:

List of actions that are not allowed

integer As int64 As int64

restore_end_time

Optional

Timestamp when restore was completed in epoch millisecond

integer As int64 As int64

restore_start_time

Optional

Timestamp when restore was started in epoch millisecond

object

status

Optional

Overall restore process status

object

step

Optional

Restore step info

integer As int64 As int64

total_steps

Optional

Total number of steps in the entire restore process

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 '{}' https://{api_host}/api/v1/cluster/restore?action=start

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

System Administration Operations

Get Backup Config

Configure Backup Config

Get Backup History

Get Backup Overview

Get Backup Status

Get Ssh Fingerprint Of Server

Retry Cluster Restore With Updated Config

List Cluster Backup Timestamps

Get Restore Config

Configure Restore Config

List Restore Instruction Resources

Query Cluster Restore Status

Advance Cluster Restore

Cancel Cluster Restore

Retry Cluster Restore

Initiate Cluster Restore

Suspend Cluster Restore

Cluster Cluster Node Id Node Get Upgrade Task Status

Cluster Cluster Node Id Node Execute Upgrade Task

Cluster Cluster Node Id Node Get Upgrade Progress Status

Cluster Cluster Node Id Node Get Node Upgrade Status Summary

Cluster Cluster Node Id Node Trigger Repository Driven Uc Upgrade

Request Onetime Backup

Request Onetime Inventory Summary

Delete Migration Data File

Get Migration Data Info

Download Migration Data

Get Discovered Switches

Get Feedback Requests

Update Feedback Response

Accept Recommended Value In Feedback

Get Feedback Summary

Get Grouped Feedback Requests

Get Logical Construct Migration Stats

List Migrated Resources

Get Migrated Switches

Get Migration Unit Groups

Create Migration Unit Group

Get Migration Unit Groups Status

Get Migration Unit Group Aggregate Info

Delete Migration Unit Group

Get Migration Unit Group

Update Migration Unit Group

Reorder Migration Unit

Get Migration Unit Group Status

Add Migration Units To Group

Reorder Migration Unit Group

Get Migration Units

Get Migration Units Stats

Get Migration Unit Aggregate Info

Get Migration Unit

Get MP Policy Promotion History

Get MP Policy Promotion State

Migrate MP Data To Policy

Cancel Promotion

Mp2 Policy Migration Feedback

Get MP Policy Post Promotion Mapping

Mp2 Policy Migration Stats

Get Migration Nodes

Get Migration Nodes Summary

Provide Vcenter Details

Add Vcenter To Migration Scope

Get Assessment Units

Get Assessment Messages

Get Vms By Dvpg

Get Segment To Dvpgs Mapping

Get Vms By Segment

Continue Workflow

Rollback Workflow

Get Workflow Spec

Get Vm Aggregate Info List For Vm Group

Get Dvpg Aggregate Info List

Get Dvpg Migration Info

Get Workflows For Dvpg And Segment Pair

Get Workflow Specs For Dvpg And Segment Pair

Get Vc Workflow Time Stamp List

Get Federation Site Migration State

Get Migration Plan Settings

Update Migration Plan Settings

Abort Migration

Continue Migration

Finish Migration

Pause Migration

Reset Migration Plan

Start Rollback Migration

Start Migration

Update Federation Site Migration State

Get Nsxv Setup Details

Update Nsxv Setup Details

Add V 2t Site Mapping

Migrate Newly Added Host Transport Node

Set Esg To Router Mapping Option

Get Migration Status Summary

Get Migration Summary

Get Migration Switch

Set Migration Switch

Get Vm Group Execution Details

Post Vm Group Migrate

Pre Vm Group Migrate

List Non Migrated Manager Ids

Node Get Upgrade Task Status

Node Execute Upgrade Task

Node Get Upgrade Progress Status

Node Get Node Upgrade Status Summary

Node Trigger Repository Driven Uc Upgrade

Get Available Releases

Fetch Upgrade Bundle From Url

Get Upgrade Bundle Info

Get Upgrade Bundle Status

Get Upgrade Bundle Upload Status

Cancel Upgrade Bundle Upload

Upload Upgrade Bundle Async

Accept Upgrade EULA

Get Upgrade EULA Acceptance

Get Upgrade EULA Content

Get Upgrade Unit Groups By Filter

Get Upgrade Units By Advance Filter

Get Upgrade Unit Group By Filter

Get Upgrade Units By Filter

Get Uc Functional State

Get Upgrade History

Get Nodes Summary

Get Upgrade Plan Settings

Update Upgrade Plan Settings

Continue Upgrade

Reset Upgrade Plan

Execute Upgrade

Upgrade Selected Units

Get Pre Upgrade Check Failures

Pre Upgrade Host Planned Maintenance

Get Pre Upgrade Check Success

Acknowledge Pre Upgrade Check

Auto Resolve Pre Upgrade Check

Get All Pre Upgrade Checks In Csv Format

Get Upgrade Status Summary

Get Upgrade Summary

Get Uc Bundle Metadata

Get Uc Upgrade Metadata

Get Uc Upgrade Status

Get Upgrade UI Preferences

Get Upgrade Checks Info

Get Upgrade Unit Groups

Create Upgrade Unit Group

Get Upgrade Unit Groups Status

Get Upgrade Unit Group Aggregate Info

Delete Upgrade Unit Group

Get Upgrade Unit Group

Update Upgrade Unit Group

Get Upgrade Unit Group Status

Reorder Upgrade Unit

Add Upgrade Units To Group

Reorder Upgrade Unit Group

Get Upgrade Units

Get Upgrade Units Stats

Get Upgrade Unit Aggregate Info

Get Upgrade Unit

Get Version Whitelist

Get Version Whitelist By Component

Update Version Whitelist

Execute Post Upgrade Checks

Abort Pre Upgrade Checks

Execute Pre Upgrade Checks

Trigger Uc Upgrade

Node: apidepo-liferay-dxp-v1-be-w-1:8080: