Package com.xensource.xenapi
Class VGPU
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VGPU
A virtual GPU (vGPU)
First published in XenServer 6.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VGPU.static VGPU
Minimum allowed role: pool-operator First published in XenServer 6.0.static VGPU
create
(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig, VGPUType type) Minimum allowed role: pool-operator First published in XenServer 6.0.static Task
createAsync
(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig) Minimum allowed role: pool-operator First published in XenServer 6.0.static Task
createAsync
(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig, VGPUType type) Minimum allowed role: pool-operator First published in XenServer 6.0.void
Minimum allowed role: pool-operator First published in XenServer 6.0.Minimum allowed role: pool-operator First published in XenServer 6.0.boolean
If obj is a VGPU, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the VGPUs known to the system.static Map<VGPU,
VGPU.Record> Return a map of VGPU references to VGPU records for all VGPUs known to the system.static VGPU
getByUuid
(Connection c, String uuid) Get a reference to the VGPU instance with the specified UUID.Get the compatibility_metadata field of the given VGPU.Get the currently_attached field of the given VGPU.Get the device field of the given VGPU.Get the extra_args field of the given VGPU.Get the GPU_group field of the given VGPU.Get the other_config field of the given VGPU.getPCI
(Connection c) Get the PCI field of the given VGPU.Get a record containing the current state of the given VGPU.Get the resident_on field of the given VGPU.Get the scheduled_to_be_resident_on field of the given VGPU.Get the type field of the given VGPU.Get the uuid field of the given VGPU.getVM
(Connection c) Get the VM field of the given VGPU.int
hashCode()
void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VGPU.void
setExtraArgs
(Connection c, String extraArgs) Set the extra_args field of the given VGPU.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given VGPU.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 VGPU, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public VGPU.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static VGPU getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the VGPU 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVM
Get the VM field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGPUGroup
public GPUGroup getGPUGroup(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the GPU_group field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDevice
public String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the device field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentlyAttached
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the currently_attached field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the other_config field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getType
public VGPUType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the type field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getResidentOn
public PGPU getResidentOn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the resident_on field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getScheduledToBeResidentOn
public PGPU getScheduledToBeResidentOn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the scheduled_to_be_resident_on field of the given VGPU. Minimum allowed role: read-only First published in XenServer 7.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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCompatibilityMetadata
public Map<String,String> getCompatibilityMetadata(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the compatibility_metadata field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getExtraArgs
public String getExtraArgs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the extra_args field of the given VGPU. Minimum allowed role: read-only First published in Citrix Hypervisor 8.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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPCI
Get the PCI field of the given VGPU. Minimum allowed role: read-only First published in Citrix Hypervisor 8.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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the other_config field of the given VGPU. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setExtraArgs
public void setExtraArgs(Connection c, String extraArgs) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the extra_args field of the given VGPU. Minimum allowed role: pool-operator First published in Citrix Hypervisor 8.1.- Parameters:
c
- The connection the call is made onextraArgs
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static VGPU create(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMinimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onVM
- No descriptionGPUGroup
- No descriptiondevice
- No descriptionotherConfig
- No description- Returns:
- The reference of the created VGPU object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static VGPU create(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig, VGPUType type) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMinimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onVM
- No descriptionGPUGroup
- No descriptiondevice
- No descriptionotherConfig
- No descriptiontype
- No description First published in XenServer 6.2 SP1 Tech-Preview.- Returns:
- The reference of the created VGPU object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createAsync
public static Task createAsync(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMinimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onVM
- No descriptionGPUGroup
- No descriptiondevice
- No descriptionotherConfig
- No description- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createAsync
public static Task createAsync(Connection c, VM VM, GPUGroup GPUGroup, String device, Map<String, String> otherConfig, VGPUType type) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMinimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onVM
- No descriptionGPUGroup
- No descriptiondevice
- No descriptionotherConfig
- No descriptiontype
- No description First published in XenServer 6.2 SP1 Tech-Preview.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator First published in XenServer 6.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator First published in XenServer 6.0.- 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<VGPU> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the VGPUs 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<VGPU,VGPU.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VGPU references to VGPU records for all VGPUs 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
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-