View Source XenAPI.VMSS (XenAPI v0.1.2)

Link to this section Summary

Functions

(Raise error on XMLRPC failure)

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).

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). (Raise error on XMLRPC failure)

Destroy the specified VMSS instance.

Destroy the specified VMSS instance. (Raise error on XMLRPC failure)

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

Return a list of all the VMSSs known to the system. (Raise error on XMLRPC failure)

Return a map of VMSS references to VMSS records for all VMSSs known to the system.

Return a map of VMSS references to VMSS records for all VMSSs known to the system. (Raise error on XMLRPC failure)

Get all the VMSS instances with the given label.

Get all the VMSS instances with the given label. (Raise error on XMLRPC failure)

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

Get a reference to the VMSS instance with the specified UUID. (Raise error on XMLRPC failure)

Get the enabled field of the given VMSS.

Get the enabled field of the given VMSS. (Raise error on XMLRPC failure)

Get the frequency field of the given VMSS.

Get the frequency field of the given VMSS. (Raise error on XMLRPC failure)

Get the last_run_time field of the given VMSS.

Get the last_run_time field of the given VMSS. (Raise error on XMLRPC failure)

Get the name/description field of the given VMSS.

Get the name/description field of the given VMSS. (Raise error on XMLRPC failure)

Get the name/label field of the given VMSS.

Get the name/label field of the given VMSS. (Raise error on XMLRPC failure)

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

Get a record containing the current state of the given VMSS. (Raise error on XMLRPC failure)

Get the retained_snapshots field of the given VMSS.

Get the retained_snapshots field of the given VMSS. (Raise error on XMLRPC failure)

Get the schedule field of the given VMSS.

Get the schedule field of the given VMSS. (Raise error on XMLRPC failure)

Get the type field of the given VMSS.

Get the type field of the given VMSS. (Raise error on XMLRPC failure)

Get the uuid field of the given VMSS.

Get the uuid field of the given VMSS. (Raise error on XMLRPC failure)

Get the VMs field of the given VMSS.

Get the VMs field of the given VMSS. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the enabled field of the given VMSS.

Set the enabled field of the given VMSS. (Raise error on XMLRPC failure)

Set the value of the frequency field

Set the value of the frequency field (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the name/description field of the given VMSS.

Set the name/description field of the given VMSS. (Raise error on XMLRPC failure)

Set the name/label field of the given VMSS.

Set the name/label field of the given VMSS. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

This call executes the snapshot schedule immediately

This call executes the snapshot schedule immediately (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_schedule(xen_session, vmss_ref, key, value)

View Source
Link to this function

add_to_schedule!(xen_session, vmss_ref, key, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

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).

Link to this function

create!(xen_session, args)

View Source

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). (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, vmss_ref)

View Source

Destroy the specified VMSS instance.

Link to this function

destroy!(xen_session, vmss_ref)

View Source

Destroy the specified VMSS instance. (Raise error on XMLRPC failure)

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

Return a list of all the VMSSs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VMSS references to VMSS records for all VMSSs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VMSS references to VMSS records for all VMSSs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the VMSS instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the VMSS instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VMSS instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_enabled(xen_session, vmss_ref)

View Source

Get the enabled field of the given VMSS.

Link to this function

get_enabled!(xen_session, vmss_ref)

View Source

Get the enabled field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_frequency(xen_session, vmss_ref)

View Source

Get the frequency field of the given VMSS.

Link to this function

get_frequency!(xen_session, vmss_ref)

View Source

Get the frequency field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_last_run_time(xen_session, vmss_ref)

View Source

Get the last_run_time field of the given VMSS.

Link to this function

get_last_run_time!(xen_session, vmss_ref)

View Source

Get the last_run_time field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, vmss_ref)

View Source

Get the name/description field of the given VMSS.

Link to this function

get_name_description!(xen_session, vmss_ref)

View Source

Get the name/description field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, vmss_ref)

View Source

Get the name/label field of the given VMSS.

Link to this function

get_name_label!(xen_session, vmss_ref)

View Source

Get the name/label field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vmss_ref)

View Source

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

Link to this function

get_record!(xen_session, vmss_ref)

View Source

Get a record containing the current state of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_retained_snapshots(xen_session, vmss_ref)

View Source

Get the retained_snapshots field of the given VMSS.

Link to this function

get_retained_snapshots!(xen_session, vmss_ref)

View Source

Get the retained_snapshots field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_schedule(xen_session, vmss_ref)

View Source

Get the schedule field of the given VMSS.

Link to this function

get_schedule!(xen_session, vmss_ref)

View Source

Get the schedule field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_type(xen_session, vmss_ref)

View Source

Get the type field of the given VMSS.

Link to this function

get_type!(xen_session, vmss_ref)

View Source

Get the type field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vmss_ref)

View Source

Get the uuid field of the given VMSS.

Link to this function

get_uuid!(xen_session, vmss_ref)

View Source

Get the uuid field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

get_VMs(xen_session, vmss_ref)

View Source

Get the VMs field of the given VMSS.

Link to this function

get_VMs!(xen_session, vmss_ref)

View Source

Get the VMs field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

remove_from_schedule(xen_session, vmss_ref, key)

View Source
Link to this function

remove_from_schedule!(xen_session, vmss_ref, key)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_enabled(xen_session, vmss_ref, value)

View Source

Set the enabled field of the given VMSS.

Link to this function

set_enabled!(xen_session, vmss_ref, value)

View Source

Set the enabled field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

set_frequency(xen_session, vmss_ref, value)

View Source

Set the value of the frequency field

Link to this function

set_frequency!(xen_session, vmss_ref, value)

View Source

Set the value of the frequency field (Raise error on XMLRPC failure)

Link to this function

set_last_run_time(xen_session, vmss_ref, value)

View Source
Link to this function

set_last_run_time!(xen_session, vmss_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, vmss_ref, value)

View Source

Set the name/description field of the given VMSS.

Link to this function

set_name_description!(xen_session, vmss_ref, value)

View Source

Set the name/description field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, vmss_ref, value)

View Source

Set the name/label field of the given VMSS.

Link to this function

set_name_label!(xen_session, vmss_ref, value)

View Source

Set the name/label field of the given VMSS. (Raise error on XMLRPC failure)

Link to this function

set_retained_snapshots(xen_session, vmss_ref, value)

View Source
Link to this function

set_retained_snapshots!(xen_session, vmss_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_schedule(xen_session, vmss_ref, value)

View Source
Link to this function

set_schedule!(xen_session, vmss_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_type(xen_session, vmss_ref, value)

View Source
Link to this function

set_type!(xen_session, vmss_ref, value)

View Source

(Raise error on XMLRPC failure)

Link to this function

snapshot_now(xen_session, vmss)

View Source

This call executes the snapshot schedule immediately

Link to this function

snapshot_now!(xen_session, vmss)

View Source

This call executes the snapshot schedule immediately (Raise error on XMLRPC failure)