Package com.xensource.xenapi
Class PGPU
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PGPU
A physical GPU (pGPU)
First published in XenServer 6.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEnabledVGPUTypes
(Connection c, VGPUType value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.addEnabledVGPUTypesAsync
(Connection c, VGPUType value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given PGPU.Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.boolean
If obj is a PGPU, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the PGPUs known to the system.static Map<PGPU,
PGPU.Record> Return a map of PGPU references to PGPU records for all PGPUs known to the system.static PGPU
getByUuid
(Connection c, String uuid) Get a reference to the PGPU instance with the specified UUID.Get the compatibility_metadata field of the given PGPU.Get the dom0_access field of the given PGPU.Get the enabled_VGPU_types field of the given PGPU.Get the GPU_group field of the given PGPU.Get the host field of the given PGPU.Get the is_system_display_device field of the given PGPU.Get the other_config field of the given PGPU.getPCI
(Connection c) Get the PCI field of the given PGPU.Get a record containing the current state of the given PGPU.getRemainingCapacity
(Connection c, VGPUType vgpuType) Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.getRemainingCapacityAsync
(Connection c, VGPUType vgpuType) Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.Get the resident_VGPUs field of the given PGPU.Get the supported_VGPU_max_capacities field of the given PGPU.Get the supported_VGPU_types field of the given PGPU.Get the uuid field of the given PGPU.int
hashCode()
void
removeEnabledVGPUTypes
(Connection c, VGPUType value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.removeEnabledVGPUTypesAsync
(Connection c, VGPUType value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given PGPU.void
setEnabledVGPUTypes
(Connection c, Set<VGPUType> value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.setEnabledVGPUTypesAsync
(Connection c, Set<VGPUType> value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.void
setGPUGroup
(Connection c, GPUGroup value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.setGPUGroupAsync
(Connection c, GPUGroup value) Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given PGPU.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 PGPU, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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. Minimum allowed role: read-only First published in XenServer 6.0.- 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 PGPU getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the PGPU instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 6.0.- 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 PGPU. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-
getPCI
public PCI getPCI(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the PCI field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-
getGPUGroup
public GPUGroup getGPUGroup(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the GPU_group field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-
getHost
public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the host field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the other_config field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-
getSupportedVGPUTypes
public Set<VGPUType> getSupportedVGPUTypes(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the supported_VGPU_types field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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.
-
getEnabledVGPUTypes
public Set<VGPUType> getEnabledVGPUTypes(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the enabled_VGPU_types field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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.
-
getResidentVGPUs
public Set<VGPU> getResidentVGPUs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the resident_VGPUs field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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.
-
getSupportedVGPUMaxCapacities
public Map<VGPUType,Long> getSupportedVGPUMaxCapacities(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the supported_VGPU_max_capacities field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.2 SP1.- 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.
-
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. Minimum allowed role: read-only First published in XenServer 6.5 SP1.- 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.
-
getIsSystemDisplayDevice
public Boolean getIsSystemDisplayDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the is_system_display_device field of the given PGPU. Minimum allowed role: read-only First published in XenServer 6.5 SP1.- 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.
-
getCompatibilityMetadata
public Map<String,String> getCompatibilityMetadata(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the compatibility_metadata field of the given PGPU. Minimum allowed role: read-only First published in XenServer 7.3.- 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.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionSet the other_config field of the given PGPU. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onotherConfig
- New value to set- 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.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, 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. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- 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.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, 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. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- 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.
-
addEnabledVGPUTypesAsync
public Task addEnabledVGPUTypesAsync(Connection c, VGPUType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU type to enable- 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.
-
addEnabledVGPUTypes
public void addEnabledVGPUTypes(Connection c, VGPUType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU type to enable- 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.
-
removeEnabledVGPUTypesAsync
public Task removeEnabledVGPUTypesAsync(Connection c, VGPUType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU type to disable- 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.
-
removeEnabledVGPUTypes
public void removeEnabledVGPUTypes(Connection c, VGPUType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU type to disable- 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.
-
setEnabledVGPUTypesAsync
public Task setEnabledVGPUTypesAsync(Connection c, Set<VGPUType> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU types to enable- 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.
-
setEnabledVGPUTypes
public void setEnabledVGPUTypes(Connection c, Set<VGPUType> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The VGPU types to enable- 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.
-
setGPUGroupAsync
public Task setGPUGroupAsync(Connection c, GPUGroup value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The group to which the PGPU will be moved- 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.
-
setGPUGroup
public void setGPUGroup(Connection c, GPUGroup value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvalue
- The group to which the PGPU will be moved- 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.
-
getRemainingCapacityAsync
public Task getRemainingCapacityAsync(Connection c, VGPUType vgpuType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvgpuType
- The VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU- 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.
-
getRemainingCapacity
public Long getRemainingCapacity(Connection c, VGPUType vgpuType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onvgpuType
- The VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU- Returns:
- The number of VGPUs of the specified type which can still be started on this PGPU
- 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.
-
enableDom0AccessAsync
public Task enableDom0AccessAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- 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.
-
enableDom0Access
public Types.PgpuDom0Access enableDom0Access(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made on- Returns:
- The accessibility of this PGPU from dom0
- 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.
-
disableDom0AccessAsync
public Task disableDom0AccessAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- 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.
-
disableDom0Access
public Types.PgpuDom0Access disableDom0Access(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made on- Returns:
- The accessibility of this PGPU from dom0
- 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<PGPU> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a list of all the PGPUs known to the system. Minimum allowed role: read-only First published in XenServer 6.0.- 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<PGPU,PGPU.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a map of PGPU references to PGPU records for all PGPUs known to the system. Minimum allowed role: read-only First published in XenServer 6.0.- 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.
-