Onboard Site
This onboarding workflow includes initiating a connection to the site, running prechecks and onboarding the site. These actions are performed asynchronously. The state of the site can be checked by calling GET on the status_url returned in the response. Onboarding is completed when the current_state of the site is READY.
The desired_state property in the body of this request allows you control the workflow more granularly. Providing a desired_state of PREPARE will run the prechecks and then halt, preventing the site from actually being onboarded to the platform. Providing a desired_state of ONBOARD will run the prechecks, and if they pass, will start onboarding the site to the platform.
Once a site has been onboarded, use PUT /sites/{site-id} to take any needed actions, like reconnecting the site if it becomes disconnected.
Notes:
- The credentials provided are one-time use to establish a connection. They are never stored or re-used.
Force onboard can be used if the site was onboarded to another SSP instance and references to the old SSP instance remain on the site. This can be known by running prechecks for the site and checking the result for the SiteRegistrationPrecheck. If this precheck fails, it means there are still references to another SSP instance on this site. For this case consider using the force parameter.
If true, all artifacts on the site referencing the other ssp instance will be deleted and the NSX Site will be onboarded to this SSP Instance. Setting Force to true will NOT bypass the need to have prechecks passing.
This parameter should be used with care, it does NOT replace offboarding the site from another SSP instance. If the site is onboarded and connected to another SSP instance, please offboard it from that SSP instance before onboarding it to a new one.
All required details for onboarding a new site to SSP.
{
"site_connection_info": {
"connection_type": "DYNAMIC",
"hostname": "192.168.0.1",
"username": "admin",
"password": "password123",
"certificate": "{nsx_cert}"
},
"site_type": "NSX_MANAGER",
"site_name": "nsx-mgr-0",
"desired_state": "ONBOARD"
}ACCEPTED
{
"id": "2dc09816-34c0-43fb-99a6-b19b249a43da",
"status_url": "https://{ssp_hostname}/ssp/sites/2dc09816-34c0-43fb-99a6-b19b249a43da"
}UUID identifier of the response.
The URL to check the status of the operation.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unexpected error
{
"error_code": 200001,
"error_message": "An internal server error occurred.",
"module_name": "site"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/sites