Snapservice Clusters ProtectionGroups FilterSpec

The Snapservice Clusters ProtectionGroups FilterSpec schema contains properties used to filter the results when listing protection groups for a cluster If multiple properties are specified, only protection groups matching all of the properties match the filter. See GET /snapservice/clusters/{cluster}/protection-groups.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "pgs": [
        "string"
    ],
    "names": [
        "string"
    ],
    "states": [
        "string"
    ],
    "vms": [
        "string"
    ],
    "cluster_pairs": [
        "string"
    ]
}

array of string

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.

array of string

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.

array of string

states

Optional

States of protection groups that can match the filter.

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.

array of string

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.

array of string

cluster_pairs

Optional

Identifiers of the cluster pairs configured for 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 or no cluster pairs match the filter.