:orphan:

.. index:: pair: group; Test API
.. _doxid-group__te__ts__tapi:

Test API
========

.. toctree::
	:hidden:

	group_tapi_conf.rst
	group_tapi_dpdk_grp.rst
	group_tapi_devices.rst
	group_tapi_netenv.rst
	group_tapi_run.rst
	group_tapi_sockets.rst
	group_tapi_traffic.rst
	group_tapi_scenario.rst
	/pages/group_te_lib_rpc.rst

The Test API (TAPI) is what a test scenario is written against. Every module below wraps some capability of a :ref: ``Test Agent <doxid- group__te__agents>`` - a remote procedure call, a configuration subtree, a traffic generator, a command line tool - behind a C interface that a test can call directly. Tests link against these libraries; they are engine-side, not agent-side. The :ref: ``Test Suite <doxid-group__te__ts>`` page describes how a suite is laid out and built, and :ref: ``Test <doxid- group__te__ts__tapi__test>`` covers the scaffolding every test scenario uses.

|	:ref:`Configuring the test bed<doxid-group__tapi__conf>`
|		:ref:`Addressing and routing<doxid-group__tapi__conf__addr>`
|			:ref:`Address pools<doxid-group__tapi__conf__net__pool>`
|			:ref:`Base network settings<doxid-group__tapi__conf__base__net>`
|			:ref:`IP rules<doxid-group__tapi__conf__ip__rule>`
|			:ref:`IPv6<doxid-group__tapi__conf__ip6>`
|			:ref:`L4 port allocation<doxid-group__tapi__conf__l4__port>`
|			:ref:`Neighbour table<doxid-group__tapi__conf__neigh>`
|			:ref:`Routing table<doxid-group__tapi__conf__route>`
|		:ref:`Configurator API<doxid-group__confapi__base>`
|			:ref:`Configuration backup manipulation<doxid-group__confapi__base__backup>`
|			:ref:`Configuration tree access operations<doxid-group__confapi__base__access>`
|			:ref:`Configuration tree traversal<doxid-group__confapi__base__traverse>`
|			:ref:`Synchronising with an agent<doxid-group__confapi__base__sync>`
|			:ref:`Test Agent reboot<doxid-group__confapi__base__reboot>`
|		:ref:`Diagnostics and console<doxid-group__tapi__conf__diag>`
|			:ref:`ARL table<doxid-group__tapi__conf__arl>`
|			:ref:`Command monitor<doxid-group__tapi__cmd__monitor__def>`
|			:ref:`DUT serial console<doxid-group__tapi__conf__serial>`
|			:ref:`Serial console parsers<doxid-group__tapi__conf__serial__parse>`
|			:ref:`Sniffers<doxid-group__tapi__conf__sniffer>`
|		:ref:`Host resources<doxid-group__tapi__conf__host>`
|			:ref:`Block devices subtree<doxid-group__tapi__conf__block>`
|			:ref:`CPU topology<doxid-group__tapi__conf__cpu>`
|			:ref:`Kernel modules<doxid-group__tapi__conf__modules>`
|			:ref:`PCI devices<doxid-group__tapi__conf__pci>`
|			:ref:`Processes<doxid-group__tapi__conf__process>`
|			:ref:`RAM<doxid-group__tapi__conf__memory>`
|			:ref:`System options (obsolete)<doxid-group__tapi__conf__proc>`
|			:ref:`System parameters<doxid-group__tapi__cfg__sys>`
|		:ref:`Interfaces and links<doxid-group__tapi__conf__link>`
|			:ref:`Bonding and bridging<doxid-group__tapi__conf__aggr>`
|			:ref:`Bridges<doxid-group__tapi__conf__bridge>`
|			:ref:`Ethernet PHY<doxid-group__tapi__conf__phy>`
|			:ref:`Interface features and offloads<doxid-group__tapi__conf__if>`
|			:ref:`Interface hardware addresses<doxid-group__tapi__conf__iface>`
|			:ref:`Interface interrupts configuration<doxid-group__tapi__conf__irq>`
|			:ref:`Interface statistics<doxid-group__tapi__conf__stats>`
|			:ref:`Network emulator<doxid-group__tapi__conf__netem>`
|			:ref:`Queuing disciplines<doxid-group__tapi__conf__qdisc>`
|				:ref:`tc qdisc TBF configuration<doxid-group__tapi__conf__tbf>`
|			:ref:`TAP interfaces<doxid-group__tapi__conf__tap>`
|		:ref:`Network services and daemons<doxid-group__tapi__conf__serv>`
|			:ref:`DHCP server<doxid-group__tapi__conf__dhcp__serv>`
|			:ref:`L2TP<doxid-group__tapi__conf__l2tp>`
|			:ref:`NTP daemon<doxid-group__tapi__conf__ntpd>`
|			:ref:`Open vSwitch<doxid-group__tapi__conf__ovs>`
|			:ref:`PPPoE server<doxid-group__tapi__conf__pppoe>`
|			:ref:`Solarflare PTP daemon<doxid-group__tapi__conf__sfptpd>`
|			:ref:`Tunnels<doxid-group__tapi__conf__tunnel>`
|			:ref:`VTun daemon<doxid-group__tapi__conf__vtund>`
|			:ref:`Virtual machines<doxid-group__tapi__conf__vm>`
|			:ref:`XEN<doxid-group__tapi__conf__xen>`
|			:ref:`iptables<doxid-group__tapi__conf__iptable>`
|		:ref:`The configuration tree itself<doxid-group__tapi__conf__tree>`
|			:ref:`Agent keys<doxid-group__tapi__conf__key>`
|			:ref:`Change tracking<doxid-group__tapi__conf__changed>`
|			:ref:`Configuration cache<doxid-group__tapi__cache>`
|			:ref:`Environment variables<doxid-group__tapi__conf__sh__env>`
|			:ref:`Local subtree<doxid-group__tapi__conf__local>`
|			:ref:`RCF via Configurator<doxid-group__tapi__conf__rcf>`
|		:ref:`Topology and namespaces<doxid-group__tapi__conf__topo>`
|			:ref:`Agent namespaces<doxid-group__tapi__namespaces>`
|			:ref:`Agent network topology<doxid-group__tapi__conf__net>`
|			:ref:`Agent, namespace and interface map<doxid-group__tapi__host__ns>`
|			:ref:`Network switch<doxid-group__tapi__conf__switch>`
|	:ref:`DPDK<doxid-group__tapi__dpdk__grp>`
|		:ref:`DPDK helpers<doxid-group__tapi__dpdk>`
|		:ref:`DPDK statistics<doxid-group__tapi__dpdk__stats>`
|		:ref:`RTE flow helpers<doxid-group__tapi__rte__flow>`
|		:ref:`l2fwd<doxid-group__tapi__l2fwd>`
|	:ref:`Devices and services<doxid-group__tapi__devices>`
|		:ref:`BPF and XDP<doxid-group__tapi__bpf>`
|			:ref:`rxq_stats BPF program<doxid-group__tapi__bpf__rxq__stats>`
|		:ref:`Media data<doxid-group__tapi__media>`
|			:ref:`DLNA media files<doxid-group__tapi__media__dlna>`
|			:ref:`Media files<doxid-group__tapi__media__file>`
|			:ref:`Media player control<doxid-group__tapi__media__player>`
|			:ref:`mplayer<doxid-group__tapi__media__player__mplayer>`
|		:ref:`NVMe over Fabrics<doxid-group__tapi__nvme>`
|			:ref:`Kernel target<doxid-group__tapi__nvme__kern__target>`
|			:ref:`ONVMe target<doxid-group__tapi__nvme__onvme__target>`
|		:ref:`Storage<doxid-group__tapi__storage>`
|			:ref:`Generic storage operations<doxid-group__tapi__storage__wrapper>`
|			:ref:`Local storage device<doxid-group__tapi__local__storage__device>`
|			:ref:`Storage FTP client<doxid-group__tapi__storage__client__ftp>`
|			:ref:`Storage client<doxid-group__tapi__storage__client>`
|			:ref:`Storage server<doxid-group__tapi__storage__server>`
|		:ref:`UPnP<doxid-group__tapi__upnp>`
|			:ref:`UPnP common definitions<doxid-group__tapi__upnp__common>`
|			:ref:`UPnP content directory resources<doxid-group__tapi__upnp__cd__resources>`
|			:ref:`UPnP content directory service<doxid-group__tapi__upnp__cd__service>`
|			:ref:`UPnP control point<doxid-group__tapi__upnp__cp>`
|			:ref:`UPnP device information<doxid-group__tapi__upnp__device__info>`
|			:ref:`UPnP service information<doxid-group__tapi__upnp__service__info>`
|		:ref:`Wi-Fi client<doxid-group__tapi__wifi>`
|			:ref:`Control WPA client<doxid-group__tapi__wifi__wpa__cli>`
|			:ref:`Control WPA supplicant<doxid-group__tapi__wifi__wpa__supplicant>`
|			:ref:`Wi-Fi security<doxid-group__tapi__wifi__security>`
|	:ref:`Network environment and topology<doxid-group__tapi__netenv>`
|		:ref:`Gateway test parameters<doxid-group__ts__tapi__gw>`
|		:ref:`High level network setup<doxid-group__ts__tapi__network>`
|		:ref:`Network setup library<doxid-group__tapi__net>`
|			:ref:`Network definition in YAML<doxid-group__tapi__net__yaml>`
|			:ref:`Test environment interaction<doxid-group__tapi__net__env>`
|		:ref:`Route gateway control<doxid-group__ts__tapi__route__gw>`
|	:ref:`Running programs on an agent<doxid-group__tapi__run>`
|		:ref:`Agent job control<doxid-group__tapi__job>`
|			:ref:`Agent-side job control<doxid-group__ta__job>`
|			:ref:`Configurator job factory<doxid-group__tapi__job__factory__cfg>`
|			:ref:`Job control via Configurator<doxid-group__tapi__cfg__job>`
|			:ref:`Job internals<doxid-group__tapi__job__internal>`
|			:ref:`Job methods<doxid-group__tapi__job__methods>`
|			:ref:`Option handling helpers<doxid-group__tapi__job__opt>`
|				:ref:`convenience macros for option<doxid-group__tapi__job__opt__bind__constructors>`
|				:ref:`functions for argument formatting<doxid-group__tapi__job__opt__formatting>`
|			:ref:`RPC job factory<doxid-group__tapi__job__factory__rpc>`
|		:ref:`Network performance tools<doxid-group__tapi__tool__perf>`
|			:ref:`Cisco TRex<doxid-group__tapi__trex>`
|			:ref:`NPtcp<doxid-group__tapi__nptcp>`
|			:ref:`Network throughput tools<doxid-group__tapi__performance>`
|			:ref:`netperf<doxid-group__tapi__netperf>`
|			:ref:`ping<doxid-group__tapi__ping>`
|			:ref:`sfnt-pingpong<doxid-group__tapi__sfnt__pingpong>`
|			:ref:`wrk<doxid-group__tapi__wrk>`
|		:ref:`Server and service tools<doxid-group__tapi__tool__service>`
|			:ref:`DNS zone files<doxid-group__tapi__dns__zone__file>`
|			:ref:`HAProxy<doxid-group__tapi__haproxy>`
|			:ref:`HAProxy configuration file<doxid-group__tapi__haproxy__cfg>`
|			:ref:`dnsperf<doxid-group__tapi__dnsperf>`
|			:ref:`memaslap<doxid-group__tapi__memaslap>`
|			:ref:`memcached<doxid-group__tapi__memcached>`
|			:ref:`memtier_benchmark<doxid-group__tapi__memtier>`
|			:ref:`redis-benchmark<doxid-group__tapi__redis__benchmark>`
|			:ref:`redis-server<doxid-group__tapi__redis__srv>`
|			:ref:`unbound DNS server<doxid-group__tapi__dns__unbound>`
|		:ref:`Storage and filesystem tools<doxid-group__tapi__tool__storage>`
|			:ref:`fio<doxid-group__tapi__fio>`
|				:ref:`fio helpers<doxid-group__tapi__fio__internal>`
|				:ref:`fio internals<doxid-group__tapi__fio__fio>`
|			:ref:`mke2fs<doxid-group__tapi__mke2fs>`
|		:ref:`System and diagnostic tools<doxid-group__tapi__tool__system>`
|			:ref:`GTest<doxid-group__tapi__gtest>`
|			:ref:`OpenSSH<doxid-group__tapi__ssh>`
|			:ref:`ctorrent<doxid-group__tapi__ctorrent>`
|				:ref:`bttrack torrent tracker<doxid-group__tapi__bttrack>`
|			:ref:`ethtool<doxid-group__tapi__ethtool>`
|			:ref:`packetdrill<doxid-group__tapi__packetdrill>`
|			:ref:`stress<doxid-group__tapi__stress>`
|	:ref:`Sockets and I/O<doxid-group__tapi__sockets>`
|		:ref:`High level socket helpers<doxid-group__ts__tapi__sockets>`
|		:ref:`I/O multiplexers<doxid-group__tapi__iomux>`
|		:ref:`struct sockaddr helpers<doxid-group__ts__tapi__sockaddr>`
|	:ref:`Traffic generation and capture<doxid-group__tapi__traffic>`
|		:ref:`Open vSwitch flow rules<doxid-group__ovs__flow__rule>`
|		:ref:`RADIUS server and CSAP<doxid-group__tapi__radius>`
|		:ref:`Traffic Application Domain<doxid-group__tapi__tad__main>`
|			:ref:`ARP<doxid-group__tapi__tad__arp>`
|			:ref:`ATM<doxid-group__tapi__tad__atm>`
|			:ref:`CLI<doxid-group__tapi__tad__cli>`
|			:ref:`DHCP<doxid-group__tapi__tad__dhcp>`
|			:ref:`Ethernet<doxid-group__tapi__tad__eth>`
|			:ref:`Forwarder module<doxid-group__tapi__tad__forw>`
|			:ref:`Generic TAD API<doxid-group__tapi__tad>`
|			:ref:`IGMP<doxid-group__tapi__tad__igmp>`
|			:ref:`IP stack<doxid-group__tapi__tad__ipstack>`
|				:ref:`Common functions for IPv4 and IPv6<doxid-group__tapi__tad__ip__common>`
|				:ref:`ICMP<doxid-group__tapi__tad__icmp>`
|				:ref:`ICMP4<doxid-group__tapi__tad__icmp4>`
|				:ref:`ICMP6<doxid-group__tapi__tad__icmp6>`
|				:ref:`IPv4<doxid-group__tapi__tad__ip4>`
|				:ref:`IPv6<doxid-group__tapi__tad__ip6>`
|				:ref:`Socket<doxid-group__tapi__tad__socket>`
|				:ref:`TCP<doxid-group__tapi__tad__tcp>`
|				:ref:`UDP<doxid-group__tapi__tad__udp>`
|			:ref:`Network Data Notation (NDN)<doxid-group__tapi__ndn>`
|			:ref:`PCAP<doxid-group__tapi__tad__pcap>`
|			:ref:`PPP<doxid-group__tapi__tad__ppp>`
|			:ref:`PPPOE<doxid-group__tapi__tad__pppoe>`
|			:ref:`Packet flow processing<doxid-group__tapi__tad__flow>`
|			:ref:`RTE mbuf<doxid-group__tapi__tad__rte__mbuf>`
|			:ref:`SNMP<doxid-group__tapi__tad__snmp>`
|			:ref:`STP<doxid-group__tapi__tad__stp>`
|			:ref:`iSCSI CSAP<doxid-group__tapi__tad__iscsi>`
|	:ref:`Writing a test scenario<doxid-group__tapi__scenario>`
|		:ref:`Engine and agent files<doxid-group__ts__tapi__file>`
|		:ref:`Memory helpers<doxid-group__tapi__mem>`
|		:ref:`Stack of jumps<doxid-group__ts__tapi__jmp>`
|		:ref:`TRC tags<doxid-group__ts__tapi__tags>`
|		:ref:`Target requirements<doxid-group__ts__tapi__reqs>`
|		:ref:`Test<doxid-group__te__ts__tapi__test>`
|			:ref:`Network environment<doxid-group__tapi__env>`
|			:ref:`Test execution flow<doxid-group__te__ts__tapi__test__log>`
|			:ref:`Test misc<doxid-group__te__ts__tapi__test__misc>`
|			:ref:`Test parameters<doxid-group__te__ts__tapi__test__param>`
|			:ref:`Test run status<doxid-group__te__ts__tapi__test__run__status>`