Org Settings

class pycpg.clients.settings.org_settings.OrgSettings(org_settings, t_settings)

Bases: UserDict

Class used to manage an Organization’s settings.

archive_hold_days: Number of days backup archives are held in cold storage after deactivation or destination removal from any devices in this Org.

backup_alert_recipient_emails: List of email addresses that organization backup alert emails get sent to (org admin users get these automatically).

backup_critical_email_days: The number of days devices in this org can go without any backup before “critical” alerts get sent to org admins.

backup_warning_email_days: The number of days devices in this org can go without any backup before “warning” alerts get sent to org admins.

external_reference: External reference field for this Org.

maximum_user_subscriptions: Number of users allowed to consume a license in this Org. Set to -1 for unlimited.

notes: Notes field for this Org.

org_backup_quota: Backup storage quota (in GB) for this organization. Set to -1 for unlimited.

property org_id: The identifier for the org.

org_name: Name for this Org.

property packets: The setting packets for any modifications to be posted to the /api/v1/OrgSettings endpoint.

quota_settings_inherited

Determines if Org Quota settings (maximum_user_subscriptions, org_backup_quota, user_backup_quota, archive_hold_days) are inherited from parent organization.

Modifying one of the Org Quota attributes automatically sets this attribute to False.

property registration_key: The registration key for the org.

reporting_settings_inherited

Determines if Org Reporting settings (backup_warning_email_days, backup_critical_email_days’, `backup_alert_recipient_emails) are inherited from parent organization.

Modifying one of the Org Reporting attributes automatically sets this attribute to False.

user_backup_quota: Backup storage quota (in GB) for each user in this organization. Set to -1 for unlimited.

web_restore_admin_limit: Limit (in MB) to amount of data restorable by admin users via web restore.

web_restore_enabled: Determines if web restores are enabled for devices in this org.

web_restore_user_limit: Limit (in MB) to amount of data restorable by non-admin users via web restore.

class pycpg.clients.settings.device_settings.DeviceSettingsDefaults(device_dict, org_settings)

Bases: UserDict

Class used for managing an Organization’s Device Default settings. Also acts as a base class for DeviceSettings to manage individual device settings.

property available_destinations: Returns a dict of destinations available to be used by devices. Dict keys are destination guids and values are destination names.

backup_status_email_enabled: Determines if the regularly scheduled backup status email is enabled.

backup_status_email_frequency_days: Determines the frequency of the regularly scheduled backup status email.

critical_alert_days: The number of days a device can go without any backup activity before “warning” alert threshold is passed.

critical_email_enabled: Determines if backup “critical” threshold email alerts are configured for this device.

warning_alert_days: The number of days a device can go without any backup activity before “warning” alert threshold is passed.

warning_email_enabled: Determines if backup “warning” threshold email alerts are configured for this device.