Removed
Class: VMPP
VM Protection Policy
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Enums
vmpp_backup_type
| Values: | snapshot | The backup is a snapshot |
| checkpoint | The backup is a checkpoint |
vmpp_backup_frequency
| Values: | hourly | Hourly backups |
| daily | Daily backups | |
| weekly | Weekly backups |
vmpp_archive_frequency
| Values: | never | Never archive |
| always_after_backup | Archive after backup | |
| daily | Daily archives | |
| weekly | Weekly backups |
vmpp_archive_target_type
| Values: | none | No target config |
| cifs | CIFS target config | |
| nfs | NFS target config |
Fields
Removed
VM ref set
VMs
[RO/runtime]
all VMs attached to this protection policy
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
alarm_config
[RO/constructor]
configuration for the alarm
| Default value: | {} | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_archive_frequency
archive_frequency
[RO/constructor]
frequency of the archive schedule
| Default value: | never | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
datetime
archive_last_run_time
[RO/runtime]
time of the last archive
| Default value: | 19700101T00:00:00Z | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
archive_schedule
[RO/constructor]
schedule of the archive containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
| Default value: | {} | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
archive_target_config
[RO/constructor]
configuration for the archive, including its 'location', 'username', 'password'
| Default value: | {} | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_archive_target_type
archive_target_type
[RO/constructor]
type of the archive target config
| Default value: | none | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_backup_frequency
backup_frequency
[RO/constructor]
frequency of the backup schedule
| Default value: | daily | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
datetime
backup_last_run_time
[RO/runtime]
time of the last backup
| Default value: | 19700101T00:00:00Z | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
int
backup_retention_value
[RO/constructor]
maximum number of backups that should be stored at any time
| Default value: | 7 | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
backup_schedule
[RO/constructor]
schedule of the backup containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
| Default value: | {} | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_backup_type
backup_type
[RW]
type of the backup sub-policy
| Default value: | snapshot | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
is_alarm_enabled
[RO/constructor]
true if alarm is enabled for this policy
| Default value: | false | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
is_archive_running
[RO/runtime]
true if this protection policy's archive is running
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
is_backup_running
[RO/runtime]
true if this protection policy's backup is running
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
is_policy_enabled
[RW]
enable or disable this policy
| Default value: | true | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
name_description
[RW]
a notes field containing human-readable description
| Default value: | "" | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
name_label
[RW]
a human-readable name
| Default value: | "" | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string set
recent_alerts
[RO/runtime]
recent alerts
| Default value: | {} | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Messages
Removed
void
add_to_alarm_config
(session ref, VMPP ref, string, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to add | |
| string value | the value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
add_to_archive_schedule
(session ref, VMPP ref, string, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to add | |
| string value | the value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
add_to_archive_target_config
(session ref, VMPP ref, string, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to add | |
| string value | the value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
add_to_backup_schedule
(session ref, VMPP ref, string, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to add | |
| string value | the value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
archive_now
(session ref, VM ref)
This call archives the snapshot provided as a parameter
| Parameters: | session ref session_id | Reference to a valid session |
| VM ref snapshot | The snapshot to archive | |
| Minimum role: | vm-power-admin | |
| Result: | An XMLRPC result | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VMPP ref
create
(session ref, VMPP record)
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).
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP record args | All constructor arguments | |
| Minimum role: | pool-operator | |
| Result: | reference to the newly created object | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
destroy
(session ref, VMPP ref)
Destroy the specified VMPP instance.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VM ref set
get_VMs
(session ref, VMPP ref)
Get the VMs field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
get_alarm_config
(session ref, VMPP ref)
Get the alarm_config field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string set
get_alerts
(session ref, VMPP ref, int)
This call fetches a history of alerts for a given protection policy
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref vmpp | The protection policy | |
| int hours_from_now | how many hours in the past the oldest record to fetch is | |
| Minimum role: | pool-operator | |
| Result: | A list of alerts encoded in xml | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VMPP ref set
get_all
(session ref)
Return a list of all the VMPPs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | references to all objects | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(VMPP ref → VMPP record) map
get_all_records
(session ref)
Return a map of VMPP references to VMPP records for all VMPPs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | records of all objects | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_archive_frequency
get_archive_frequency
(session ref, VMPP ref)
Get the archive_frequency field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
datetime
get_archive_last_run_time
(session ref, VMPP ref)
Get the archive_last_run_time field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
get_archive_schedule
(session ref, VMPP ref)
Get the archive_schedule field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
get_archive_target_config
(session ref, VMPP ref)
Get the archive_target_config field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_archive_target_type
get_archive_target_type
(session ref, VMPP ref)
Get the archive_target_type field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_backup_frequency
get_backup_frequency
(session ref, VMPP ref)
Get the backup_frequency field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
datetime
get_backup_last_run_time
(session ref, VMPP ref)
Get the backup_last_run_time field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
int
get_backup_retention_value
(session ref, VMPP ref)
Get the backup_retention_value field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
(string → string) map
get_backup_schedule
(session ref, VMPP ref)
Get the backup_schedule field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
enum vmpp_backup_type
get_backup_type
(session ref, VMPP ref)
Get the backup_type field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VMPP ref set
get_by_name_label
(session ref, string)
Get all the VMPP instances with the given label.
| Parameters: | session ref session_id | Reference to a valid session |
| string label | label of object to return | |
| Minimum role: | read-only | |
| Result: | references to objects with matching names | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VMPP ref
get_by_uuid
(session ref, string)
Get a reference to the VMPP instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return | |
| Minimum role: | read-only | |
| Result: | reference to the object | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
get_is_alarm_enabled
(session ref, VMPP ref)
Get the is_alarm_enabled field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
get_is_archive_running
(session ref, VMPP ref)
Get the is_archive_running field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
get_is_backup_running
(session ref, VMPP ref)
Get the is_backup_running field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
bool
get_is_policy_enabled
(session ref, VMPP ref)
Get the is_policy_enabled field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
get_name_description
(session ref, VMPP ref)
Get the name/description field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
get_name_label
(session ref, VMPP ref)
Get the name/label field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string set
get_recent_alerts
(session ref, VMPP ref)
Get the recent_alerts field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
VMPP record
get_record
(session ref, VMPP ref)
Get a record containing the current state of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | all fields from the object | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
get_uuid
(session ref, VMPP ref)
Get the uuid field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
string
protect_now
(session ref, VMPP ref)
This call executes the protection policy immediately
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref vmpp | The protection policy to execute | |
| Minimum role: | pool-operator | |
| Result: | An XMLRPC result | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
remove_from_alarm_config
(session ref, VMPP ref, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
remove_from_archive_schedule
(session ref, VMPP ref, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
remove_from_archive_target_config
(session ref, VMPP ref, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
remove_from_backup_schedule
(session ref, VMPP ref, string)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| string key | the key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_alarm_config
(session ref, VMPP ref, (string → string) map)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| (string → string) map value | the value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_archive_frequency
(session ref, VMPP ref, enum vmpp_archive_frequency)
Set the value of the archive_frequency field
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| enum vmpp_archive_frequency value | the archive frequency | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_archive_last_run_time
(session ref, VMPP ref, datetime)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| datetime value | The time at which the last archive was created. When the timezone is missing, UTC is assumed | |
| Minimum role: | ||
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_archive_schedule
(session ref, VMPP ref, (string → string) map)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| (string → string) map value | the value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_archive_target_config
(session ref, VMPP ref, (string → string) map)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| (string → string) map value | the value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_archive_target_type
(session ref, VMPP ref, enum vmpp_archive_target_type)
Set the value of the archive_target_config_type field
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| enum vmpp_archive_target_type value | the archive target config type | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_backup_frequency
(session ref, VMPP ref, enum vmpp_backup_frequency)
Set the value of the backup_frequency field
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| enum vmpp_backup_frequency value | the backup frequency | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_backup_last_run_time
(session ref, VMPP ref, datetime)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| datetime value | The time at which the last backup was done. When the timezone is missing, UTC is assumed | |
| Minimum role: | ||
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_backup_retention_value
(session ref, VMPP ref, int)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| int value | the value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_backup_schedule
(session ref, VMPP ref, (string → string) map)
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| (string → string) map value | the value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_backup_type
(session ref, VMPP ref, enum vmpp_backup_type)
Set the backup_type field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| enum vmpp_backup_type value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_is_alarm_enabled
(session ref, VMPP ref, bool)
Set the value of the is_alarm_enabled field
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | The protection policy | |
| bool value | true if alarm is enabled for this policy | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_is_policy_enabled
(session ref, VMPP ref, bool)
Set the is_policy_enabled field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_name_description
(session ref, VMPP ref, string)
Set the name/description field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |
Removed
void
set_name_label
(session ref, VMPP ref, string)
Set the name/label field of the given VMPP.
| Parameters: | session ref session_id | Reference to a valid session |
| VMPP ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Dummy transition |
| Removed in: | XenServer 6.2 (clearwater) | The VMPR feature was removed |