:orphan:

.. index:: pair: group; Block devices subtree
.. _doxid-group__tapi__conf__block:

Block devices subtree
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_block_initialize_loop<doxid-group__tapi__conf__block_1gad95f8cadbd39d542d1c18d08aaba4485>`(const char* ta);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_block_grab<doxid-group__tapi__conf__block_1ga7f2eb418a7fb6f23a89bfcf5f8f24ca2>`(const char* ta, const char* block_dev);
	bool :ref:`tapi_cfg_block_is_loop<doxid-group__tapi__conf__block_1ga846230696ca305d647c3f4a0f5fdb379>`(const char* ta, const char* block_dev);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_block_loop_get_backing_file<doxid-group__tapi__conf__block_1ga1351c105758b75947ebf8ea0d1063954>`(const char* ta, const char* block_dev, char** filename);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_block_loop_set_backing_file<doxid-group__tapi__conf__block_1ga1db6511ada9d18ab448a1c2a72727ad1>`(const char* ta, const char* block_dev, const char* filename);

.. _details-group__tapi__conf__block:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Global Functions
----------------

.. index:: pair: function; tapi_cfg_block_initialize_loop
.. _doxid-group__tapi__conf__block_1gad95f8cadbd39d542d1c18d08aaba4485:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_block_initialize_loop(const char* ta)

Initialize loop block devices subsystem on the agent ``ta``. In particular, it implies loading the required kernel modules.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- agent name



.. rubric:: Returns:

status code

.. index:: pair: function; tapi_cfg_block_grab
.. _doxid-group__tapi__conf__block_1ga7f2eb418a7fb6f23a89bfcf5f8f24ca2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_block_grab(const char* ta, const char* block_dev)

Grab a block device as a resource.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- agent name

	*
		- block_dev

		- block device name



.. rubric:: Returns:

status code

.. index:: pair: function; tapi_cfg_block_is_loop
.. _doxid-group__tapi__conf__block_1ga846230696ca305d647c3f4a0f5fdb379:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool tapi_cfg_block_is_loop(const char* ta, const char* block_dev)

Check whether a block device is a loop device.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- Agent name

	*
		- block_dev

		- Block device name



.. rubric:: Returns:

``true`` iff ``block_dev`` refers to a loop block device on ``ta``

.. index:: pair: function; tapi_cfg_block_loop_get_backing_file
.. _doxid-group__tapi__conf__block_1ga1351c105758b75947ebf8ea0d1063954:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_block_loop_get_backing_file(const char* ta, const char* block_dev, char** filename)

Get the name of a backing file for a loop device ``block_dev``.

If there is no backing file, the value will be ``NULL``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- agent name

	*
		- block_dev

		- block device name

	*
		- filename

		- the name of the backing file or ``NULL`` (must be free()'d)



.. rubric:: Returns:

status code

.. index:: pair: function; tapi_cfg_block_loop_set_backing_file
.. _doxid-group__tapi__conf__block_1ga1db6511ada9d18ab448a1c2a72727ad1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_block_loop_set_backing_file(const char* ta, const char* block_dev, const char* filename)

Set the name of a backing file for a loop device ``block_dev``.

If the name is ``NULL`` or empty, the loop device is detached from any backing file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- ta

		- agent name

	*
		- block_dev

		- block device name

	*
		- filename

		- the name of the backing file (may be ``NULL``)



.. rubric:: Returns:

status code