:orphan:

.. index:: pair: group; PPPoE Server configuration
.. _doxid-group__tapi__conf__pppoe:

PPPoE Server configuration
==========================

.. 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_pppoe_server_if_add<doxid-group__tapi__conf__pppoe_1ga4e3f51b481ca0bb6174d4cc7859af904>`(const char* ta, const char* ifname);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_pppoe_server_if_del<doxid-group__tapi__conf__pppoe_1ga7c587b72aac7795031f65fef91e6b483>`(const char* ta, const char* ifname);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_pppoe_server_subnet_set<doxid-group__tapi__conf__pppoe_1gaa8cfad9ed02e2acb2ed31cc15d2760b3>`(const char* ta, const char* subnet);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_pppoe_server_subnet_get<doxid-group__tapi__conf__pppoe_1ga8721b947eafb2da353ed187c4551d83e>`(const char* ta, char** subnet_p);
	void :ref:`tapi_cfg_pppoe_server_laddr_get<doxid-group__tapi__conf__pppoe_1gafb33a71a28c7f5abce4c81098c385da6>`(const char* ta, struct sockaddr** addr);
	void :ref:`tapi_cfg_pppoe_server_raddr_get<doxid-group__tapi__conf__pppoe_1ga988e9ad5d289658fe064099a5043b00d>`(const char* ta, struct sockaddr** addr);

.. _details-group__tapi__conf__pppoe:

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



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

.. index:: pair: function; tapi_cfg_pppoe_server_if_add
.. _doxid-group__tapi__conf__pppoe_1ga4e3f51b481ca0bb6174d4cc7859af904:

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

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

Add interface to PPPoE server configuration on the Test Agent.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent

	*
		- ifname

		- Interface to listen on



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_pppoe_server_if_del
.. _doxid-group__tapi__conf__pppoe_1ga7c587b72aac7795031f65fef91e6b483:

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

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

Delete interface from PPPoE server configuration on the Test Agent.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent

	*
		- ifname

		- Interface to remove



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_pppoe_server_subnet_set
.. _doxid-group__tapi__conf__pppoe_1gaa8cfad9ed02e2acb2ed31cc15d2760b3:

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

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

Configure subnet of PPPoE server to allocate local and remote addresses.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent

	*
		- subnet

		- String value of subnet XXX.XXX.XXX.XXX/prefix



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_pppoe_server_subnet_get
.. _doxid-group__tapi__conf__pppoe_1ga8721b947eafb2da353ed187c4551d83e:

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

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

Get subnet of PPPoE server to allocate local and remote addresses.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent

	*
		- subnet_p

		- Returned pointer to subnet value. Note, it should be freed with free(3) when it is no longer needed.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_pppoe_server_laddr_get
.. _doxid-group__tapi__conf__pppoe_1gafb33a71a28c7f5abce4c81098c385da6:

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

	void tapi_cfg_pppoe_server_laddr_get(const char* ta, struct sockaddr** addr)

Get local IP address of PPPoE server.



.. rubric:: Parameters:

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

	*
		- ta

		- Test agent name.

	*
		- addr

		- Local IP address. Note, it should be freed with free(3) when it is no longer needed.

.. index:: pair: function; tapi_cfg_pppoe_server_raddr_get
.. _doxid-group__tapi__conf__pppoe_1ga988e9ad5d289658fe064099a5043b00d:

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

	void tapi_cfg_pppoe_server_raddr_get(const char* ta, struct sockaddr** addr)

Get starting remote IP address of PPPoE server.



.. rubric:: Parameters:

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

	*
		- ta

		- Test agent name.

	*
		- addr

		- Starting remote IP address. Note, it should be freed with free(3) when it is no longer needed.