View Source XenAPI.VMPP (XenAPI v0.1.2)

Link to this section Summary

Functions

This call archives the snapshot provided as a parameter

This call archives the snapshot provided as a parameter (Raise error on XMLRPC failure)

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional).

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional). (Raise error on XMLRPC failure)

Destroy the specified VMPP instance.

Destroy the specified VMPP instance. (Raise error on XMLRPC failure)

Get the alarm_config field of the given VMPP.

Get the alarm_config field of the given VMPP. (Raise error on XMLRPC failure)

This call fetches a history of alerts for a given protection policy

This call fetches a history of alerts for a given protection policy (Raise error on XMLRPC failure)

Return a list of all the VMPPs known to the system.

Return a list of all the VMPPs known to the system. (Raise error on XMLRPC failure)

Return a map of VMPP references to VMPP records for all VMPPs known to the system.

Return a map of VMPP references to VMPP records for all VMPPs known to the system. (Raise error on XMLRPC failure)

Get the archive_frequency field of the given VMPP.

Get the archive_frequency field of the given VMPP. (Raise error on XMLRPC failure)

Get the archive_last_run_time field of the given VMPP.

Get the archive_last_run_time field of the given VMPP. (Raise error on XMLRPC failure)

Get the archive_schedule field of the given VMPP.

Get the archive_schedule field of the given VMPP. (Raise error on XMLRPC failure)

Get the archive_target_config field of the given VMPP.

Get the archive_target_config field of the given VMPP. (Raise error on XMLRPC failure)

Get the archive_target_type field of the given VMPP.

Get the archive_target_type field of the given VMPP. (Raise error on XMLRPC failure)

Get the backup_frequency field of the given VMPP.

Get the backup_frequency field of the given VMPP. (Raise error on XMLRPC failure)

Get the backup_last_run_time field of the given VMPP.

Get the backup_last_run_time field of the given VMPP. (Raise error on XMLRPC failure)

Get the backup_retention_value field of the given VMPP.

Get the backup_retention_value field of the given VMPP. (Raise error on XMLRPC failure)

Get the backup_schedule field of the given VMPP.

Get the backup_schedule field of the given VMPP. (Raise error on XMLRPC failure)

Get the backup_type field of the given VMPP.

Get the backup_type field of the given VMPP. (Raise error on XMLRPC failure)

Get all the VMPP instances with the given label.

Get all the VMPP instances with the given label. (Raise error on XMLRPC failure)

Get a reference to the VMPP instance with the specified UUID.

Get a reference to the VMPP instance with the specified UUID. (Raise error on XMLRPC failure)

Get the is_alarm_enabled field of the given VMPP.

Get the is_alarm_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Get the is_archive_running field of the given VMPP.

Get the is_archive_running field of the given VMPP. (Raise error on XMLRPC failure)

Get the is_backup_running field of the given VMPP.

Get the is_backup_running field of the given VMPP. (Raise error on XMLRPC failure)

Get the is_policy_enabled field of the given VMPP.

Get the is_policy_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Get the name/description field of the given VMPP.

Get the name/description field of the given VMPP. (Raise error on XMLRPC failure)

Get the name/label field of the given VMPP.

Get the name/label field of the given VMPP. (Raise error on XMLRPC failure)

Get the recent_alerts field of the given VMPP.

Get the recent_alerts field of the given VMPP. (Raise error on XMLRPC failure)

Get a record containing the current state of the given VMPP.

Get a record containing the current state of the given VMPP. (Raise error on XMLRPC failure)

Get the uuid field of the given VMPP.

Get the uuid field of the given VMPP. (Raise error on XMLRPC failure)

Get the VMs field of the given VMPP.

Get the VMs field of the given VMPP. (Raise error on XMLRPC failure)

This call executes the protection policy immediately

