From 5041237e18bd1249aa96065d32778eb60dd1ed2a Mon Sep 17 00:00:00 2001 From: Christian Giese Date: Mon, 7 Nov 2022 14:18:30 +0000 Subject: [PATCH] update documentation --- docsrc/sources/api/index.rst | 24 ++++++++++++++++++++++++ docsrc/sources/api/interfaces.rst | 16 ++++++++++++++++ docsrc/sources/api/sessions.rst | 2 +- 3 files changed, 41 insertions(+), 1 deletion(-) diff --git a/docsrc/sources/api/index.rst b/docsrc/sources/api/index.rst index 1e579365..66798ba5 100644 --- a/docsrc/sources/api/index.rst +++ b/docsrc/sources/api/index.rst @@ -129,6 +129,30 @@ for interactive communication with the BNG Blaster. } +Test +---- + +.. list-table:: + :header-rows: 1 + + * - Attribute + - Description + - Mandatory Arguments + - Optional Arguments + * - `test-info` + - Display information about the running test instance + - + - + * - `monkey-start` + - Start monkey test + - + - + * - `monkey-stop` + - Stop monkey test + - + - + + Interfaces ---------- .. include:: interfaces.rst diff --git a/docsrc/sources/api/interfaces.rst b/docsrc/sources/api/interfaces.rst index ad5a181b..a2c19735 100644 --- a/docsrc/sources/api/interfaces.rst +++ b/docsrc/sources/api/interfaces.rst @@ -9,3 +9,19 @@ - List all interfaces with index - - + * - `access-interfaces` + - List all access interface functions + - + - + * - `network-interfaces` + - List all network interface functions + - + - + * - `a10nsp-interfaces` + - List all a10nsp interface functions + - + - + * - `lag-info` + - List all link aggregation (LAG) interfaces + - + - \ No newline at end of file diff --git a/docsrc/sources/api/sessions.rst b/docsrc/sources/api/sessions.rst index 737cf711..b5b6a2e2 100644 --- a/docsrc/sources/api/sessions.rst +++ b/docsrc/sources/api/sessions.rst @@ -43,5 +43,5 @@ - The argument ``reconnect-delay`` is only applicable in combination with ``session-id`` -and reconnect enabled in configuration. This argument allows to delay the session +and reconnect enabled in the configuration. This argument allows to delay the session reconnect by the defined amount of seconds.