ProtectionGroupInfo

ProtectionGroupInfo
ProtectionGroupInfo

The ProtectionGroupInfo structure contains fields that provide detailed information regarding the protection group and the snapshot policies associated with it.

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": "TimeUnit Object",
                "duration": 0
            }
        }
    ],
    "last_snapshot_time": "string",
    "oldest_snapshot_time": "string",
    "vms": [
        "string"
    ],
    "snapshots": [
        "string"
    ],
    "locked": false
}
string
name
Required

Name of the protection group.

ProtectionGroupStatus
status
Required

The ProtectionGroupStatus enumerated type contains the different states for the protection group. Does the status need to be specifically for snapshots? Are there other operations we will support for the Protection Group?
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.

TargetEntities
target_entities
Required

The TargetEntities structure contains fields specifying the target entities to be protected. The initial release will only support virtual machines.

array of SnapshotPolicy
snapshot_policies
Required

Snapshot policies for the protection targets.

string As date-time
last_snapshot_time
Optional

Time at which the last protection group snapshot was taken. is unset if there are no snapshots taken for the protection group.

string As date-time
oldest_snapshot_time
Optional

Time at which the current oldest protection group snapshot was taken. is unset 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 prtection group. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: VirtualMachine.

array of string
snapshots
Required

List of snapshots taken for the protection group. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot. When operations return a value of this structure as a result, the field 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

Returned By