From fbc742fa10a3e8025e865aae8aab2a51606f5575 Mon Sep 17 00:00:00 2001 From: omnom62 Date: Wed, 3 Jun 2026 21:16:04 +1000 Subject: snmp_server module sit --- docs/vyos.rest.vyos_configure_module.rst | 168 +++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 docs/vyos.rest.vyos_configure_module.rst (limited to 'docs') diff --git a/docs/vyos.rest.vyos_configure_module.rst b/docs/vyos.rest.vyos_configure_module.rst new file mode 100644 index 0000000..bc5921d --- /dev/null +++ b/docs/vyos.rest.vyos_configure_module.rst @@ -0,0 +1,168 @@ +.. _vyos.rest.vyos_configure_module: + + +************************ +vyos.rest.vyos_configure +************************ + +**Send raw set/delete commands to a VyOS device via REST API.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Sends one or more set/delete configuration commands to a VyOS device via the HTTPS REST API as a single atomic batch commit. +- Useful for configuration not covered by dedicated resource modules, or for test setup and teardown tasks. +- Commands are parsed from CLI-style strings (``set ...`` / ``delete ...``). + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ commands + +
+ list + / elements=string + / required +
+ 		+ +
List of CLI-style configuration commands.
+
Each command must start with set or delete.
+
+
+ save + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Whether to save the configuration after applying commands.
+
+
+ + + +See Also +-------- + +.. seealso:: + + :ref:`vyos.vyos.vyos_config_module` + The official documentation on the **vyos.vyos.vyos_config** module. + + +Examples +-------- + +.. code-block:: yaml + + - name: Add loopback address for testing + vyos.rest.vyos_configure: + commands: + - set interfaces loopback lo address 20.1.1.1/32 + save: false + + - name: Remove loopback address after testing + vyos.rest.vyos_configure: + commands: + - delete interfaces loopback lo address 20.1.1.1/32 + save: false + + - name: Multiple commands in one atomic commit + vyos.rest.vyos_configure: + commands: + - set system host-name vyos-test + - set system domain-name example.com + save: true + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
Parsed command payloads sent to the device.
+
+
+
+ response + +
+ dictionary +
+ 		when commands are applied +
Raw API response.
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- VyOS Community (@vyos) -- cgit v1.2.3