NSX-T Data Center Global Manager REST API

Start or Check on-boarding for a Site

Initiate config on-boarding of a Site. The entire on-boarding is async
workflow controlled by API.

Request:

Method:
POST
URI Path(s):
/global-manager/api/v1/global-infra/sites/{site-id}/onboarding?action=start_onboarding
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ConfigOnboardingRequest+

Example Request:

{ "site_id" : "site-1", "suffix": "site-1-suffix", "site_backup_reference" : "2020-01-28-Site-1-backup" }

Successful Response:

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

Example Response:

{ "site_id": "site-1", "status": "IN_PROGRESS", "supported_features": [], "details": { "import_progress": {}, "site_backup_reference": "2020-01-28-Site-1-backup" }, "timestamp": 1580609440765 }

Required Permissions:

crud

Feature:

federated_site_onboarding

Additional Errors: