Snapservice. Sites Update$ Task

Snapservice. Sites Update$ Task

Repair the network connection between the two data protection sites, and/or the combined appliances.

Call this method when there are changes in VC or Data Protection Virtual Appliance FQDN/IP address, SSL certificate, or service account credentials.

If vCenter and Data Protection Virtual appliance certificates returned by Probe API are not trusted yet, respective certificate has to be accepted by the user and supplied as an input to this API.

The logged in interactive user must be a member of Administrators group on local site to execute the operation. The remote user must be a member of Administrators group on remote site too.

This operation was added in vSphere API 9.0.0.0.

Request
URI
PATCH
https://{host}/api/snapservice/sites/{site}?vmw-task=true
COPY
Path Parameters
string
site
Required

Vmodl.Lang.ID existing remote site ID.

The parameter must be an identifier for the resource type: com.vmware.snapservice.site.

Request Body

Snapservice.Sites.UpdateSpec used to update the remote site connection info.

Snapservice.Sites.UpdateSpec of type(s) application/json
Required 
"Snapservice.Sites.UpdateSpec Object"
Authentication
This operation uses the following authentication methods.
Responses
202

Success!

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi.Std.Errors.InvalidArgument If validation of spec fails.

Vapi.Std.Errors.Unsupported If the API is not supported.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json 
"Vapi.Std.Errors.Unauthorized Object"

404

if site points to an unknown site.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

if there is any unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'
On This Page
Snapservice.sites Operations
POST
Snapservice. Sites Probe
GET
Snapservice. Sites List
GET
Snapservice. Sites Get
POST
Snapservice. Sites Add$ Task
DELETE
Snapservice. Sites Delete$ Task
PATCH
Snapservice. Sites Update$ Task