View Source XenAPI.VGPU (XenAPI v0.3.1)

A virtual GPU (vGPU)

Link to this section Summary

Functions

Add the given key-value pair to the other_config field of the given VGPU.

Add the given key-value pair to the other_config field of the given VGPU. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Return a list of all the VGPUs known to the system.

Return a list of all the VGPUs known to the system. (Raise error on XMLRPC failure)

Return a map of VGPU references to VGPU records for all VGPUs known to the system.

Return a map of VGPU references to VGPU records for all VGPUs known to the system. (Raise error on XMLRPC failure)

Get a reference to the VGPU instance with the specified UUID.

Get a reference to the VGPU instance with the specified UUID. (Raise error on XMLRPC failure)

Get the compatibility_metadata field of the given VGPU.

Get the compatibility_metadata field of the given VGPU. (Raise error on XMLRPC failure)

Get the currently_attached field of the given VGPU.

Get the currently_attached field of the given VGPU. (Raise error on XMLRPC failure)

Get the device field of the given VGPU.

Get the device field of the given VGPU. (Raise error on XMLRPC failure)

Get the extra_args field of the given VGPU.

Get the extra_args field of the given VGPU. (Raise error on XMLRPC failure)

Get the GPU_group field of the given VGPU.

Get the GPU_group field of the given VGPU. (Raise error on XMLRPC failure)

Get the other_config field of the given VGPU.

Get the other_config field of the given VGPU. (Raise error on XMLRPC failure)

Get a record containing the current state of the given VGPU. Returns XenAPI.VGPU struct.

Get a record containing the current state of the given VGPU. Returns XenAPI.VGPU struct. (Raise error on XMLRPC failure)

Get the resident_on field of the given VGPU.

Get the resident_on field of the given VGPU. (Raise error on XMLRPC failure)

Get the scheduled_to_be_resident_on field of the given VGPU.

Get the scheduled_to_be_resident_on field of the given VGPU. (Raise error on XMLRPC failure)

Get the type field of the given VGPU.

Get the type field of the given VGPU. (Raise error on XMLRPC failure)

Get the uuid field of the given VGPU.

Get the uuid field of the given VGPU. (Raise error on XMLRPC failure)

Get the VM field of the given VGPU.

Get the VM field of the given VGPU. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Set the extra_args field of the given VGPU.

Set the extra_args field of the given VGPU. (Raise error on XMLRPC failure)

Set the other_config field of the given VGPU.

Set the other_config field of the given VGPU. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, vgpu_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given VGPU.

Link to this function

add_to_other_config!(xen_session, vgpu_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, arg1, arg2, device, other_config, type)

View Source
Link to this function

create!(xen_session, arg1, arg2, device, other_config, type)

View Source

(Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, vgpu_ref)

View Source
Link to this function

destroy!(xen_session, vgpu_ref)

View Source

(Raise error on XMLRPC failure)

Return a list of all the VGPUs known to the system.

Return a list of all the VGPUs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VGPU references to VGPU records for all VGPUs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VGPU references to VGPU records for all VGPUs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the VGPU instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VGPU instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_compatibility_metadata(xen_session, vgpu_ref)

View Source

Get the compatibility_metadata field of the given VGPU.

Link to this function

get_compatibility_metadata!(xen_session, vgpu_ref)

View Source

Get the compatibility_metadata field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_currently_attached(xen_session, vgpu_ref)

View Source

Get the currently_attached field of the given VGPU.

Link to this function

get_currently_attached!(xen_session, vgpu_ref)

View Source

Get the currently_attached field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_device(xen_session, vgpu_ref)

View Source

Get the device field of the given VGPU.

Link to this function

get_device!(xen_session, vgpu_ref)

View Source

Get the device field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_extra_args(xen_session, vgpu_ref)

View Source

Get the extra_args field of the given VGPU.

Link to this function

get_extra_args!(xen_session, vgpu_ref)

View Source

Get the extra_args field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_GPU_group(xen_session, vgpu_ref)

View Source

Get the GPU_group field of the given VGPU.

Link to this function

get_GPU_group!(xen_session, vgpu_ref)

View Source

Get the GPU_group field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, vgpu_ref)

View Source

Get the other_config field of the given VGPU.

Link to this function

get_other_config!(xen_session, vgpu_ref)

View Source

Get the other_config field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vgpu_ref)

View Source

Get a record containing the current state of the given VGPU. Returns XenAPI.VGPU struct.

Link to this function

get_record!(xen_session, vgpu_ref)

View Source

Get a record containing the current state of the given VGPU. Returns XenAPI.VGPU struct. (Raise error on XMLRPC failure)

Link to this function

get_resident_on(xen_session, vgpu_ref)

View Source

Get the resident_on field of the given VGPU.

Link to this function

get_resident_on!(xen_session, vgpu_ref)

View Source

Get the resident_on field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_scheduled_to_be_resident_on(xen_session, vgpu_ref)

View Source

Get the scheduled_to_be_resident_on field of the given VGPU.

Link to this function

get_scheduled_to_be_resident_on!(xen_session, vgpu_ref)

View Source

Get the scheduled_to_be_resident_on field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_type(xen_session, vgpu_ref)

View Source

Get the type field of the given VGPU.

Link to this function

get_type!(xen_session, vgpu_ref)

View Source

Get the type field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vgpu_ref)

View Source

Get the uuid field of the given VGPU.

Link to this function

get_uuid!(xen_session, vgpu_ref)

View Source

Get the uuid field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

get_VM(xen_session, vgpu_ref)

View Source

Get the VM field of the given VGPU.

Link to this function

get_VM!(xen_session, vgpu_ref)

View Source

Get the VM field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, vgpu_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, vgpu_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

set_extra_args(xen_session, vgpu_ref, value)

View Source

Set the extra_args field of the given VGPU.

Link to this function

set_extra_args!(xen_session, vgpu_ref, value)

View Source

Set the extra_args field of the given VGPU. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, vgpu_ref, value)

View Source

Set the other_config field of the given VGPU.

Link to this function

set_other_config!(xen_session, vgpu_ref, value)

View Source

Set the other_config field of the given VGPU. (Raise error on XMLRPC failure)