Package com.xensource.xenapi
Class PVSProxy
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PVSProxy
a proxy connects a VM/VIF with a PVS site
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 PVSProxy -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic PVSProxy
create
(Connection c, PVSSite site, VIF VIF) Configure a VM/VIF to use a PVS proxy Minimum allowed role: pool-operator First published in XenServer 7.1.static Task
createAsync
(Connection c, PVSSite site, VIF VIF) Configure a VM/VIF to use a PVS proxy Minimum allowed role: pool-operator First published in XenServer 7.1.void
remove (or switch off) a PVS proxy for this VM Minimum allowed role: pool-operator First published in XenServer 7.1.remove (or switch off) a PVS proxy for this VM Minimum allowed role: pool-operator First published in XenServer 7.1.boolean
If obj is a PVSProxy, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the PVS_proxys known to the system.static Map<PVSProxy,
PVSProxy.Record> Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.static PVSProxy
getByUuid
(Connection c, String uuid) Get a reference to the PVS_proxy instance with the specified UUID.Get the currently_attached field of the given PVS_proxy.Get a record containing the current state of the given PVS_proxy.Get the site field of the given PVS_proxy.Get the status field of the given PVS_proxy.Get the uuid field of the given PVS_proxy.getVIF
(Connection c) Get the VIF field of the given PVS_proxy.int
hashCode()
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 PVSProxy, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public PVSProxy.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a record containing the current state of the given PVS_proxy. Minimum allowed role: read-only 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 PVSProxy getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the PVS_proxy instance with the specified UUID. Minimum allowed role: read-only 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.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the uuid field of the given PVS_proxy. Minimum allowed role: read-only 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.
-
getSite
public PVSSite getSite(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the site field of the given PVS_proxy. Minimum allowed role: read-only 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.
-
getVIF
public VIF getVIF(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the VIF field of the given PVS_proxy. Minimum allowed role: read-only 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.
-
getCurrentlyAttached
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the currently_attached field of the given PVS_proxy. Minimum allowed role: read-only 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.
-
getStatus
public Types.PvsProxyStatus getStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the status field of the given PVS_proxy. Minimum allowed role: read-only 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.
-
createAsync
public static Task createAsync(Connection c, PVSSite site, VIF VIF) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Configure a VM/VIF to use a PVS proxy Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onsite
- PVS site that we proxy forVIF
- VIF for the VM that needs to be proxied- 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.
-
create
public static PVSProxy create(Connection c, PVSSite site, VIF VIF) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Configure a VM/VIF to use a PVS proxy Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onsite
- PVS site that we proxy forVIF
- VIF for the VM that needs to be proxied- Returns:
- the new PVS proxy
- 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.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException remove (or switch off) a PVS proxy for this VM Minimum allowed role: pool-operator 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.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException remove (or switch off) a PVS proxy for this VM Minimum allowed role: pool-operator 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.
-
getAll
public static Set<PVSProxy> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a list of all the PVS_proxys known to the system. Minimum allowed role: read-only 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<PVSProxy,PVSProxy.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system. Minimum allowed role: read-only 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.
-