Snapservice ReplicationPolicy
The Snapservice ReplicationPolicy schema contains properties that describe the settings to configure replication for a given protection group.
This schema was added in vSphere API 9.0.0.0.
{
"cluster_pair": "string",
"recovery_point_objective": {
"unit": "string",
"duration": 0
},
"snapshot_retention": {
"short_term": {
"keep_last": 0
},
"long_term": {
"hourly": {
"retention": {
"unit": "string",
"duration": 0
}
},
"daily": {
"hour": 0,
"retention": {
"unit": "string",
"duration": 0
}
},
"weekly": {
"hour": 0,
"day_of_week": "string",
"retention": {
"unit": "string",
"duration": 0
}
},
"monthly": {
"hour": 0,
"day_of_month": 0,
"retention": {
"unit": "string",
"duration": 0
}
}
}
},
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
},
"target_entity_replication_spec": {
"vm_replication_specs": [
{
"vm": "string",
"config_params": {
"target_config": {
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
}
}
}
}
]
}
}Identifier of the cluster pair. The member entity of the protection group will be replicated to the peer cluster part of the cluster pair.
This property was added in vSphere API 9.0.0.0.
This property is being kept optional for future use-cases, but mandatory in the current version.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.cluster_pair. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.cluster_pair.
The RecoveryPointObjective(RPO) is a measure to configure amount of data that is acceptable to lose in an event of a disaster or failure.
This property was added in vSphere API 9.0.0.0.
Snapshot retention policy for remote site.
This property was added in vSphere API 9.0.0.0.
Specify if replica seed on destination should be used for initial sync. This flag applies to all protection group member entities, unless overridden for the individual target entity.
During edit workflow, if the value of the flag is changed, the updated value would apply only to - existing member entities where no override is set and replication has not yet been configured, either due to a failure or any other delay. - new incoming member entities where no override is set.
This property was added in vSphere API 9.1.0.0.
This property is optional because it was added in a newer version than its parent node.
Target storage spec for all the VMs configured with this protection group. This spec applies to all protection group member entities, unless overridden for the individual target entity.
During an edit workflow, if the spec is changed, the updated value would apply only to existing member entities where no override is set and replication has not yet been configured, either due to a failure or any other delay. In new incoming member entities where no override is set.
This property was added in vSphere API 9.1.0.0.
if missing or null snap service will try to determine target datastore.
Optional target entity policies to override protection group level replication policy settings.
Target entity overrides can only be applied to incoming member entities, eg. new vms added to a protection group during edit protection group operation. In order to update the replication settings for an existing member entity, the target entity specific update API should be used.
The member entity overrides are not displayed as a part of protection group List/Get operations.
This property was added in vSphere API 9.1.0.0.
if missing or null the member entities will use the protection group level setting.