:orphan:

.. index:: pair: group; ethtool tool TAPI (tapi_ethtool)
.. _doxid-group__tapi__ethtool:

ethtool tool TAPI (tapi_ethtool)
================================

.. toctree::
	:hidden:

	enum_tapi_ethtool_cmd.rst
	struct_tapi_ethtool_if_props.rst
	struct_tapi_ethtool_opt.rst
	struct_tapi_ethtool_pause.rst
	struct_tapi_ethtool_report.rst
	struct_tapi_ethtool_ring.rst

Overview
~~~~~~~~

Declarations for TAPI to handle ethtool tool. :ref:`More...<details-group__tapi__ethtool>`


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

	
	// typedefs

	typedef enum :ref:`tapi_ethtool_cmd<doxid-group__tapi__ethtool_1gad87de003c204460b39f6e0c678475dc6>` :ref:`tapi_ethtool_cmd<doxid-group__tapi__ethtool_1ga1f82620f5abbc2e1ffdc312a355acba9>`;
	typedef struct :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>` :ref:`tapi_ethtool_opt<doxid-group__tapi__ethtool_1gacedc32417fa45a9e029df8ef1f71f025>`;
	typedef struct :ref:`tapi_ethtool_if_props<doxid-structtapi__ethtool__if__props>` :ref:`tapi_ethtool_if_props<doxid-group__tapi__ethtool_1ga80e1b7c070c40fb36a113bee622dced0>`;
	typedef struct :ref:`tapi_ethtool_pause<doxid-structtapi__ethtool__pause>` :ref:`tapi_ethtool_pause<doxid-group__tapi__ethtool_1ga5c94e67500b9855f97a5616943b30901>`;
	typedef struct :ref:`tapi_ethtool_ring<doxid-structtapi__ethtool__ring>` :ref:`tapi_ethtool_ring<doxid-group__tapi__ethtool_1ga51d6f2ebc738e6ca5d29b029f7e538a3>`;
	typedef struct :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>` :ref:`tapi_ethtool_report<doxid-group__tapi__ethtool_1ga734ade30553a7ae10cb9205da6f99d6d>`;

	// enums

	enum :ref:`tapi_ethtool_cmd<doxid-group__tapi__ethtool_1gad87de003c204460b39f6e0c678475dc6>`;

	// structs

	struct :ref:`tapi_ethtool_if_props<doxid-structtapi__ethtool__if__props>`;
	struct :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>`;
	struct :ref:`tapi_ethtool_pause<doxid-structtapi__ethtool__pause>`;
	struct :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`;
	struct :ref:`tapi_ethtool_ring<doxid-structtapi__ethtool__ring>`;

	// global variables

	const :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>` :ref:`tapi_ethtool_default_opt<doxid-group__tapi__ethtool_1gadb4034788bb37a560aba5dc8ba72ddae>`;
	const :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>` :ref:`tapi_ethtool_default_report<doxid-group__tapi__ethtool_1ga0f2603f455f35cb87e9559a526cc98f3>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ethtool<doxid-group__tapi__ethtool_1gaa2d26661cc494c1835588625787e1a62>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>`* opt, :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ethtool_get_stat<doxid-group__tapi__ethtool_1ga5bf7151661b68cd1f2a2f64e017ec9e2>`(:ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report, const char* name, long int* value);
	void :ref:`tapi_ethtool_destroy_report<doxid-group__tapi__ethtool_1gab967806ee69740e36d73506522b5ad24>`(:ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report);

	// macros

	#define :ref:`TAPI_ETHTOOL_MAX_STR<doxid-group__tapi__ethtool_1ga6148603f11ec7155ac3b86a69f59274c>`

.. _details-group__tapi__ethtool:

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

Declarations for TAPI to handle ethtool tool.

WARNING: do not use this TAPI unless you really need to check ethtool application itself. Normally configuration tree should be used to read and change network interface settings. It is strictly prohibited to use this TAPI for changing configuration.

Copyright (C) 2021-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_ethtool_cmd
.. _doxid-group__tapi__ethtool_1ga1f82620f5abbc2e1ffdc312a355acba9:

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

	typedef enum :ref:`tapi_ethtool_cmd<doxid-group__tapi__ethtool_1gad87de003c204460b39f6e0c678475dc6>` tapi_ethtool_cmd

Supported ethtool commands

.. index:: pair: typedef; tapi_ethtool_opt
.. _doxid-group__tapi__ethtool_1gacedc32417fa45a9e029df8ef1f71f025:

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

	typedef struct :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>` tapi_ethtool_opt

