com.xensource.xenapi

Class PVSProxy

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.PVSProxy

public class PVSProxy
extends XenAPIObject

a proxy connects a VM/VIF with a PVS site First published in XenServer 7.1.

Nested Class Summary

Nested Classes

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

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
static PVSProxy	create(Connection c, PVSSite site, VIF VIF) Configure a VM/VIF to use a PVS proxy First published in XenServer 7.1.
static Task	createAsync(Connection c, PVSSite site, VIF VIF) Configure a VM/VIF to use a PVS proxy First published in XenServer 7.1.
void	destroy(Connection c) remove (or switch off) a PVS proxy for this VM First published in XenServer 7.1.
Task	destroyAsync(Connection c) remove (or switch off) a PVS proxy for this VM First published in XenServer 7.1.
boolean	equals(java.lang.Object obj) If obj is a PVSProxy, compares XenAPI references for equality.
static java.util.Set<PVSProxy>	getAll(Connection c) Return a list of all the PVS_proxys known to the system.
static java.util.Map<PVSProxy,PVSProxy.Record>	getAllRecords(Connection c) Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.
static PVSProxy	getByUuid(Connection c, java.lang.String uuid) Get a reference to the PVS_proxy instance with the specified UUID.
java.lang.Boolean	getCurrentlyAttached(Connection c) Get the currently_attached field of the given PVS_proxy.
PVSProxy.Record	getRecord(Connection c) Get a record containing the current state of the given PVS_proxy.
PVSSite	getSite(Connection c) Get the site field of the given PVS_proxy.
Types.PvsProxyStatus	getStatus(Connection c) Get the status field of the given PVS_proxy.
java.lang.String	getUuid(Connection c) Get the uuid field of the given PVS_proxy.
VIF	getVIF(Connection c) Get the VIF field of the given PVS_proxy.
int	hashCode()
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 PVSProxy, 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 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. First published in XenServer 7.1.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the PVS_proxy 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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSite

public PVSSite getSite(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Get the site field of the given PVS_proxy. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVIF

public VIF getVIF(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the VIF field of the given PVS_proxy. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentlyAttached

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

Get the currently_attached field of the given PVS_proxy. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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

Parameters:

site - PVS site that we proxy for

VIF - VIF for the VM that needs to be proxied

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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

Parameters:

site - PVS site that we proxy for

VIF - VIF for the VM that needs to be proxied

Returns:

the new PVS proxy

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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

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

remove (or switch off) a PVS proxy for this VM First published in XenServer 7.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.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. 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<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. First published in XenServer 7.1.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException