Accelerator API¶
The Accelerator Class¶
The accelerator high-level interface is available through the accelerator
member of a Connection
object.
The accelerator
member will only be added if the service is detected.
Device Operations¶
-
class
openstack.accelerator.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)¶ -
get_device
(uuid, fields=None)¶ Get a single device.
Parameters: uuid – The value can be the UUID of a device. Returns: One Device
Raises: ResourceNotFound
when no deployable matching the criteria could be found.
-
devices
(**query)¶ Retrieve a generator of devices.
Parameters: query (kwargs) – Optional query parameters to be sent to restrict the devices to be returned. Available parameters include: * hostname: The hostname of the device. * type: The type of the device. * vendor: The vendor ID of the device. * sort: A list of sorting keys separated by commas. Each sorting key can optionally be attached with a sorting direction modifier which can be asc
ordesc
. * limit: Requests a specified size of returned items from the query. Returns a number of items up to the specified limit value. * marker: Specifies the ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.Returns: A generator of device instances.
-
Deployable Operations¶
-
class
openstack.accelerator.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs) -
update_deployable
(uuid, patch)¶ Reconfig the FPGA with new bitstream.
Parameters: - uuid – The value can be the UUID of a deployable
- patch – The infomation of to reconfig.
Returns: The results of FPGA reconfig.
-
get_deployable
(uuid, fields=None)¶ Get a single deployable.
Parameters: uuid – The value can be the UUID of a deployable. Returns: One Deployable
Raises: ResourceNotFound
when no deployable matching the criteria could be found.
-
deployables
(**query)¶ Retrieve a generator of deployables.
Parameters: query (kwargs) – Optional query parameters to be sent to restrict the deployables to be returned. Returns: A generator of deployable instances.
-
Device Profile Operations¶
-
class
openstack.accelerator.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs) -
create_device_profile
(**attrs)¶ Create a device_profiles.
Parameters: attrs (kwargs) – a list of device_profiles. Returns: The list of created device profiles
-
delete_device_profile
(name_or_id, ignore_missing=True)¶ Delete an device profile
Parameters: - name_or_id – The value can be either the ID of an device profile.
- ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the device profile does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent device profile.
Returns: None
-
get_device_profile
(uuid, fields=None)¶ Get a single device profile.
Parameters: uuid – The value can be the UUID of a device profile. Returns: One :class: ~openstack.accelerator.v2.device_profile.DeviceProfile Raises: ResourceNotFound
when no device profile matching the criteria could be found.
-
device_profiles
(**query)¶ Retrieve a generator of device profiles.
Parameters: query (kwargs) – Optional query parameters to be sent to restrict the device profiles to be returned. Returns: A generator of device profile instances.
-
Accelerator Request Operations¶
-
class
openstack.accelerator.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs) -
create_accelerator_request
(**attrs)¶ Create an ARQs for a single device profile.
Parameters: attrs (kwargs) – request body.
-
delete_accelerator_request
(name_or_id, ignore_missing=True)¶ Delete an device profile :param name_or_id: The value can be either the ID of an accelerator request. :param bool ignore_missing: When set to
False
ResourceNotFound
will be raised when the device profile does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent accelerator request. :returns:None
-
get_accelerator_request
(uuid, fields=None)¶ Get a single accelerator request. :param uuid: The value can be the UUID of a accelerator request. :returns: One :class: ~openstack.accelerator.v2.accelerator_request.AcceleratorRequest :raises:
ResourceNotFound
when no accelerator request matching the criteria could be found.
-
accelerator_requests
(**query)¶ Retrieve a generator of accelerator requests.
Parameters: query (kwargs) – Optional query parameters to be sent to restrict the accelerator requests to be returned. Returns: A generator of accelerator request instances.
-
update_accelerator_request
(uuid, properties)¶ Bind/Unbind an accelerator to VM. :param uuid: The uuid of the accelerator_request to be binded/unbinded. :param properties: The info of VM that will bind/unbind the accelerator. :returns: True if bind/unbind succeeded, False otherwise.
-