Class: VMSS

Last published : Oct 01, 2026
VM Snapshot Schedule
Related information
XenServer 8.4 Management API

Fields for class: VMSS

Field Type Qualifier Description
enabled bool RW enable or disable this snapshot schedule
frequency vmss_frequency RO/constructor frequency of taking snapshot from snapshot schedule
last_run_time datetime RO/runtime time of the last snapshot
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
retained_snapshots int RO/constructor maximum number of snapshots that should be stored at any time
schedule (string -> string) map RO/constructor schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
type vmss_type RO/constructor type of the snapshot schedule
uuid string RO/runtime Unique identifier/object reference
VMs VM ref set RO/runtime all VMs attached to this snapshot schedule

RPCs associated with class: VMSS

RPC name: addtoschedule

Overview:
Signature:
void add_to_schedule (session ref session_ref, VMSS ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref 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
Return Type: void

RPC name: create

Overview:
Create a new VMSS instance, and return its handle.
Signature:
VMSS ref create (session ref session_ref, VMSS record args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS record args All constructor arguments
Minimum Role: pool-operator
Return Type: VMSS ref
reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified VMSS instance.
Signature:
void destroy (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the VMSSs known to the system.
Signature:
VMSS ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: VMSS ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of VMSS references to VMSS records for all VMSSs known to the system.
Signature:
(VMSS ref -> VMSS record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (VMSS ref -> VMSS record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the VMSS instances with the given label.
Signature:
VMSS ref set get_by_name_label (session ref session_ref, string label)
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: VMSS ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the VMSS instance with the specified UUID.
Signature:
VMSS ref get_by_uuid (session ref session_ref, string uuid)
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: VMSS ref
reference to the object

RPC name: getenabled

Overview:
Get the enabled field of the given VMSS.
Signature:
bool get_enabled (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getfrequency

Overview:
Get the frequency field of the given VMSS.
Signature:
vmss_frequency get_frequency (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: vmss_frequency
value of the field

RPC name: getlastruntime

Overview:
Get the lastruntime field of the given VMSS.
Signature:
datetime get_last_run_time (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getnamedescription

Overview:
Get the name/description field of the given VMSS.
Signature:
string get_name_description (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamelabel

Overview:
Get the name/label field of the given VMSS.
Signature:
string get_name_label (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given VMSS.
Signature:
VMSS record get_record (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: VMSS record
all fields from the object

RPC name: getretainedsnapshots

Overview:
Get the retainedsnapshots field of the given VMSS.
Signature:
int get_retained_snapshots (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getschedule

Overview:
Get the schedule field of the given VMSS.
Signature:
(string -> string) map get_schedule (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: gettype

Overview:
Get the type field of the given VMSS.
Signature:
vmss_type get_type (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: vmss_type
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given VMSS.
Signature:
string get_uuid (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getVMs

Overview:
Get the VMs field of the given VMSS.
Signature:
VM ref set get_VMs (session ref session_ref, VMSS ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
Minimum Role: read-only
Return Type: VM ref set
value of the field

RPC name: removefromschedule

Overview:
Signature:
void remove_from_schedule (session ref session_ref, VMSS ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The snapshot schedule
string key the key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setenabled

Overview:
Set the enabled field of the given VMSS.
Signature:
void set_enabled (session ref session_ref, VMSS ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
bool value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setfrequency

Overview:
Set the value of the frequency field
Signature:
void set_frequency (session ref session_ref, VMSS ref self, vmss_frequency value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The snapshot schedule
vmss_frequency value the snapshot schedule frequency
Minimum Role: pool-operator
Return Type: void

RPC name: setlastruntime

Overview:
Signature:
void set_last_run_time (session ref session_ref, VMSS ref self, datetime value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The snapshot schedule
datetime value The time at which the schedule was last run. When the timezone is missing, UTC is assumed
Return Type: void

RPC name: setnamedescription

Overview:
Set the name/description field of the given VMSS.
Signature:
void set_name_description (session ref session_ref, VMSS ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given VMSS.
Signature:
void set_name_label (session ref session_ref, VMSS ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setretainedsnapshots

Overview:
Signature:
void set_retained_snapshots (session ref session_ref, VMSS ref self, int value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The schedule snapshot
int value the value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setschedule

Overview:
Signature:
void set_schedule (session ref session_ref, VMSS ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The snapshot schedule
(string -> string) map value the value to set
Minimum Role: pool-operator
Return Type: void

RPC name: settype

Overview:
Signature:
void set_type (session ref session_ref, VMSS ref self, vmss_type value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref self The snapshot schedule
vmss_type value the snapshot schedule type
Minimum Role: pool-operator
Return Type: void

RPC name: snapshotnow

Overview:
This call executes the snapshot schedule immediately
Signature:
string snapshot_now (session ref session_ref, VMSS ref vmss)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VMSS ref vmss Snapshot Schedule to execute
Minimum Role: pool-operator
Return Type: string
An XMLRPC result