com.xensource.xenapi

Class VGPU

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VGPU

public class VGPU
extends XenAPIObject

A virtual GPU (vGPU) First published in XenServer 6.0.

Nested Class Summary

Nested Classes

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

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
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given VGPU.
static VGPU	create(Connection c, VM VM, GPUGroup GPUGroup, java.lang.String device, java.util.Map<java.lang.String,java.lang.String> otherConfig) First published in XenServer 6.0.
static VGPU	create(Connection c, VM VM, GPUGroup GPUGroup, java.lang.String device, java.util.Map<java.lang.String,java.lang.String> otherConfig, VGPUType type) First published in XenServer 6.0.
static Task	createAsync(Connection c, VM VM, GPUGroup GPUGroup, java.lang.String device, java.util.Map<java.lang.String,java.lang.String> otherConfig) First published in XenServer 6.0.
static Task	createAsync(Connection c, VM VM, GPUGroup GPUGroup, java.lang.String device, java.util.Map<java.lang.String,java.lang.String> otherConfig, VGPUType type) First published in XenServer 6.0.
void	destroy(Connection c) First published in XenServer 6.0.
Task	destroyAsync(Connection c) First published in XenServer 6.0.
boolean	equals(java.lang.Object obj) If obj is a VGPU, compares XenAPI references for equality.
static java.util.Set<VGPU>	getAll(Connection c) Return a list of all the VGPUs known to the system.
static java.util.Map<VGPU,VGPU.Record>	getAllRecords(Connection c) Return a map of VGPU references to VGPU records for all VGPUs known to the system.
static VGPU	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VGPU instance with the specified UUID.
java.util.Map<java.lang.String,java.lang.String>	getCompatibilityMetadata(Connection c) Get the compatibility_metadata field of the given VGPU.
java.lang.Boolean	getCurrentlyAttached(Connection c) Get the currently_attached field of the given VGPU.
java.lang.String	getDevice(Connection c) Get the device field of the given VGPU.
java.lang.String	getExtraArgs(Connection c) Get the extra_args field of the given VGPU.
GPUGroup	getGPUGroup(Connection c) Get the GPU_group field of the given VGPU.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given VGPU.
PCI	getPCI(Connection c) Get the PCI field of the given VGPU.
VGPU.Record	getRecord(Connection c) Get a record containing the current state of the given VGPU.
PGPU	getResidentOn(Connection c) Get the resident_on field of the given VGPU.
PGPU	getScheduledToBeResidentOn(Connection c) Get the scheduled_to_be_resident_on field of the given VGPU.
VGPUType	getType(Connection c) Get the type field of the given VGPU.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VGPU.
VM	getVM(Connection c) Get the VM field of the given VGPU.
int	hashCode()
void	removeFromOtherConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the other_config field of the given VGPU.
void	setExtraArgs(Connection c, java.lang.String extraArgs) Set the extra_args field of the given VGPU.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given VGPU.
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 VGPU, 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 VGPU.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VGPU. First published in XenServer 6.0.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the VGPU instance with the specified UUID. First published in XenServer 6.0.

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the VM field of the given VGPU. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getGPUGroup

public GPUGroup getGPUGroup(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get the GPU_group field of the given VGPU. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getDevice

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

Get the device field of the given VGPU. First published in XenServer 6.0.

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given VGPU. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getType

public VGPUType getType(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Get the type field of the given VGPU. First published in XenServer 6.2 SP1 Tech-Preview.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getResidentOn

public PGPU getResidentOn(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Get the resident_on field of the given VGPU. First published in XenServer 6.2 SP1 Tech-Preview.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getScheduledToBeResidentOn

public PGPU getScheduledToBeResidentOn(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the scheduled_to_be_resident_on field of the given VGPU. First published in XenServer 7.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCompatibilityMetadata

public java.util.Map<java.lang.String,java.lang.String> getCompatibilityMetadata(Connection c)
                                                                          throws Types.BadServerResponse,
                                                                                 Types.XenAPIException,
                                                                                 org.apache.xmlrpc.XmlRpcException

Get the compatibility_metadata field of the given VGPU. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getExtraArgs

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

Get the extra_args field of the given VGPU. First published in Citrix Hypervisor 8.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPCI

public PCI getPCI(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the PCI field of the given VGPU. First published in Citrix Hypervisor 8.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given VGPU. First published in XenServer 6.0.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

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

Add the given key-value pair to the other_config field of the given VGPU. First published in XenServer 6.0.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

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

Remove the given key and its corresponding value from the other_config field of the given VGPU. If the key is not in that Map, then do nothing. First published in XenServer 6.0.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setExtraArgs

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

Set the extra_args field of the given VGPU. First published in Citrix Hypervisor 8.1.

Parameters:

extraArgs - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VM VM,
               GPUGroup GPUGroup,
               java.lang.String device,
               java.util.Map<java.lang.String,java.lang.String> otherConfig)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

First published in XenServer 6.0.

Parameters:

VM -

GPUGroup -

device -

otherConfig -

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VGPU create(Connection c,
          VM VM,
          GPUGroup GPUGroup,
          java.lang.String device,
          java.util.Map<java.lang.String,java.lang.String> otherConfig)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

First published in XenServer 6.0.

Parameters:

VM -

GPUGroup -

device -

otherConfig -

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VM VM,
               GPUGroup GPUGroup,
               java.lang.String device,
               java.util.Map<java.lang.String,java.lang.String> otherConfig,
               VGPUType type)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

First published in XenServer 6.0.

Parameters:

VM -

GPUGroup -

device -

otherConfig -

type - First published in XenServer 6.2 SP1 Tech-Preview.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VGPU create(Connection c,
          VM VM,
          GPUGroup GPUGroup,
          java.lang.String device,
          java.util.Map<java.lang.String,java.lang.String> otherConfig,
          VGPUType type)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

First published in XenServer 6.0.

Parameters:

VM -

GPUGroup -

device -

otherConfig -

type - First published in XenServer 6.2 SP1 Tech-Preview.

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

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

First published in XenServer 6.0.

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

First published in XenServer 6.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the VGPUs known to the system. First published in XenServer 6.0.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of VGPU references to VGPU records for all VGPUs known to the system. First published in XenServer 6.0.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException