Snapservice.ProtectionGroupSpec

The Snapservice.ProtectionGroupSpec schema contains properties 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.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "name": "string",
    "target_entities": {
        "vm_name_patterns": [
            "string"
        ],
        "vms": [
            "string"
        ]
    },
    "snapshot_policies": [
        {
            "name": "string",
            "schedule": {
                "unit": "string",
                "interval": 0
            },
            "retention": {
                "unit": "string",
                "duration": 0
            }
        }
    ],
    "locked": false,
    "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.

target_entities

Required

Target entities for the protection.

This property was added in vSphere API 8.0.3.0.

array of Snapservice.SnapshotPolicy

snapshot_policies

Optional

Snapshot policy for the protection targets.

This property was added in vSphere API 8.0.3.0.

if missing or null 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.

This property was added in vSphere API 8.0.3.0.

if missing or null the protection group will be considered as unlocked.

array of Snapservice.ReplicationPolicy

replication_policies

Optional

Replication policy for the protection group. Currently, only one ReplicationPolicy will be allowed. Additional policies to support protecting virtual machines to multiple clusters may be supported in the future

This property was added in vSphere API 9.0.0.0.

Set if replication needs to be configured. Currently only one policy is supported