ProtectionGroupSpec

The ProtectionGroupSpec structure contains fields that describe the desired protection group and the snapshot policies associated with it. A protection group is a group of entities that vSAN Snapshot Service protects together.

JSON Example

{
    "name": "string",
    "target_entities": {
        "vm_name_patterns": [
            "string"
        ],
        "vms": [
            "string"
        ]
    },
    "snapshot_policies": [
        {
            "name": "string",
            "schedule": {
                "unit": "string",
                "interval": 0
            },
            "retention": {
                "unit": "TimeUnit Object",
                "duration": 0
            }
        }
    ],
    "locked": false
}

string

name

Required

Name of the protection group.

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

Optional

Snapshot policy for the protection targets. if unset local protection will be skipped.

boolean

locked

Optional

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. if unset the protection group will be considered as unlocked.