Snapshot Appliance API Operations Index

Snapservice. Cluster Pairs List

List the cluster pairs.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice. Cluster Pairs Get

Get the detailed information regarding the specified cluster pair.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice. Cluster Pairs Create Precheck

Precheck validation for creating a new cluster pair.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.Manage.

Snapservice. Cluster Pairs Create$ Task

Create a new cluster pair.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.Manage.

Snapservice. Cluster Pairs Delete$ Task

Delete the specified cluster-pair.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.Manage.

Snapservice. Cluster Pairs Create Precheck$ Task

Precheck validation for creating a new cluster pair.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.Manage.

Snapservice.clusters.protection Groups

Snapservice. Clusters. Protection Groups List

List the protection groups for the given cluster.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Protection Groups Get

Get the detailed information regarding the specified protection group.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Protection Groups Create$ Task

Create a protection group for the given cluster.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice. Clusters. Protection Groups Delete$ Task

Delete the specified protection group. Default bahaviour:

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

PATCH

Snapservice. Clusters. Protection Groups Update$ Task

Update a protection group for the given cluster.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice. Clusters. Protection Groups Pause$ Task

Pause the specified proteciton group. This action pauses all periodic snapshot operations and deletion of expired snapshots. Any ongoing snapshot creation or deletion operations will not be paused.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice. Clusters. Protection Groups Resume$ Task

Resume the specified proteciton group. This action resumes all periodic snapshot operations and deletion of expired snapshots.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice. Clusters. Protection Groups Demote$ Task

Demote the specified protection group. This operation demotes a protection group into a demoted state.

When the protection group goes from an Active state to demoted, all local protection and remote rpelication operations will be paused.

While in this state, there will be no local protection or remote replication operations performed by the system. The protection group goes into a dormant state once the user activates the dormant PG in the remote site.

This operation was added in vSphere API 9.0.0.0.

Snapservice. Clusters. Protection Groups Promote$ Task

Promote the specified protection group. This operation promotes a protection group from a dormant state to recovery.

While in this state, there will be no local protection or remote replication operations performed by the system. User can promote the protection group into recovery state in order to start recovery workflows of the members that belong to this protection group.

This operation was added in vSphere API 9.0.0.0.

Snapservice. Clusters. Protection Groups Activate$ Task

Activate the specified protection group. This operation activates a protection group from a recovery state putting it into an active state.

This will result in enabling local protection and remote replication for the members in the protection group.

This operation was added in vSphere API 9.0.0.0.

Snapservice.clusters.protection Groups.snapshots

Snapservice. Clusters. Protection Groups. Snapshots List

List the snapshots for the given protection group.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Protection Groups. Snapshots Get

Get the detailed information regarding the specified protection group snapshot.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Protection Groups. Snapshots Delete

Delete the specified protection group snapshot.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice. Clusters. Protection Groups. Snapshots Create$ Task

Create a snapshot for the given protection group.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.

Snapservice.clusters.virtual Machines

Snapservice. Clusters. Virtual Machines List

List the virtual machines for the given cluster.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Virtual Machines Revert$ Task

Revert the virtual machine to a given snapshot point. The system takes an additional snapshot to preserve the state prior to performing a revert. The system snapshot does not preserve the in-memory state of the virtual machine. The virtual machine will be left in a powered off state after the revert operation.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.
The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.State.RevertToSnapshot and VirtualMachine.Interact.PowerOff.

Snapservice. Clusters. Virtual Machines Restore$ Task

Restore deleted virtual machine to a given snapshot point. The virtual machine will be left in a powered off state after the restore operation.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.
The resource Folder referenced by the property Snapservice.Clusters.VirtualMachines.RestorePlacementSpec.folder requires VirtualMachine.Inventory.Create.
The resource ResourcePool referenced by the property Snapservice.Clusters.VirtualMachines.RestorePlacementSpec.resource_pool requires Resource.AssignVMToPool.

Snapservice. Clusters. Virtual Machines Linked Clone$ Task

Creates a linked clone virtual machine from the given snapshot. The virtual machine will be left in a powered off state after the clone operation.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.
The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Provisioning.Clone.
The resource Folder referenced by the property Snapservice.Clusters.VirtualMachines.LinkedClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting.
The resource ResourcePool referenced by the property Snapservice.Clusters.VirtualMachines.LinkedClonePlacementSpec.resource_pool requires Resource.AssignVMToPool.

Snapservice.clusters.virtual Machines.snapshots

Snapservice. Clusters. Virtual Machines. Snapshots List

