ProtectionGroupDetails

ProtectionGroupDetails
ProtectionGroupDetails

Detailed information for protection groups.

JSON Example
{
    "id": "string",
    "name": "string",
    "health": "string",
    "members_specs": [
        {
            "vcenter_id": "string",
            "vcenter_vm_name_patterns": [
                "string"
            ],
            "vcenter_tags": [
                {
                    "category_name": "string",
                    "tag_name": "string"
                }
            ],
            "vcenter_folder_paths": [
                "string"
            ]
        }
    ],
    "schedule_specs": [
        {
            "name": "string",
            "schedule_spec": {
                "minutes": 0,
                "minutes_interval": 0,
                "hours": 0,
                "hours_interval": 0,
                "day_of_month": 0,
                "day_of_month_interval": 0,
                "month": 0,
                "month_interval": 0,
                "day_of_week": 0,
                "day_of_week_interval": 0
            },
            "retention_min": 0
        }
    ],
    "protected_site_id": "string",
    "snapshot_schedule_active": false,
    "snapshot_frequency_type": "string",
    "snapshot_quiescing_enabled": false,
    "snapshot_timestamp": 0,
    "size_gib": "number",
    "snapshot_count": 0
}
string
id
Optional

The unique identifier of the protection group.

string
name
Optional

The name of the protection group.

ProtectionGroupHealth
health
Optional

The health of a protection group.

  • PG_HEALTH_UNKNOWN: The type of the protected site is unknown.
  • PG_HEALTH_OK: There are no known problems.
  • PG_HEALTH_WARNING: There issues that may require attention. Some VMs in the PG may not be protected in the most recent snapshot.
  • PG_HEALTH_CRITICAL: The protection group is failing to work as intended.

Possible values are : PG_HEALTH_UNKNOWN, PG_HEALTH_OK, PG_HEALTH_WARNING, PG_HEALTH_CRITICAL,
array of ProtectionGroupMembersSpec
members_specs
Optional

The specifications used to determine the VMs contained in the protection group.

array of ProtectionGroupScheduleSpec
schedule_specs
Optional

The specifications used to determine when snapshots are taken of the protection group.

Note: The API differs from this documentation. This field is not currently provided.

string
protected_site_id
Optional

The ID of the protected site associated with this protection group.

boolean
snapshot_schedule_active
Optional

Indicates if the protection group has a currently active snapshot schedule.

ProtectionGroupSnapshotFrequencyType
snapshot_frequency_type
Optional

The snapshot frequency of the protection group.

  • PG_SNAP_FREQ_TYPE_UNKNOWN: It is not know what type of snapshots are being used by this protection group.
  • PG_SNAP_FREQ_TYPE_STANDARD: Standard-frequency snapshots allow you to set snapshots schedules every hour to monthly.
  • PG_SNAP_FREQ_TYPE_HIGH: High-frequency snapshots allow you to set snapshot schedules every 30 minutes to monthly.

Possible values are : PG_SNAP_FREQ_TYPE_UNKNOWN, PG_SNAP_FREQ_TYPE_STANDARD, PG_SNAP_FREQ_TYPE_HIGH,
boolean
snapshot_quiescing_enabled
Optional

Indicates if quiescing is enabled for this protection group. For VMs with VMware Tools installed, you can create protection groups to take quiesced snapshots. Quiescing pauses or alters the state of running processes on the VM to guarantee a consistent state of applications.

integer As int64 As int64
snapshot_timestamp
Optional

The time expressed as a Posix timestamp of the most recent snapshot. Posix time is the number of seconds since the epoch 1970-01-01 00:00:00 UTC. For example: the timestap 1640143163 corresponds to 2021-12-22 3:19:23 UTC.

number As double As double
size_gib
Optional

The total amount of logical storage consumed by this protection group.

integer As int32 As int32
snapshot_count
Optional

The number of snapshots for this protection group.

Property Of
Returned By