Snapservice.ProtectionGroupUpdateSpec

The Snapservice.ProtectionGroupUpdateSpec 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
            }
        }
    ],
    "replication_policies": [
        {
            "cluster_pair": "string",
            "recovery_point_objective": {
                "unit": "string",
                "duration": 0
            },
            "snapshot_retention": {
                "short_term": {
                    "keep_last": 0
                }
            }
        }
    ]
}

string

name

Optional

Name of the protection group.

This property was added in vSphere API 8.0.3.0.

if missing or null, the current proteciton group name will be retained.

target_entities

Optional

Target entities for the protection. If set, this will represent all the target entities for the protection group.

This property was added in vSphere API 8.0.3.0.

if missing or null, the existing target entities will be retained.

array of Snapservice.SnapshotPolicy

snapshot_policies

Optional

Snapshot policy for the protection targets. If set, this will represent all the snapshot policies for the protection group. Any existing policies will be removed, if not specified in the new list.

This property was added in vSphere API 8.0.3.0.

if missing or null, existing snapshot policies will be retained.

array of Snapservice.ReplicationPolicy

replication_policies

Optional

Replication policies for the protection group.

This property was added in vSphere API 9.0.0.0.

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