List the snapshots for the given virtual machine.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Clusters. Virtual Machines. Snapshots Get

Get the detailed information regarding the specified virtual machine snapshot.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice.info.about

Snapservice. Info. About Get

Get information about Snapshot service.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Read.

Snapservice.reports.clusters.protection Groups

Snapservice. Reports. Clusters. Protection Groups List

List the protection groups for the given cluster used for reports. The list contains the protection groups existed over the last retention period which is used for reporting purpose, by default retention period is set to 90days.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice.reports.clusters.protection Groups.snapshots

Snapservice. Reports. Clusters. Protection Groups. Snapshots List

Paginated list of protection group snapshots for the given cluster used for reports which contains historical data.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Reports. Clusters. Protection Groups. Snapshots List Status Aggregated By Time Slice

Get the aggregated status counts of all the snapshots for all the filtered protection groups for a given cluster time sliced as defined by the service.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Reports. Clusters. Protection Groups. Snapshots List Status Aggregated By Protection Group

Get the status counts of protection group snapshots aggregated by protection group.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice.reports.clusters.virtual Machines

Snapservice. Reports. Clusters. Virtual Machines List

List the virtual machines for the given cluster used for reports. The list contains the virtual machines existed over the last retention period which is used for reporting purpose, by default retention period is set to 90 days.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice.reports.clusters.virtual Machines.snapshots

Snapservice. Reports. Clusters. Virtual Machines. Snapshots List

Paginated list of virtual machine snapshots for the given cluster used for reports.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Reports. Clusters. Virtual Machines. Snapshots List Status Aggregated By Time Slice

Get the aggregated status counts of all the snapshots for all the filtered virtual machines for a given cluster time sliced as defined by the service.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice. Reports. Clusters. Virtual Machines. Snapshots List Status Aggregated By Virtual Machine

Get the status counts of virtual machine snapshots aggregated by virtual machine.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.

Snapservice.sessions

Snapservice. Sessions Get

Returns information about the current session. This operation expects a valid session token to be supplied.

A side effect of invoking this operation may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

This operation was added in vSphere API 9.0.0.0.

Snapservice. Sessions Create

Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session token that is to be used for authenticating subsequent calls.

To authenticate subsequent calls clients are expected to include the session token. For REST API calls the HTTP vmware-api-session-id header field should be used for this.

This operation was added in vSphere API 9.0.0.0.

Snapservice. Sessions Delete

Terminates the validity of a session token. This is the equivalent of log out.

A session token is expected as part of the request.

This operation was added in vSphere API 9.0.0.0.

Snapservice.sites

Snapservice. Sites Probe

Probe SSL connection to a remote vCenter and Data Protection Virtual Appliance. This API returns vCenter/Data Protection Virtual Appliance certificates.

If vCenter certificate is already not trusted, the API will return vCenter certificate with probe status as partial. User is expected to invoke probe API again with the user accepted vCenter certificate. Once the vCenter certificate accepted by the user is supplied to probe API, the API will return with probe status as completed along with Data Protection Virtual Appliance certificate. If Data Protection Virtual Appliance certificate is not trusted, user is expected to accept Data Protection appliance certificate and supply user accepted vCenter and Data Protection Virtual Appliance certificates as input to Add/Update site API.

If vCenter and Data Protection Virtual Appliance certificates are already trusted, the API will respond with probe status as completed. User can proceed with invoking Add/Update site API with no vCenter and Data Protection Virtual Appliance certificates.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice. Sites List

List the local and remote sites.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice. Sites Get

Returns information about a site.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice. Sites Add$ Task

Add the remote site. As part of this call, local and remote site will be paired. In other words, it will setup services on both local and remote sites to be able to connect to each other to perform replication in either direction.

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.

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.

This operation was added in vSphere API 9.0.0.0.

Snapservice. Sites Delete$ Task

Delete the specified remote site. Deleting a site which is not added via SnapService is not supported.

The logged in interactive user must be a member of Administrators group on local site to execute the operation. If the remote site is not failed, 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.

PATCH

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.

Snapservice.sites.clusters

Snapservice. Sites. Clusters List

List the clusters for the specified site.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice.sites.licenses

Snapservice. Sites. Licenses List

List the licenses for the specified site. VMware live recovery licenses are always associated with the peer site. The result for local site will not include the VMware live recovery license information.

VSAN replication features are not supported when the peer site does not have any VMware live recovery licenses available.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.

Snapservice.tasks

Snapservice. Tasks List

Returns information about at most 1000 visible (subject to permission checks) tasks matching the Snapservice.Tasks.FilterSpec.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Read.