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

Class: VMSS

October 11, 2024
Contributed by: 
X X

VM Snapshot Schedule

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: add_to_schedule

Overview:

Signature:

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

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)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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: get_all

Overview:

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

Signature:

VMSS 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: VMSS ref set

references to all objects

RPC name: get_all_records

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)
<!--NeedCopy-->

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: get_by_name_label

Overview:

Get all the VMSS instances with the given label.

Signature:

VMSS 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: VMSS ref set

references to objects with matching names

RPC name: get_by_uuid

Overview:

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

Signature:

VMSS 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: VMSS ref

reference to the object

RPC name: get_enabled

Overview:

Get the enabled field of the given VMSS.

Signature:

bool get_enabled (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_frequency

Overview:

Get the frequency field of the given VMSS.

Signature:

vmss_frequency get_frequency (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_last_run_time

Overview:

Get the last_run_time field of the given VMSS.

Signature:

datetime get_last_run_time (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_name_description

Overview:

Get the name/description field of the given VMSS.

Signature:

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

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: get_name_label

Overview:

Get the name/label field of the given VMSS.

Signature:

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

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: get_record

Overview:

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

Signature:

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

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: get_retained_snapshots

Overview:

Get the retained_snapshots field of the given VMSS.

Signature:

int get_retained_snapshots (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_schedule

Overview:

Get the schedule field of the given VMSS.

Signature:

(string -> string) map get_schedule (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_type

Overview:

Get the type field of the given VMSS.

Signature:

vmss_type get_type (session ref session_ref, VMSS ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given VMSS.

Signature:

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

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: get_VMs

Overview:

Get the VMs field of the given VMSS.

Signature:

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

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: remove_from_schedule

Overview:

Signature:

void remove_from_schedule (session ref session_ref, VMSS ref self, string key)
<!--NeedCopy-->

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: set_enabled

Overview:

Set the enabled field of the given VMSS.

Signature:

void set_enabled (session ref session_ref, VMSS ref self, bool value)
<!--NeedCopy-->

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: set_frequency

Overview:

Set the value of the frequency field

Signature:

void set_frequency (session ref session_ref, VMSS ref self, vmss_frequency value)
<!--NeedCopy-->

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: set_last_run_time

Overview:

Signature:

void set_last_run_time (session ref session_ref, VMSS ref self, datetime value)
<!--NeedCopy-->

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: set_name_description

Overview:

Set the name/description field of the given VMSS.

Signature:

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

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: set_name_label

Overview:

Set the name/label field of the given VMSS.

Signature:

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

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: set_retained_snapshots

Overview:

Signature:

void set_retained_snapshots (session ref session_ref, VMSS ref self, int value)
<!--NeedCopy-->

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: set_schedule

Overview:

Signature:

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

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: set_type

Overview:

Signature:

void set_type (session ref session_ref, VMSS ref self, vmss_type value)
<!--NeedCopy-->

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: snapshot_now

Overview:

This call executes the snapshot schedule immediately

Signature:

string snapshot_now (session ref session_ref, VMSS ref vmss)
<!--NeedCopy-->

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

Class: VMSS
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.