Package com.xensource.xenapi
Class PVSSite
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PVSSite
machines serving blocks of data for provisioning VMs
First published in XenServer 7.1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a PVSSite -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
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.Remove a site's meta data First published in XenServer 7.1.getAll
(Connection c) Return a list of all the PVS_sites known to the system.static Map<PVSSite,
PVSSite.Record> Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system.getByNameLabel
(Connection c, String label) Get all the PVS_site instances with the given label.static PVSSite
getByUuid
(Connection c, String uuid) Get a reference to the PVS_site instance with the specified UUID.Get the cache_storage field of the given PVS_site.Get the name/description field of the given PVS_site.Get the name/label field of the given PVS_site.Get the proxies field of the given PVS_site.Get the PVS_uuid field of the given PVS_site.Get a record containing the current state of the given PVS_site.Get the servers field of the given PVS_site.Get the uuid field of the given PVS_site.int
hashCode()
static PVSSite
introduce
(Connection c, String nameLabel, String nameDescription, String PVSUuid) Introduce new PVS site First published in XenServer 7.1.static Task
introduceAsync
(Connection c, String nameLabel, String nameDescription, String PVSUuid) Introduce new PVS site First published in XenServer 7.1.void
setNameDescription
(Connection c, String description) Set the name/description field of the given PVS_site.void
setNameLabel
(Connection c, String label) Set the name/label field of the given PVS_site.void
setPVSUuid
(Connection c, String value) Update the PVS UUID of the PVS site First published in XenServer 7.1.setPVSUuidAsync
(Connection c, String value) Update the PVS UUID of the PVS site First published in XenServer 7.1.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a PVSSite, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static PVSSite getByUuid(Connection c, 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:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByNameLabel
public static Set<PVSSite> getByNameLabel(Connection c, 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:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getNameLabel
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getNameDescription
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getPVSUuid
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getCacheStorage
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getServers
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getProxies
public 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.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameLabel
public void setNameLabel(Connection c, 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:
c
- The connection the call is made onlabel
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setNameDescription
public void setNameDescription(Connection c, 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:
c
- The connection the call is made ondescription
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduceAsync
public static Task introduceAsync(Connection c, String nameLabel, String nameDescription, String PVSUuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Introduce new PVS site First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onnameLabel
- name of the PVS sitenameDescription
- description of the PVS sitePVSUuid
- unique identifier of the PVS site- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
introduce
public static PVSSite introduce(Connection c, String nameLabel, String nameDescription, String PVSUuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Introduce new PVS site First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onnameLabel
- name of the PVS sitenameDescription
- description of the PVS sitePVSUuid
- unique identifier of the PVS site- Returns:
- the new PVS site
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
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.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.PvsSiteContainsRunningProxies
- The PVS site contains running proxies.Types.PvsSiteContainsServers
- The PVS site contains servers and cannot be forgotten.
-
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.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.Types.PvsSiteContainsRunningProxies
- The PVS site contains running proxies.Types.PvsSiteContainsServers
- The PVS site contains servers and cannot be forgotten.
-
setPVSUuidAsync
public Task setPVSUuidAsync(Connection c, 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:
c
- The connection the call is made onvalue
- PVS UUID to be used- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
setPVSUuid
public void setPVSUuid(Connection c, 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:
c
- The connection the call is made onvalue
- PVS UUID to be used- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAll
public static 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.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static 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.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-