Command line options for ethtool

.. index:: pair: typedef; tapi_ethtool_if_props
.. _doxid-group__tapi__ethtool_1ga80e1b7c070c40fb36a113bee622dced0:

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

	typedef struct :ref:`tapi_ethtool_if_props<doxid-structtapi__ethtool__if__props>` tapi_ethtool_if_props

Interface properties parsed in case of ``TAPI_ETHTOOL_CMD_NONE``

.. index:: pair: typedef; tapi_ethtool_pause
.. _doxid-group__tapi__ethtool_1ga5c94e67500b9855f97a5616943b30901:

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

	typedef struct :ref:`tapi_ethtool_pause<doxid-structtapi__ethtool__pause>` tapi_ethtool_pause

Pause parameters parsed in case of ``TAPI_ETHTOOL_CMD_SHOW_PAUSE``

.. index:: pair: typedef; tapi_ethtool_ring
.. _doxid-group__tapi__ethtool_1ga51d6f2ebc738e6ca5d29b029f7e538a3:

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

	typedef struct :ref:`tapi_ethtool_ring<doxid-structtapi__ethtool__ring>` tapi_ethtool_ring

Ring parameters parsed in case of ``TAPI_ETHTOOL_CMD_SHOW_RING``

.. index:: pair: typedef; tapi_ethtool_report
.. _doxid-group__tapi__ethtool_1ga734ade30553a7ae10cb9205da6f99d6d:

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

	typedef struct :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>` tapi_ethtool_report

Structure for storing parsed data from ethtool output

Global Variables
----------------

.. index:: pair: variable; tapi_ethtool_default_opt
.. _doxid-group__tapi__ethtool_1gadb4034788bb37a560aba5dc8ba72ddae:

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

	const :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>` tapi_ethtool_default_opt

Default options initializer

.. index:: pair: variable; tapi_ethtool_default_report
.. _doxid-group__tapi__ethtool_1ga0f2603f455f35cb87e9559a526cc98f3:

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

	const :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>` tapi_ethtool_default_report

Default report initializer

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

.. index:: pair: function; tapi_ethtool
.. _doxid-group__tapi__ethtool_1gaa2d26661cc494c1835588625787e1a62:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ethtool(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ethtool_opt<doxid-structtapi__ethtool__opt>`* opt, :ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report)

Run ethtool command, parse its output if required.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory

	*
		- opt

		- Ethtool command options

	*
		- report

		- If not ``NULL``, parsed data from output will be saved here



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ethtool_get_stat
.. _doxid-group__tapi__ethtool_1ga5bf7151661b68cd1f2a2f64e017ec9e2:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ethtool_get_stat(:ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report, const char* name, long int* value)

Get a single statistic from parsed ethtool output.



.. rubric:: Parameters:

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

	*
		- report

		- Pointer to parsed data storage

	*
		- name

		- Name of the statistic

	*
		- value

		- Where to save parsed value



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ethtool_destroy_report
.. _doxid-group__tapi__ethtool_1gab967806ee69740e36d73506522b5ad24:

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

	void tapi_ethtool_destroy_report(:ref:`tapi_ethtool_report<doxid-structtapi__ethtool__report>`* report)

Release resources allocated for ethtool output data.



.. rubric:: Parameters:

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

	*
		- report

		- Structure storing parsed data

Macros
------

.. index:: pair: define; TAPI_ETHTOOL_MAX_STR
.. _doxid-group__tapi__ethtool_1ga6148603f11ec7155ac3b86a69f59274c:

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

	#define TAPI_ETHTOOL_MAX_STR

Maximum string length in ethtool output