Snapservice.RetentionConfig

The Snapservice.RetentionConfig schema contains properties that describe the retention settings for a given protection group with Snapservice.ReplicationPolicy enabled.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "frequency": "string",
    "retention": {
        "unit": "string",
        "duration": 0
    }
}

string

frequency

Required

Frequency of snapshots to be retained. For e.g. DAILY : 1 snapshot per day

Possible values:

HOURLY: Keep hourly snapshots.
DAILY: Keep daily snapshots.
WEEKLY: Keep weekly snapshots.
MONTHLY: Keep monthly snapshots.
YEARLY: Keep yearly snapshots.

For more information see: Snapservice.TimeFrequency.

This property was added in vSphere API 9.0.0.0.

retention

Required

Total retention period for the snapshots.

This property was added in vSphere API 9.0.0.0.