Product documentation
Develop for XenServer
8 Citrix Hypervisor 8.2 CU1
View PDF

Class: VMPP

October 11, 2024
Contributed by: 
X X

This class is removed.

VM Protection Policy

Fields for class: VMPP

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

RPCs associated with class: VMPP

RPC name: add_to_alarm_config

This message is removed.

Overview:

Signature:

void add_to_alarm_config (session ref session_ref, VMPP ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: add_to_archive_schedule

This message is removed.

Overview:

Signature:

void add_to_archive_schedule (session ref session_ref, VMPP ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: add_to_archive_target_config

This message is removed.

Overview:

Signature:

void add_to_archive_target_config (session ref session_ref, VMPP ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: add_to_backup_schedule

This message is removed.

Overview:

Signature:

void add_to_backup_schedule (session ref session_ref, VMPP ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: archive_now

This message is removed.

Overview:

This call archives the snapshot provided as a parameter

Signature:

string archive_now (session ref session_ref, VM ref snapshot)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VM ref snapshot The snapshot to archive

Minimum Role: vm-power-admin

Return Type: string

An XMLRPC result

RPC name: create

This message is removed.

Overview:

Create a new VMPP instance, and return its handle.

Signature:

VMPP ref create (session ref session_ref, VMPP record args)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP record args All constructor arguments

Minimum Role: pool-operator

Return Type: VMPP ref

reference to the newly created object

RPC name: destroy

This message is removed.

Overview:

Destroy the specified VMPP instance.

Signature:

void destroy (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: pool-operator

Return Type: void

RPC name: get_alarm_config

This message is removed.

Overview:

Get the alarm_config field of the given VMPP.

Signature:

(string -> string) map get_alarm_config (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_alerts

This message is removed.

Overview:

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

Signature:

string set get_alerts (session ref session_ref, VMPP ref vmpp, int hours_from_now)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: string set

A list of alerts encoded in xml

RPC name: get_all

This message is removed.

Overview:

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

Signature:

VMPP ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: VMPP ref set

references to all objects

RPC name: get_all_records

This message is removed.

Overview:

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

Signature:

(VMPP ref -> VMPP record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: (VMPP ref -> VMPP record) map

records of all objects

RPC name: get_archive_frequency

This message is removed.

Overview:

Get the archive_frequency field of the given VMPP.

Signature:

vmpp_archive_frequency get_archive_frequency (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: vmpp_archive_frequency

value of the field

RPC name: get_archive_last_run_time

This message is removed.

Overview:

Get the archive_last_run_time field of the given VMPP.

Signature:

datetime get_archive_last_run_time (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_archive_schedule

This message is removed.

Overview:

Get the archive_schedule field of the given VMPP.

Signature:

(string -> string) map get_archive_schedule (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_archive_target_config

This message is removed.

Overview:

Get the archive_target_config field of the given VMPP.

Signature:

(string -> string) map get_archive_target_config (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_archive_target_type

This message is removed.

Overview:

Get the archive_target_type field of the given VMPP.

Signature:

vmpp_archive_target_type get_archive_target_type (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: vmpp_archive_target_type

value of the field

RPC name: get_backup_frequency

This message is removed.

Overview:

Get the backup_frequency field of the given VMPP.

Signature:

vmpp_backup_frequency get_backup_frequency (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: vmpp_backup_frequency

value of the field

RPC name: get_backup_last_run_time

This message is removed.

Overview:

Get the backup_last_run_time field of the given VMPP.

Signature:

datetime get_backup_last_run_time (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_backup_retention_value

This message is removed.

Overview:

Get the backup_retention_value field of the given VMPP.

Signature:

int get_backup_retention_value (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_backup_schedule

This message is removed.

Overview:

Get the backup_schedule field of the given VMPP.

Signature:

(string -> string) map get_backup_schedule (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_backup_type

This message is removed.

Overview:

Get the backup_type field of the given VMPP.

Signature:

vmpp_backup_type get_backup_type (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: vmpp_backup_type

value of the field

RPC name: get_by_name_label

This message is removed.

Overview:

Get all the VMPP instances with the given label.

Signature:

VMPP ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return

Minimum Role: read-only

Return Type: VMPP ref set

references to objects with matching names

RPC name: get_by_uuid

This message is removed.

Overview:

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

Signature:

VMPP ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return

Minimum Role: read-only

Return Type: VMPP ref

reference to the object

RPC name: get_is_alarm_enabled

This message is removed.

Overview:

Get the is_alarm_enabled field of the given VMPP.

Signature:

bool get_is_alarm_enabled (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_is_archive_running

This message is removed.

Overview:

Get the is_archive_running field of the given VMPP.

Signature:

bool get_is_archive_running (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_is_backup_running

This message is removed.

Overview:

Get the is_backup_running field of the given VMPP.

Signature:

bool get_is_backup_running (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_is_policy_enabled

This message is removed.

Overview:

Get the is_policy_enabled field of the given VMPP.

Signature:

bool get_is_policy_enabled (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_name_description

This message is removed.

Overview:

Get the name/description field of the given VMPP.

Signature:

string get_name_description (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_label

This message is removed.

Overview:

Get the name/label field of the given VMPP.

Signature:

string get_name_label (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_recent_alerts

This message is removed.

Overview:

Get the recent_alerts field of the given VMPP.

Signature:

string set get_recent_alerts (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: string set

value of the field

RPC name: get_record

This message is removed.

Overview:

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

Signature:

VMPP record get_record (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: VMPP record

all fields from the object

RPC name: get_uuid

This message is removed.

Overview:

Get the uuid field of the given VMPP.

Signature:

string get_uuid (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_VMs

This message is removed.

Overview:

Get the VMs field of the given VMPP.

Signature:

VM ref set get_VMs (session ref session_ref, VMPP ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object

Minimum Role: read-only

Return Type: VM ref set

value of the field

RPC name: protect_now

This message is removed.

Overview:

This call executes the protection policy immediately

Signature:

string protect_now (session ref session_ref, VMPP ref vmpp)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref vmpp The protection policy to execute

Minimum Role: pool-operator

Return Type: string

An XMLRPC result

RPC name: remove_from_alarm_config

This message is removed.

Overview:

Signature:

void remove_from_alarm_config (session ref session_ref, VMPP ref self, string key)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
string key the key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_archive_schedule

This message is removed.

Overview:

Signature:

void remove_from_archive_schedule (session ref session_ref, VMPP ref self, string key)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
string key the key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_archive_target_config

This message is removed.

Overview:

Signature:

void remove_from_archive_target_config (session ref session_ref, VMPP ref self, string key)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
string key the key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: remove_from_backup_schedule

This message is removed.

Overview:

Signature:

void remove_from_backup_schedule (session ref session_ref, VMPP ref self, string key)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
string key the key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: set_alarm_config

This message is removed.

Overview:

Signature:

void set_alarm_config (session ref session_ref, VMPP ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
(string -> string) map value the value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_archive_frequency

This message is removed.

Overview:

Set the value of the archive_frequency field

Signature:

void set_archive_frequency (session ref session_ref, VMPP ref self, vmpp_archive_frequency value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
vmpp_archive_frequency value the archive frequency

Minimum Role: pool-operator

Return Type: void

RPC name: set_archive_last_run_time

This message is removed.

Overview:

Signature:

void set_archive_last_run_time (session ref session_ref, VMPP ref self, datetime value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: set_archive_schedule

This message is removed.

Overview:

Signature:

void set_archive_schedule (session ref session_ref, VMPP ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
(string -> string) map value the value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_archive_target_config

This message is removed.

Overview:

Signature:

void set_archive_target_config (session ref session_ref, VMPP ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
(string -> string) map value the value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_archive_target_type

This message is removed.

Overview:

Set the value of the archive_target_config_type field

Signature:

void set_archive_target_type (session ref session_ref, VMPP ref self, vmpp_archive_target_type value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
vmpp_archive_target_type value the archive target config type

Minimum Role: pool-operator

Return Type: void

RPC name: set_backup_frequency

This message is removed.

Overview:

Set the value of the backup_frequency field

Signature:

void set_backup_frequency (session ref session_ref, VMPP ref self, vmpp_backup_frequency value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
vmpp_backup_frequency value the backup frequency

Minimum Role: pool-operator

Return Type: void

RPC name: set_backup_last_run_time

This message is removed.

Overview:

Signature:

void set_backup_last_run_time (session ref session_ref, VMPP ref self, datetime value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: set_backup_retention_value

This message is removed.

Overview:

Signature:

void set_backup_retention_value (session ref session_ref, VMPP ref self, int value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
int value the value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_backup_schedule

This message is removed.

Overview:

Signature:

void set_backup_schedule (session ref session_ref, VMPP ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self The protection policy
(string -> string) map value the value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_backup_type

This message is removed.

Overview:

Set the backup_type field of the given VMPP.

Signature:

void set_backup_type (session ref session_ref, VMPP ref self, vmpp_backup_type value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object
vmpp_backup_type value New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_is_alarm_enabled

This message is removed.

Overview:

Set the value of the is_alarm_enabled field

Signature:

void set_is_alarm_enabled (session ref session_ref, VMPP ref self, bool value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref 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

Return Type: void

RPC name: set_is_policy_enabled

This message is removed.

Overview:

Set the is_policy_enabled field of the given VMPP.

Signature:

void set_is_policy_enabled (session ref session_ref, VMPP ref self, bool value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object
bool value New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_description

This message is removed.

Overview:

Set the name/description field of the given VMPP.

Signature:

void set_name_description (session ref session_ref, VMPP ref self, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object
string value New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_label

This message is removed.

Overview:

Set the name/label field of the given VMPP.

Signature:

void set_name_label (session ref session_ref, VMPP ref self, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
VMPP ref self reference to the object
string value New value to set

Minimum Role: pool-operator

Return Type: void

Class: VMPP
October 11, 2024
Contributed by: 
X X
October 11, 2024
Contributed by: 
X X

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.