Snapservice.ProtectionGroupInfo

The Snapservice.ProtectionGroupInfo schema contains properties that provide detailed information regarding the protection group and the snapshot policies associated with it.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "name": "string",
    "status": "string",
    "target_entities": {
        "vm_name_patterns": [
            "string"
        ],
        "vms": [
            "string"
        ]
    },
    "snapshot_policies": [
        {
            "name": "string",
            "schedule": {
                "unit": "string",
                "interval": 0
            },
            "retention": {
                "unit": "string",
                "duration": 0
            }
        }
    ],
    "last_snapshot_time": "string",
    "oldest_snapshot_time": "string",
    "vms": [
        "string"
    ],
    "snapshots": [
        "string"
    ],
    "locked": false,
    "guid": "string",
    "replication_policies": [
        {
            "cluster_pair": "string",
            "recovery_point_objective": {
                "unit": "string",
                "duration": 0
            },
            "snapshot_retention": {
                "short_term": {
                    "keep_last": 0
                }
            }
        }
    ]
}

string

name

Required

Name of the protection group.

This property was added in vSphere API 8.0.3.0.

string

status

Required

Current status of the protection group.

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.

target_entities

Required

User provided target entities that must belong to the protection group.

This property was added in vSphere API 8.0.3.0.

array of Snapservice.SnapshotPolicy

snapshot_policies

Required

Snapshot policies for the protection targets.

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time

last_snapshot_time

Optional

Time at which the last protection group snapshot was taken.

This property was added in vSphere API 8.0.3.0.

is missing or null if there are no snapshots taken for the protection group.

string As date-time As date-time

oldest_snapshot_time

Optional

Time at which the current oldest protection group snapshot was taken.

This property was added in vSphere API 8.0.3.0.

is missing or null if there are no snapshots taken for the protection group.

array of string

vms

Required

List of virtual machines that belong to the protection group. This is a combined list of virtual machines from the dynamic vm name and the individual list of virtual machines specified during creation of the protection group.

This property was added in vSphere API 8.0.3.0.

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

array of string

snapshots

Required

List of snapshots taken for the protection group.

This property was added in vSphere API 8.0.3.0.

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.snapshot. 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.snapshot.

boolean

locked

Required

Indicates if the protection group is to be locked. A locked protection group cannot be modified or deleted by the user. All snapshots associated with the protection group will be secure and cannot be deleted. The system will automatically delete these snapshots upon expiry based on the retention period

This property was added in vSphere API 8.0.3.0.

string

guid

Optional

The Global identifier of the protection group, which can be used to associate protection groups created on remote sites as part of replication configurations

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

array of Snapservice.ReplicationPolicy

replication_policies

Optional

Replication configuration for the protection group specified by the user.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.