com.xensource.xenapi

Class PVSSite

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.PVSSite

public class PVSSite
extends XenAPIObject

machines serving blocks of data for provisioning VMs First published in XenServer 7.1.

Nested Class Summary

Nested Classes

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

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
boolean	equals(java.lang.Object obj) If obj is a PVSSite, compares XenAPI references for equality.
void	forget(Connection c) Remove a site's meta data First published in XenServer 7.1.
Task	forgetAsync(Connection c) Remove a site's meta data First published in XenServer 7.1.
static java.util.Set<PVSSite>	getAll(Connection c) Return a list of all the PVS_sites known to the system.
static java.util.Map<PVSSite,PVSSite.Record>	getAllRecords(Connection c) Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system.
static java.util.Set<PVSSite>	getByNameLabel(Connection c, java.lang.String label) Get all the PVS_site instances with the given label.
static PVSSite	getByUuid(Connection c, java.lang.String uuid) Get a reference to the PVS_site instance with the specified UUID.
java.util.Set<PVSCacheStorage>	getCacheStorage(Connection c) Get the cache_storage field of the given PVS_site.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given PVS_site.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given PVS_site.
java.util.Set<PVSProxy>	getProxies(Connection c) Get the proxies field of the given PVS_site.
java.lang.String	getPVSUuid(Connection c) Get the PVS_uuid field of the given PVS_site.
PVSSite.Record	getRecord(Connection c) Get a record containing the current state of the given PVS_site.
java.util.Set<PVSServer>	getServers(Connection c) Get the servers field of the given PVS_site.
java.lang.String	getUuid(Connection c) Get the uuid field of the given PVS_site.
int	hashCode()
static PVSSite	introduce(Connection c, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String PVSUuid) Introduce new PVS site First published in XenServer 7.1.
static Task	introduceAsync(Connection c, java.lang.String nameLabel, java.lang.String nameDescription, java.lang.String PVSUuid) Introduce new PVS site First published in XenServer 7.1.
void	setNameDescription(Connection c, java.lang.String description) Set the name/description field of the given PVS_site.
void	setNameLabel(Connection c, java.lang.String label) Set the name/label field of the given PVS_site.
void	setPVSUuid(Connection c, java.lang.String value) Update the PVS UUID of the PVS site First published in XenServer 7.1.
Task	setPVSUuidAsync(Connection c, java.lang.String value) Update the PVS UUID of the PVS site First published in XenServer 7.1.
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 PVSSite, 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 PVSSite.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given PVS_site. First published in XenServer 7.1.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the PVS_site instance with the specified UUID. First published in XenServer 7.1.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

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

Get all the PVS_site instances with the given label. First published in XenServer 7.1.

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 PVS_site. First published in XenServer 7.1.

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 PVS_site. First published in XenServer 7.1.

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 PVS_site. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPVSUuid

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

Get the PVS_uuid field of the given PVS_site. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCacheStorage

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

Get the cache_storage field of the given PVS_site. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getServers

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

Get the servers field of the given PVS_site. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getProxies

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

Get the proxies field of the given PVS_site. First published in XenServer 7.1.

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 PVS_site. First published in XenServer 7.1.

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 PVS_site. First published in XenServer 7.1.

Parameters:

description - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduceAsync

public static Task introduceAsync(Connection c,
                  java.lang.String nameLabel,
                  java.lang.String nameDescription,
                  java.lang.String PVSUuid)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Introduce new PVS site First published in XenServer 7.1.

Parameters:

nameLabel - name of the PVS site

nameDescription - description of the PVS site

PVSUuid - unique identifier of the PVS site

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

introduce

public static PVSSite introduce(Connection c,
                java.lang.String nameLabel,
                java.lang.String nameDescription,
                java.lang.String PVSUuid)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Introduce new PVS site First published in XenServer 7.1.

Parameters:

nameLabel - name of the PVS site

nameDescription - description of the PVS site

PVSUuid - unique identifier of the PVS site

Returns:

the new PVS site

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

forgetAsync

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

Remove a site's meta data First published in XenServer 7.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PvsSiteContainsRunningProxies

Types.PvsSiteContainsServers

forget

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

Remove a site's meta data First published in XenServer 7.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PvsSiteContainsRunningProxies

Types.PvsSiteContainsServers

setPVSUuidAsync

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

Update the PVS UUID of the PVS site First published in XenServer 7.1.

Parameters:

value - PVS UUID to be used

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setPVSUuid

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

Update the PVS UUID of the PVS site First published in XenServer 7.1.

Parameters:

value - PVS UUID to be used

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the PVS_sites known to the system. First published in XenServer 7.1.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system. First published in XenServer 7.1.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException