:orphan:

.. index:: pair: group; Network Switch configuration
.. _doxid-group__tapi__conf__switch:

Network Switch configuration
============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	int :ref:`tapi_cfg_switch_add_vlan<doxid-group__tapi__conf__switch_1ga5320b580362ea561ff4e7bdf489dbafc>`(const char* ta_name, uint16_t vid);
	int :ref:`tapi_cfg_switch_del_vlan<doxid-group__tapi__conf__switch_1gaa38e759f11d48435290edf83ac92e388>`(const char* ta_name, uint16_t vid);
	int :ref:`tapi_cfg_switch_vlan_add_port<doxid-group__tapi__conf__switch_1ga920050acd5bebe018addb5d1ab33738c>`(const char* ta_name, uint16_t vid, unsigned int port);
	int :ref:`tapi_cfg_switch_vlan_del_port<doxid-group__tapi__conf__switch_1ga14af54d60a32a3a9535b4ae57983f8e7>`(const char* ta_name, uint16_t vid, unsigned int port);

.. _details-group__tapi__conf__switch:

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



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

.. index:: pair: function; tapi_cfg_switch_add_vlan
.. _doxid-group__tapi__conf__switch_1ga5320b580362ea561ff4e7bdf489dbafc:

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

	int tapi_cfg_switch_add_vlan(const char* ta_name, uint16_t vid)

Add VLAN on switch.



.. rubric:: Parameters:

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

	*
		- ta_name

		- - name of the test agent

	*
		- vid

		- - VLAN identifier



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_switch_del_vlan
.. _doxid-group__tapi__conf__switch_1gaa38e759f11d48435290edf83ac92e388:

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

	int tapi_cfg_switch_del_vlan(const char* ta_name, uint16_t vid)

Delete VLAN from switch.



.. rubric:: Parameters:

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

	*
		- ta_name

		- - name of the test agent

	*
		- vid

		- - VLAN identifier



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_switch_vlan_add_port
.. _doxid-group__tapi__conf__switch_1ga920050acd5bebe018addb5d1ab33738c:

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

	int tapi_cfg_switch_vlan_add_port(const char* ta_name, uint16_t vid, unsigned int port)

Add port to VLAN on switch.



.. rubric:: Parameters:

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

	*
		- ta_name

		- - name of the test agent

	*
		- vid

		- - VLAN identifier

	*
		- port

		- - port number



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_switch_vlan_del_port
.. _doxid-group__tapi__conf__switch_1ga14af54d60a32a3a9535b4ae57983f8e7:

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

	int tapi_cfg_switch_vlan_del_port(const char* ta_name, uint16_t vid, unsigned int port)

Delete port from VLAN on switch.



.. rubric:: Parameters:

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

	*
		- ta_name

		- - name of the test agent

	*
		- vid

		- - VLAN identifier

	*
		- port

		- - port number



.. rubric:: Returns:

Status code.