/Classes/VMPP

Classes / VMPP / index.html

VM Protection Policy

Fields

string uuid
Unique identifier/object reference
string name_label
a human-readable name
string name_description
a notes field containg human-readable description
bool is_policy_enabled
enable or disable this policy
enum vmpp_backup_type backup_type
type of the backup sub-policy
int backup_retention_value
maximum number of backups that should be stored at any time
enum vmpp_backup_frequency backup_frequency
frequency of the backup schedule
Map[string,string] backup_schedule
schedule of the backup containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone
bool is_backup_running
true if this protection policy's backup is running
datetime backup_last_run_time
time of the last backup
enum vmpp_archive_target_type archive_target_type
type of the archive target config
Map[string,string] archive_target_config
configuration for the archive, including its 'location', 'username', 'password'
enum vmpp_archive_frequency archive_frequency
frequency of the archive schedule
Map[string,string] archive_schedule
schedule of the archive containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone
bool is_archive_running
true if this protection policy's archive is running
datetime archive_last_run_time
time of the last archive
Set[VM] VMs
all VMs attached to this protection policy
bool is_alarm_enabled
true if alarm is enabled for this policy
Map[string,string] alarm_config
configuration for the alarm
Set[string] recent_alerts
recent alerts

Implicit messages

Record[VMPP] get_record (session session_id, VMPP self)
Get a record containing the current state of the given VMPP.
VMPP get_by_uuid (session session_id, string uuid)
Get a reference to the VMPP instance with the specified UUID.
VMPP create (session session_id, string name_label, string name_description, bool is_policy_enabled, enum vmpp_backup_type backup_type, int backup_retention_value, enum vmpp_backup_frequency backup_frequency, Map[string,string] backup_schedule, enum vmpp_archive_target_type archive_target_type, Map[string,string] archive_target_config, enum vmpp_archive_frequency archive_frequency, Map[string,string] archive_schedule, bool is_alarm_enabled, Map[string,string] alarm_config)
Create a new VMPP instance, and return its handle.
void destroy (session session_id, VMPP self)
Destroy the specified VMPP instance.
Set[VMPP] get_by_name_label (session session_id, string label)
Get all the VMPP instances with the given label.
Set[VMPP] get_all (session session_id)
Return a list of all the VMPPs known to the system.
Map[VMPP,Record[VMPP]] get_all_records (session session_id)
Return a map of VMPP references to VMPP records for all VMPPs known to the system.

Explicit messages

string protect_now (session session_id, VMPP vmpp)
This call executes the protection policy immediately
string archive_now (session session_id, VM snapshot)
This call archives the snapshot provided as a parameter
Set[string] get_alerts (session session_id, VMPP vmpp, int hours_from_now)
This call fetches a history of alerts for a given protection policy
void set_backup_retention_value (session session_id, VMPP self, int value)
void set_backup_frequency (session session_id, VMPP self, enum vmpp_backup_frequency value)
Set the value of the backup_frequency field
void set_backup_schedule (session session_id, VMPP self, Map[string,string] value)
void set_archive_frequency (session session_id, VMPP self, enum vmpp_archive_frequency value)
Set the value of the archive_frequency field
void set_archive_schedule (session session_id, VMPP self, Map[string,string] value)
void set_archive_target_type (session session_id, VMPP self, enum vmpp_archive_target_type value)
Set the value of the archive_target_config_type field
void set_archive_target_config (session session_id, VMPP self, Map[string,string] value)
void set_is_alarm_enabled (session session_id, VMPP self, bool value)
Set the value of the is_alarm_enabled field
void set_alarm_config (session session_id, VMPP self, Map[string,string] value)
void add_to_backup_schedule (session session_id, VMPP self, string key, string value)
void add_to_archive_target_config (session session_id, VMPP self, string key, string value)
void add_to_archive_schedule (session session_id, VMPP self, string key, string value)
void add_to_alarm_config (session session_id, VMPP self, string key, string value)
void remove_from_backup_schedule (session session_id, VMPP self, string key)
void remove_from_archive_target_config (session session_id, VMPP self, string key)
void remove_from_archive_schedule (session session_id, VMPP self, string key)
void remove_from_alarm_config (session session_id, VMPP self, string key)
void set_backup_last_run_time (session session_id, VMPP self, datetime value)
void set_archive_last_run_time (session session_id, VMPP self, datetime value)