Snapservice. Clusters. Protection Groups List

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.
Request
URI
GET
https://{host}/api/snapservice/clusters/{cluster}/protection-groups
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Query Parameters
string of array
pgs
Optional

Identifiers of protection groups that can match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, protection groups with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.

string of array
names
Optional

Names of protection groups that can match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, protection groups with any name match the filter.

string of array
states
Optional

States of protection groups that can match the filter.

Possible values:

  • ACTIVE: Active
  • PAUSED: Paused
  • MARKED_FOR_DELETE: Marked for delete,

Indicates that the PG is soft deleted but has some PG snapshots and VM snapshots which are not yet expired.

  • DEMOTED: Indicates that the protection group is in a demoted state. While in this state, there are no outgoing or incoming replications and local snapshots (if any) are also stopped.
  • DORMANT:

Indicates that the PG is in dormant state.

In this state, all local protection and outgoing replications for the members are disabled. Members belonging to this protection group will be replica members for active incoming replications.

This constant was added in vSphere API 9.0.0.0.

  • RECOVERY: Recovery state.

Indicates the protection group is in a recovery state. In this state site recovery operations can be initiated in case of planned migration and unplanned failover.

This constant was added in vSphere API 9.0.0.0.

For more information see: Snapservice.ProtectionGroupStatus.

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, protection groups with any state match the filter.

string of array
vms
Optional

Identifiers of the virtual machines which belong to the protection groups that can match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, protection groups with any virtual machines match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.

string of array
cluster_pairs
Optional

Identifiers of the cluster pairs configured for protection groups that can match the filter.

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, protection groups with any or no cluster pairs match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the protection groups matching the Snapservice.Clusters.ProtectionGroups.FilterSpec for the given cluster.

Returns Snapservice.Clusters.ProtectionGroups.ListResult of type(s) application/json 
"Snapservice.Clusters.ProtectionGroups.ListResult Object"

400

If validation of the filter fails.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json 
"Vapi.Std.Errors.InvalidArgument 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 there is no cluster associated with cluster in the system.

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

500

If there is unknown internal error.

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

503

If the service is not available.

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

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/snapservice/clusters/{cluster}/protection-groups
On This Page
Snapservice.clusters.protection Groups Operations
GET
Snapservice. Clusters. Protection Groups List
GET
Snapservice. Clusters. Protection Groups Get
POST
Snapservice. Clusters. Protection Groups Create$ Task
DELETE
Snapservice. Clusters. Protection Groups Delete$ Task
PATCH
Snapservice. Clusters. Protection Groups Update$ Task
POST
Snapservice. Clusters. Protection Groups Pause$ Task
POST
Snapservice. Clusters. Protection Groups Resume$ Task
POST
Snapservice. Clusters. Protection Groups Demote$ Task
POST
Snapservice. Clusters. Protection Groups Promote$ Task
POST
Snapservice. Clusters. Protection Groups Activate$ Task