This call executes the protection policy immediately (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the value of the archive_frequency field

Set the value of the archive_frequency field (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the value of the archive_target_config_type field

Set the value of the archive_target_config_type field (Raise error on XMLRPC failure)

Set the value of the backup_frequency field

Set the value of the backup_frequency field (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the backup_type field of the given VMPP.

Set the backup_type field of the given VMPP. (Raise error on XMLRPC failure)

Set the value of the is_alarm_enabled field

Set the value of the is_alarm_enabled field (Raise error on XMLRPC failure)

Set the is_policy_enabled field of the given VMPP.

Set the is_policy_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Set the name/description field of the given VMPP.

Set the name/description field of the given VMPP. (Raise error on XMLRPC failure)

Set the name/label field of the given VMPP.

Set the name/label field of the given VMPP. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_alarm_config(xen_session, vmpp_ref, key, value)

View Source
Link to this function

add_to_alarm_config!(xen_session, vmpp_ref, key, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

add_to_archive_schedule(xen_session, vmpp_ref, key, value)

View Source
Link to this function

add_to_archive_schedule!(xen_session, vmpp_ref, key, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

add_to_archive_target_config(xen_session, vmpp_ref, key, value)

View Source
Link to this function

add_to_archive_target_config!(xen_session, vmpp_ref, key, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

add_to_backup_schedule(xen_session, vmpp_ref, key, value)

View Source
Link to this function

add_to_backup_schedule!(xen_session, vmpp_ref, key, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

archive_now(xen_session, snapshot)

View Source

This call archives the snapshot provided as a parameter

Link to this function

archive_now!(xen_session, snapshot)

View Source

This call archives the snapshot provided as a parameter (Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional).

Link to this function

create!(xen_session, args)

View Source

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional). (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, vmpp_ref)

View Source

Destroy the specified VMPP instance.

Link to this function

destroy!(xen_session, vmpp_ref)

View Source

Destroy the specified VMPP instance. (Raise error on XMLRPC failure)

Link to this function

get_alarm_config(xen_session, vmpp_ref)

View Source

Get the alarm_config field of the given VMPP.

Link to this function

get_alarm_config!(xen_session, vmpp_ref)

View Source

Get the alarm_config field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_alerts(xen_session, vmpp, hours_from_now)

View Source

This call fetches a history of alerts for a given protection policy

Link to this function

get_alerts!(xen_session, vmpp, hours_from_now)

View Source

This call fetches a history of alerts for a given protection policy (Raise error on XMLRPC failure)

Return a list of all the VMPPs known to the system.

Return a list of all the VMPPs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VMPP references to VMPP records for all VMPPs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VMPP references to VMPP records for all VMPPs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_archive_frequency(xen_session, vmpp_ref)

View Source

Get the archive_frequency field of the given VMPP.

Link to this function

get_archive_frequency!(xen_session, vmpp_ref)

View Source

Get the archive_frequency field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_archive_last_run_time(xen_session, vmpp_ref)

View Source

Get the archive_last_run_time field of the given VMPP.

Link to this function

get_archive_last_run_time!(xen_session, vmpp_ref)

View Source

Get the archive_last_run_time field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_archive_schedule(xen_session, vmpp_ref)

View Source

Get the archive_schedule field of the given VMPP.

Link to this function

get_archive_schedule!(xen_session, vmpp_ref)

View Source

Get the archive_schedule field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_archive_target_config(xen_session, vmpp_ref)

View Source

Get the archive_target_config field of the given VMPP.

Link to this function

get_archive_target_config!(xen_session, vmpp_ref)

View Source

Get the archive_target_config field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_archive_target_type(xen_session, vmpp_ref)

View Source

Get the archive_target_type field of the given VMPP.

Link to this function

get_archive_target_type!(xen_session, vmpp_ref)

View Source

Get the archive_target_type field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_backup_frequency(xen_session, vmpp_ref)

View Source

Get the backup_frequency field of the given VMPP.

Link to this function

get_backup_frequency!(xen_session, vmpp_ref)

View Source

Get the backup_frequency field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_backup_last_run_time(xen_session, vmpp_ref)

View Source

Get the backup_last_run_time field of the given VMPP.

Link to this function

get_backup_last_run_time!(xen_session, vmpp_ref)

View Source

Get the backup_last_run_time field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_backup_retention_value(xen_session, vmpp_ref)

View Source

Get the backup_retention_value field of the given VMPP.

Link to this function

get_backup_retention_value!(xen_session, vmpp_ref)

View Source

Get the backup_retention_value field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_backup_schedule(xen_session, vmpp_ref)

View Source

Get the backup_schedule field of the given VMPP.

Link to this function

get_backup_schedule!(xen_session, vmpp_ref)

View Source

Get the backup_schedule field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_backup_type(xen_session, vmpp_ref)

View Source

Get the backup_type field of the given VMPP.

Link to this function

get_backup_type!(xen_session, vmpp_ref)

View Source

Get the backup_type field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the VMPP instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the VMPP instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the VMPP instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VMPP instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_is_alarm_enabled(xen_session, vmpp_ref)

View Source

Get the is_alarm_enabled field of the given VMPP.

Link to this function

get_is_alarm_enabled!(xen_session, vmpp_ref)

View Source

Get the is_alarm_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_is_archive_running(xen_session, vmpp_ref)

View Source

Get the is_archive_running field of the given VMPP.

Link to this function

get_is_archive_running!(xen_session, vmpp_ref)

View Source

Get the is_archive_running field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_is_backup_running(xen_session, vmpp_ref)

View Source

Get the is_backup_running field of the given VMPP.

Link to this function

get_is_backup_running!(xen_session, vmpp_ref)

View Source

Get the is_backup_running field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_is_policy_enabled(xen_session, vmpp_ref)

View Source

Get the is_policy_enabled field of the given VMPP.

Link to this function

get_is_policy_enabled!(xen_session, vmpp_ref)

View Source

Get the is_policy_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, vmpp_ref)

View Source

Get the name/description field of the given VMPP.

Link to this function

get_name_description!(xen_session, vmpp_ref)

View Source

Get the name/description field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, vmpp_ref)

View Source

Get the name/label field of the given VMPP.

Link to this function

get_name_label!(xen_session, vmpp_ref)

View Source

Get the name/label field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_recent_alerts(xen_session, vmpp_ref)

View Source

Get the recent_alerts field of the given VMPP.

Link to this function

get_recent_alerts!(xen_session, vmpp_ref)

View Source

Get the recent_alerts field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vmpp_ref)

View Source

Get a record containing the current state of the given VMPP.

Link to this function

get_record!(xen_session, vmpp_ref)

View Source

Get a record containing the current state of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vmpp_ref)

View Source

Get the uuid field of the given VMPP.

Link to this function

get_uuid!(xen_session, vmpp_ref)

View Source

Get the uuid field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

get_VMs(xen_session, vmpp_ref)

View Source

Get the VMs field of the given VMPP.

Link to this function

get_VMs!(xen_session, vmpp_ref)

View Source

Get the VMs field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

protect_now(xen_session, vmpp)

View Source

This call executes the protection policy immediately

Link to this function

protect_now!(xen_session, vmpp)

View Source

This call executes the protection policy immediately (Raise error on XMLRPC failure)

Link to this function

remove_from_alarm_config(xen_session, vmpp_ref, key)

View Source
Link to this function

remove_from_alarm_config!(xen_session, vmpp_ref, key)

View Source

(Raise error on XMLRPC failure)

Link to this function

remove_from_archive_schedule(xen_session, vmpp_ref, key)

View Source
Link to this function

remove_from_archive_schedule!(xen_session, vmpp_ref, key)

View Source

(Raise error on XMLRPC failure)

Link to this function

remove_from_archive_target_config(xen_session, vmpp_ref, key)

View Source
Link to this function

remove_from_archive_target_config!(xen_session, vmpp_ref, key)

View Source

(Raise error on XMLRPC failure)

Link to this function

remove_from_backup_schedule(xen_session, vmpp_ref, key)

View Source
Link to this function

remove_from_backup_schedule!(xen_session, vmpp_ref, key)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_alarm_config(xen_session, vmpp_ref, value)

View Source
Link to this function

set_alarm_config!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_archive_frequency(xen_session, vmpp_ref, value)

View Source

Set the value of the archive_frequency field

Link to this function

set_archive_frequency!(xen_session, vmpp_ref, value)

View Source

Set the value of the archive_frequency field (Raise error on XMLRPC failure)

Link to this function

set_archive_last_run_time(xen_session, vmpp_ref, value)

View Source
Link to this function

set_archive_last_run_time!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_archive_schedule(xen_session, vmpp_ref, value)

View Source
Link to this function

set_archive_schedule!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_archive_target_config(xen_session, vmpp_ref, value)

View Source
Link to this function

set_archive_target_config!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_archive_target_type(xen_session, vmpp_ref, value)

View Source

Set the value of the archive_target_config_type field

Link to this function

set_archive_target_type!(xen_session, vmpp_ref, value)

View Source

Set the value of the archive_target_config_type field (Raise error on XMLRPC failure)

Link to this function

set_backup_frequency(xen_session, vmpp_ref, value)

View Source

Set the value of the backup_frequency field

Link to this function

set_backup_frequency!(xen_session, vmpp_ref, value)

View Source

Set the value of the backup_frequency field (Raise error on XMLRPC failure)

Link to this function

set_backup_last_run_time(xen_session, vmpp_ref, value)

View Source
Link to this function

set_backup_last_run_time!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_backup_retention_value(xen_session, vmpp_ref, value)

View Source
Link to this function

set_backup_retention_value!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_backup_schedule(xen_session, vmpp_ref, value)

View Source
Link to this function

set_backup_schedule!(xen_session, vmpp_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_backup_type(xen_session, vmpp_ref, value)

View Source

Set the backup_type field of the given VMPP.

Link to this function

set_backup_type!(xen_session, vmpp_ref, value)

View Source

Set the backup_type field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

set_is_alarm_enabled(xen_session, vmpp_ref, value)

View Source

Set the value of the is_alarm_enabled field

Link to this function

set_is_alarm_enabled!(xen_session, vmpp_ref, value)

View Source

Set the value of the is_alarm_enabled field (Raise error on XMLRPC failure)

Link to this function

set_is_policy_enabled(xen_session, vmpp_ref, value)

View Source

Set the is_policy_enabled field of the given VMPP.

Link to this function

set_is_policy_enabled!(xen_session, vmpp_ref, value)

View Source

Set the is_policy_enabled field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, vmpp_ref, value)

View Source

Set the name/description field of the given VMPP.

Link to this function

set_name_description!(xen_session, vmpp_ref, value)

View Source

Set the name/description field of the given VMPP. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, vmpp_ref, value)

View Source

Set the name/label field of the given VMPP.

Link to this function

set_name_label!(xen_session, vmpp_ref, value)

View Source

Set the name/label field of the given VMPP. (Raise error on XMLRPC failure)