public class PVSSite extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
PVSSite.Record
Represents all the fields in a PVSSite
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
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() |
isNull
protected final java.lang.String ref
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public PVSSite.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public static PVSSite getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onuuid
- UUID of object to returnTypes.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.public static java.util.Set<PVSSite> getByNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onlabel
- label of object to returnTypes.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.public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.lang.String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.lang.String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.lang.String getPVSUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.util.Set<PVSCacheStorage> getCacheStorage(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.util.Set<PVSServer> getServers(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public java.util.Set<PVSProxy> getProxies(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public void setNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onlabel
- New value to setTypes.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.public void setNameDescription(Connection c, java.lang.String description) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made ondescription
- New value to setTypes.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.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
c
- The connection the call is made onnameLabel
- name of the PVS sitenameDescription
- description of the PVS sitePVSUuid
- unique identifier of the PVS siteTypes.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.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
c
- The connection the call is made onnameLabel
- name of the PVS sitenameDescription
- description of the PVS sitePVSUuid
- unique identifier of the PVS siteTypes.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.public Task forgetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.PvsSiteContainsRunningProxies, Types.PvsSiteContainsServers
c
- The connection the call is made onTypes.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.public void forget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.PvsSiteContainsRunningProxies, Types.PvsSiteContainsServers
c
- The connection the call is made onTypes.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.public Task setPVSUuidAsync(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- PVS UUID to be usedTypes.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.public void setPVSUuid(Connection c, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onvalue
- PVS UUID to be usedTypes.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.public static java.util.Set<PVSSite> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.public static java.util.Map<PVSSite,PVSSite.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
c
- The connection the call is made onTypes.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.