PGPU

java.lang.Object
- com.xensource.xenapi.XenAPIObject
- - com.xensource.xenapi.PGPU

```
public class PGPU
extends XenAPIObject
```
A physical GPU (pGPU) First published in XenServer 6.0.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PGPU.Record
Represents all the fields in a PGPU

Nested Classes
Modifier and Type	Class and Description
`static class`	`PGPU.Record` Represents all the fields in a PGPU

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

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`	`addEnabledVGPUTypes(Connection c, VGPUType value)` First published in XenServer 6.2 SP1 Tech-Preview.
`Task`	`addEnabledVGPUTypesAsync(Connection c, VGPUType value)` First published in XenServer 6.2 SP1 Tech-Preview.
`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 PGPU.
`Types.PgpuDom0Access`	`disableDom0Access(Connection c)` First published in XenServer 6.5 SP1.
`Task`	`disableDom0AccessAsync(Connection c)` First published in XenServer 6.5 SP1.
`Types.PgpuDom0Access`	`enableDom0Access(Connection c)` First published in XenServer 6.5 SP1.
`Task`	`enableDom0AccessAsync(Connection c)` First published in XenServer 6.5 SP1.
`boolean`	`equals(java.lang.Object obj)` If obj is a PGPU, compares XenAPI references for equality.
`static java.util.Set<PGPU>`	`getAll(Connection c)` Return a list of all the PGPUs known to the system.
`static java.util.Map<PGPU,PGPU.Record>`	`getAllRecords(Connection c)` Return a map of PGPU references to PGPU records for all PGPUs known to the system.
`static PGPU`	`getByUuid(Connection c, java.lang.String uuid)` Get a reference to the PGPU 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 PGPU.
`Types.PgpuDom0Access`	`getDom0Access(Connection c)` Get the dom0_access field of the given PGPU.
`java.util.Set<VGPUType>`	`getEnabledVGPUTypes(Connection c)` Get the enabled_VGPU_types field of the given PGPU.
`GPUGroup`	`getGPUGroup(Connection c)` Get the GPU_group field of the given PGPU.
`Host`	`getHost(Connection c)` Get the host field of the given PGPU.
`java.lang.Boolean`	`getIsSystemDisplayDevice(Connection c)` Get the is_system_display_device field of the given PGPU.
`java.util.Map<java.lang.String,java.lang.String>`	`getOtherConfig(Connection c)` Get the other_config field of the given PGPU.
`PCI`	`getPCI(Connection c)` Get the PCI field of the given PGPU.
`PGPU.Record`	`getRecord(Connection c)` Get a record containing the current state of the given PGPU.
`java.lang.Long`	`getRemainingCapacity(Connection c, VGPUType vgpuType)` First published in XenServer 6.2 SP1 Tech-Preview.
`Task`	`getRemainingCapacityAsync(Connection c, VGPUType vgpuType)` First published in XenServer 6.2 SP1 Tech-Preview.
`java.util.Set<VGPU>`	`getResidentVGPUs(Connection c)` Get the resident_VGPUs field of the given PGPU.
`java.util.Map<VGPUType,java.lang.Long>`	`getSupportedVGPUMaxCapacities(Connection c)` Get the supported_VGPU_max_capacities field of the given PGPU.
`java.util.Set<VGPUType>`	`getSupportedVGPUTypes(Connection c)` Get the supported_VGPU_types field of the given PGPU.
`java.lang.String`	`getUuid(Connection c)` Get the uuid field of the given PGPU.
`int`	`hashCode()`
`void`	`removeEnabledVGPUTypes(Connection c, VGPUType value)` First published in XenServer 6.2 SP1 Tech-Preview.
`Task`	`removeEnabledVGPUTypesAsync(Connection c, VGPUType value)` First published in XenServer 6.2 SP1 Tech-Preview.
`void`	`removeFromOtherConfig(Connection c, java.lang.String key)` Remove the given key and its corresponding value from the other_config field of the given PGPU.
`void`	`setEnabledVGPUTypes(Connection c, java.util.Set<VGPUType> value)` First published in XenServer 6.2 SP1 Tech-Preview.
`Task`	`setEnabledVGPUTypesAsync(Connection c, java.util.Set<VGPUType> value)` First published in XenServer 6.2 SP1 Tech-Preview.
`void`	`setGPUGroup(Connection c, GPUGroup value)` First published in XenServer 6.2 SP1 Tech-Preview.
`Task`	`setGPUGroupAsync(Connection c, GPUGroup value)` First published in XenServer 6.2 SP1 Tech-Preview.
`void`	`setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)` Set the other_config field of the given PGPU.
`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 PGPU, 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 PGPU.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

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

Returns:: all fields from the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the PGPU 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 PGPU. First published in XenServer 6.0.

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

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Get the host field of the given PGPU. 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 PGPU. First published in XenServer 6.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getSupportedVGPUTypes

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

Get the supported_VGPU_types field of the given PGPU. First published in XenServer 6.2 SP1 Tech-Preview.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getEnabledVGPUTypes

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

Get the enabled_VGPU_types field of the given PGPU. First published in XenServer 6.2 SP1 Tech-Preview.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getResidentVGPUs

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

Get the resident_VGPUs field of the given PGPU. First published in XenServer 6.2 SP1 Tech-Preview.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getSupportedVGPUMaxCapacities

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

Get the supported_VGPU_max_capacities field of the given PGPU. First published in XenServer 6.2 SP1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getDom0Access

public Types.PgpuDom0Access getDom0Access(Connection c)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException

Get the dom0_access field of the given PGPU. First published in XenServer 6.5 SP1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getIsSystemDisplayDevice

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

Get the is_system_display_device field of the given PGPU. First published in XenServer 6.5 SP1.

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

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 PGPU. 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 PGPU. 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 PGPU. 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