Synchronization

Synchronization

Perform synchronization of SDDC Manager state with any changes performed out-of-band in the vSphere environment

Request
URI
POST
https://{api_host}/v1/domains/{domainId}/synchronizations
COPY
Path Parameters
string
domainId
Required

ID of the domain to sync

domainId example
123e4567-e89b-42d3-a456-556642440000

Request Body
BrownfieldSyncSpec of type(s) application/json
Required

Show optional properties

{
    "domainName": "string"
}
{
    "domainName": "string",
    "trustAll": false,
    "suppressWarnings": false,
    "localAdminPassword": "string",
    "enableEdgeClusterSync": false
}
string
domainName
Required

Name of the domain to sync

boolean
trustAll
Optional

When provided, presented certificates and SSH keys will be automatically trusted

boolean
suppressWarnings
Optional

When provided, sync operation will continue even if warnings occur

string
localAdminPassword
Optional

SDDC Manager local admin password

boolean
enableEdgeClusterSync
Optional

When provided, existing Edge clusters will be synced to inventory, now and in future auto-sync runs

Responses
202

Accepted

Returns BrownfieldTask of type(s) application/json
"BrownfieldTask Object"
string
taskId
Optional

ID of the task

string
operationType
Optional

BI operation type

string
status
Optional

Status of the task

integer As int64 As int64
startTimestamp
Optional

Timestamp corresponding to the time when the operation was initiated

integer As int64 As int64
endTimestamp
Optional

Timestamp corresponding to the time when the operation was finished

object
error
Optional

error

object
validationResult
Optional

validationResult


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Internal Server Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"domainName:"string"}' https://{api_host}/v1/domains/{domainId}/synchronizations