VMSS
Class: VMSS VM Snapshot Schedule
Published in: XenServer 7.2 (falcon) VM Snapshot Schedule
Enums vmss_frequency
Values: hourly Hourly snapshots daily Daily snapshots weekly Weekly snapshots
vmss_type
Values: snapshot The snapshot is a disk snapshot checkpoint The snapshot is a checkpoint snapshot_with_quiesce Support for VSS has been removed.
Fields
bool
enabled
[RW]
enable or disable this snapshot schedule
Default value: true Published in: XenServer 4.0 (rio) enable or disable this snapshot schedule
enum vmss_frequency
frequency
[RO/constructor]
frequency of taking snapshot from snapshot schedule
Published in: XenServer 4.0 (rio) frequency of taking snapshot from snapshot schedule
datetime
last_run_time
[RO/runtime]
time of the last snapshot
Default value: 19700101T00:00:00Z Published in: XenServer 4.0 (rio) time of the last snapshot
string
name_description
[RW]
a notes field containing human-readable description
Default value: "" Published in: XenServer 4.0 (rio) a notes field containing human-readable description
string
name_label
[RW]
a human-readable name
Default value: "" Published in: XenServer 4.0 (rio) a human-readable name
int
retained_snapshots
[RO/constructor]
maximum number of snapshots that should be stored at any time
Default value: 7 Published in: XenServer 4.0 (rio) maximum number of snapshots that should be stored at any time
(string → string) map
schedule
[RO/constructor]
schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
Default value: {} Published in: XenServer 4.0 (rio) schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
enum vmss_type
type
[RO/constructor]
type of the snapshot schedule
Published in: XenServer 4.0 (rio) type of the snapshot schedule
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in: XenServer 4.0 (rio) Unique identifier/object reference
VM ref set
VMs
[RO/runtime]
all VMs attached to this snapshot schedule
Published in: XenServer 4.0 (rio) all VMs attached to this snapshot schedule
Messages
Hide implicit
void
add_to_schedule
(session ref , VMSS ref , string , string )
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule string key the key to add string value the value to add Minimum role: pool-operator Published in: XenServer 7.2 (falcon)
VMSS ref
create
(session ref , VMSS record )
Create a new VMSS instance, and return its handle.
The constructor args are: name_label, name_description, enabled, type*, retained_snapshots, frequency*, schedule (* = non-optional).
Parameters: session ref session_id Reference to a valid session VMSS record args All constructor arguments Minimum role: pool-operator Result: reference to the newly created object Published in: XenServer 7.2 (falcon) VM Snapshot Schedule
void
destroy
(session ref , VMSS ref )
Destroy the specified VMSS instance.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: pool-operator Published in: XenServer 7.2 (falcon) VM Snapshot Schedule
VMSS ref set
get_all
(session ref )
Return a list of all the VMSSs 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 7.2 (falcon) VM Snapshot Schedule
(VMSS ref → VMSS record) map
get_all_records
(session ref )
Return a map of VMSS references to VMSS records for all VMSSs 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 7.2 (falcon) VM Snapshot Schedule
VMSS ref set
get_by_name_label
(session ref , string )
Get all the VMSS 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 7.2 (falcon) VM Snapshot Schedule
VMSS ref
get_by_uuid
(session ref , string )
Get a reference to the VMSS 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 7.2 (falcon) VM Snapshot Schedule
bool
get_enabled
(session ref , VMSS ref )
Get the enabled field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) enable or disable this snapshot schedule
enum vmss_frequency
get_frequency
(session ref , VMSS ref )
Get the frequency field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) frequency of taking snapshot from snapshot schedule
datetime
get_last_run_time
(session ref , VMSS ref )
Get the last_run_time field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) time of the last snapshot
string
get_name_description
(session ref , VMSS ref )
Get the name/description field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) a notes field containing human-readable description
string
get_name_label
(session ref , VMSS ref )
Get the name/label field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) a human-readable name
VMSS record
get_record
(session ref , VMSS ref )
Get a record containing the current state of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: all fields from the object Published in: XenServer 7.2 (falcon) VM Snapshot Schedule
int
get_retained_snapshots
(session ref , VMSS ref )
Get the retained_snapshots field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) maximum number of snapshots that should be stored at any time
(string → string) map
get_schedule
(session ref , VMSS ref )
Get the schedule field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
enum vmss_type
get_type
(session ref , VMSS ref )
Get the type field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) type of the snapshot schedule
string
get_uuid
(session ref , VMSS ref )
Get the uuid field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) Unique identifier/object reference
VM ref set
get_VMs
(session ref , VMSS ref )
Get the VMs field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object Minimum role: read-only Result: value of the field Published in: XenServer 4.0 (rio) all VMs attached to this snapshot schedule
void
remove_from_schedule
(session ref , VMSS ref , string )
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule string key the key to remove Minimum role: pool-operator Published in: XenServer 7.2 (falcon)
void
set_enabled
(session ref , VMSS ref , bool )
Set the enabled field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object bool value New value to set Minimum role: pool-operator Published in: XenServer 4.0 (rio) enable or disable this snapshot schedule
void
set_frequency
(session ref , VMSS ref , enum vmss_frequency )
Set the value of the frequency field
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule enum vmss_frequency value the snapshot schedule frequency Minimum role: pool-operator Published in: XenServer 7.2 (falcon) Set the value of the frequency field
void
set_last_run_time
(session ref , VMSS ref , datetime )
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule datetime value the value to set Minimum role: Published in: XenServer 7.2 (falcon)
void
set_name_description
(session ref , VMSS ref , string )
Set the name/description field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object string value New value to set Minimum role: pool-operator Published in: XenServer 4.0 (rio) a notes field containing human-readable description
void
set_name_label
(session ref , VMSS ref , string )
Set the name/label field of the given VMSS.
Parameters: session ref session_id Reference to a valid session VMSS ref self reference to the object string value New value to set Minimum role: pool-operator Published in: XenServer 4.0 (rio) a human-readable name
void
set_retained_snapshots
(session ref , VMSS ref , int )
Parameters: session ref session_id Reference to a valid session VMSS ref self The schedule snapshot int value the value to set Minimum role: pool-operator Published in: XenServer 7.2 (falcon)
void
set_schedule
(session ref , VMSS ref , (string → string) map )
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule (string → string) map value the value to set Minimum role: pool-operator Published in: XenServer 7.2 (falcon)
void
set_type
(session ref , VMSS ref , enum vmss_type )
Parameters: session ref session_id Reference to a valid session VMSS ref self The snapshot schedule enum vmss_type value the snapshot schedule type Minimum role: pool-operator Published in: XenServer 7.2 (falcon)
string
snapshot_now
(session ref , VMSS ref )
This call executes the snapshot schedule immediately
Parameters: session ref session_id Reference to a valid session VMSS ref vmss Snapshot Schedule to execute Minimum role: pool-operator Result: An XMLRPC result Published in: XenServer 7.2 (falcon) This call executes the snapshot schedule immediately