com.xensource.xenapi

Class VMSS

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VMSS

public class VMSS
extends XenAPIObject

VM Snapshot Schedule First published in XenServer 7.2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VMSS.Record Represents all the fields in a VMSS

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToSchedule(Connection c, java.lang.String key, java.lang.String value) First published in XenServer 7.2.
static VMSS	create(Connection c, VMSS.Record record) Create a new VMSS instance, and return its handle.
static Task	createAsync(Connection c, VMSS.Record record) Create a new VMSS instance, and return its handle.
void	destroy(Connection c) Destroy the specified VMSS instance.
Task	destroyAsync(Connection c) Destroy the specified VMSS instance.
boolean	equals(java.lang.Object obj) If obj is a VMSS, compares XenAPI references for equality.
static java.util.Set<VMSS>	getAll(Connection c) Return a list of all the VMSSs known to the system.
static java.util.Map<VMSS,VMSS.Record>	getAllRecords(Connection c) Return a map of VMSS references to VMSS records for all VMSSs known to the system.
static java.util.Set<VMSS>	getByNameLabel(Connection c, java.lang.String label) Get all the VMSS instances with the given label.
static VMSS	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VMSS instance with the specified UUID.
java.lang.Boolean	getEnabled(Connection c) Get the enabled field of the given VMSS.
Types.VmssFrequency	getFrequency(Connection c) Get the frequency field of the given VMSS.
java.util.Date	getLastRunTime(Connection c) Get the last_run_time field of the given VMSS.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given VMSS.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given VMSS.
VMSS.Record	getRecord(Connection c) Get a record containing the current state of the given VMSS.
java.lang.Long	getRetainedSnapshots(Connection c) Get the retained_snapshots field of the given VMSS.
java.util.Map<java.lang.String,java.lang.String>	getSchedule(Connection c) Get the schedule field of the given VMSS.
Types.VmssType	getType(Connection c) Get the type field of the given VMSS.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VMSS.
java.util.Set<VM>	getVMs(Connection c) Get the VMs field of the given VMSS.
int	hashCode()
void	removeFromSchedule(Connection c, java.lang.String key) First published in XenServer 7.2.
void	setEnabled(Connection c, java.lang.Boolean enabled) Set the enabled field of the given VMSS.
void	setFrequency(Connection c, Types.VmssFrequency value) Set the value of the frequency field First published in XenServer 7.2.
void	setLastRunTime(Connection c, java.util.Date value) First published in XenServer 7.2.
void	setNameDescription(Connection c, java.lang.String description) Set the name/description field of the given VMSS.
void	setNameLabel(Connection c, java.lang.String label) Set the name/label field of the given VMSS.
void	setRetainedSnapshots(Connection c, java.lang.Long value) First published in XenServer 7.2.
void	setSchedule(Connection c, java.util.Map<java.lang.String,java.lang.String> value) First published in XenServer 7.2.
void	setType(Connection c, Types.VmssType value) First published in XenServer 7.2.
java.lang.String	snapshotNow(Connection c) This call executes the snapshot schedule immediately First published in XenServer 7.2.
java.lang.String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a VMSS, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public VMSS.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VMSS. First published in XenServer 7.2.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static VMSS getByUuid(Connection c,
             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a reference to the VMSS instance with the specified UUID. First published in XenServer 7.2.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VMSS.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new VMSS instance, and return its handle. First published in XenServer 7.2.

Parameters:

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VMSS create(Connection c,
          VMSS.Record record)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a new VMSS instance, and return its handle. First published in XenServer 7.2.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified VMSS instance. First published in XenServer 7.2.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Destroy the specified VMSS instance. First published in XenServer 7.2.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

public static java.util.Set<VMSS> getByNameLabel(Connection c,
                                 java.lang.String label)
                                          throws Types.BadServerResponse,
                                                 Types.XenAPIException,
                                                 org.apache.xmlrpc.XmlRpcException

Get all the VMSS instances with the given label. First published in XenServer 7.2.

Parameters:

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

public java.lang.String getNameLabel(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the name/label field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

public java.lang.String getNameDescription(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the name/description field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getEnabled

public java.lang.Boolean getEnabled(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the enabled field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getType

public Types.VmssType getType(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the type field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getRetainedSnapshots

public java.lang.Long getRetainedSnapshots(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the retained_snapshots field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getFrequency

public Types.VmssFrequency getFrequency(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the frequency field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSchedule

public java.util.Map<java.lang.String,java.lang.String> getSchedule(Connection c)
                                                             throws Types.BadServerResponse,
                                                                    Types.XenAPIException,
                                                                    org.apache.xmlrpc.XmlRpcException

Get the schedule field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLastRunTime

public java.util.Date getLastRunTime(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the last_run_time field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVMs

public java.util.Set<VM> getVMs(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the VMs field of the given VMSS. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabel

public void setNameLabel(Connection c,
                java.lang.String label)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Set the name/label field of the given VMSS. First published in XenServer 7.2.

Parameters:

label - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescription

public void setNameDescription(Connection c,
                      java.lang.String description)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Set the name/description field of the given VMSS. First published in XenServer 7.2.

Parameters:

description - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setEnabled

public void setEnabled(Connection c,
              java.lang.Boolean enabled)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Set the enabled field of the given VMSS. First published in XenServer 7.2.

Parameters:

enabled - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

snapshotNow

public java.lang.String snapshotNow(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

This call executes the snapshot schedule immediately First published in XenServer 7.2.

Returns:

An XMLRPC result

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setRetainedSnapshots

public void setRetainedSnapshots(Connection c,
                        java.lang.Long value)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

value - the value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setFrequency

public void setFrequency(Connection c,
                Types.VmssFrequency value)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Set the value of the frequency field First published in XenServer 7.2.

Parameters:

value - the snapshot schedule frequency

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setSchedule

public void setSchedule(Connection c,
               java.util.Map<java.lang.String,java.lang.String> value)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

value - the value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToSchedule

public void addToSchedule(Connection c,
                 java.lang.String key,
                 java.lang.String value)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

key - the key to add

value - the value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromSchedule

public void removeFromSchedule(Connection c,
                      java.lang.String key)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

key - the key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setLastRunTime

public void setLastRunTime(Connection c,
                  java.util.Date value)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

value - the value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setType

public void setType(Connection c,
           Types.VmssType value)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.2.

Parameters:

value - the snapshot schedule type

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<VMSS> getAll(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Return a list of all the VMSSs known to the system. First published in XenServer 7.2.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<VMSS,VMSS.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException

Return a map of VMSS references to VMSS records for all VMSSs known to the system. First published in XenServer 7.2.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException