summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/automation/vyos-govyos.rst81
-rw-r--r--docs/automation/vyos-pyvyos.rst85
2 files changed, 81 insertions, 85 deletions
diff --git a/docs/automation/vyos-govyos.rst b/docs/automation/vyos-govyos.rst
index 659c2b6e..17e15b0e 100644
--- a/docs/automation/vyos-govyos.rst
+++ b/docs/automation/vyos-govyos.rst
@@ -1,38 +1,35 @@
-:lastproofread: 2024-03-10
+:lastproofread: 2026-04-14
.. _vyos-govyos:
#######
-go-vyos
+Go-VyOS
#######
-go-vyos is a Go library designed for interacting with VyOS devices through
-their REST API. This documentation is intended to guide you in using go-vyos for
-programmatic management of your VyOS devices.
+Go-VyOS is a Go library for configuring and managing VyOS devices through
+their API.
-- `go-vyos Documentation & Source Code on GitHub
- <https://github.com/ganawaj/go-vyos>`_
- allows you to access and contribute to the library's code.
-- `go-vyos on pkg.go.dev
- <https://pkg.go.dev/github.com/ganawaj/go-vyos@v0.1.0/vyos>`_
- for detailed instructions on the installation, configuration, and
- operation of the go-vyos library.
+- `GitHub repository <https://github.com/ganawaj/go-vyos>`_: Hosts the source
+ code.
+- `Documentation <https://pkg.go.dev/github.com/ganawaj/go-vyos@v0.1.0/vyos>`_:
+ Provides the complete API reference, including available types, functions, and
+ methods.
Installation
------------
-You can install go-vyos:
+To install Go-VyOS, run:
.. code-block:: bash
go install "github.com/ganawaj/go-vyos/vyos"
-Getting Started
+Getting started
---------------
-Importing and Disabling TLS Verification
--------------------------------------------------
+Import and disable TLS verification
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. stop_vyoslinter
@@ -43,8 +40,8 @@ Importing and Disabling TLS Verification
.. start_vyoslinter
-Initializing a VyDevice Object
-------------------------------
+Initialize a VyDevice object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -66,11 +63,11 @@ Initializing a VyDevice Object
client = client.Insecure()
}
-Using go-vyos
-----------------
+Use Go-VyOS
+-----------
-Configure, then Set
-^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then set
+^^^^^^^^^^^^^^^^^^^
.. stop_vyoslinter
@@ -85,8 +82,8 @@ Configure, then Set
.. start_vyoslinter
-Show a Single Object Value
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Show a single object value
+^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -98,8 +95,8 @@ Show a Single Object Value
fmt.Println(out.Success)
fmt.Printf("Data: %v\n", out.Data)
-Configure, then Show Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then show object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -111,8 +108,8 @@ Configure, then Show Object
fmt.Println(out.Success)
fmt.Printf("Data: %v\n", out.Data)
-Configure, then Show Multivalue Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then show multivalue object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -128,8 +125,8 @@ Configure, then Show Multivalue Object
fmt.Println(out.Success)
-Configure, then Delete Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then delete object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -140,8 +137,8 @@ Configure, then Delete Object
fmt.Println(out.Success)
-Configure, then Save
-^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then save
+^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -153,8 +150,8 @@ Configure, then Save
fmt.Println(out.Success)
-Configure, then Save File
--------------------------
+Configure, then save file
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -166,8 +163,8 @@ Configure, then Save File
fmt.Println(out.Success)
-Show Object
-^^^^^^^^^^^^^^
+Show object
+^^^^^^^^^^^
.. code-block:: none
@@ -179,8 +176,8 @@ Show Object
fmt.Println(out.Success)
fmt.Printf("Data: %v\n", out.Data)
-Generate Object
-^^^^^^^^^^^^^^^^
+Generate object
+^^^^^^^^^^^^^^^
.. code-block:: none
@@ -192,8 +189,8 @@ Generate Object
fmt.Println(out.Success)
fmt.Printf("Data: %v\n", out.Data)
-Reset Object
-^^^^^^^^^^^^^^
+Reset object
+^^^^^^^^^^^^
.. code-block:: none
@@ -205,8 +202,8 @@ Reset Object
fmt.Println(out.Success)
fmt.Printf("Data: %v\n", out.Data)
-Configure, then Load File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then load file
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
diff --git a/docs/automation/vyos-pyvyos.rst b/docs/automation/vyos-pyvyos.rst
index c178aeb6..cbd315e5 100644
--- a/docs/automation/vyos-pyvyos.rst
+++ b/docs/automation/vyos-pyvyos.rst
@@ -1,47 +1,46 @@
-:lastproofread: 2024-03-10
+:lastproofread: 2026-04-14
.. _vyos-pyvyos:
######
-pyvyos
+PyVyOS
######
-pyvyos is a Python library designed for interacting with VyOS devices through
-their API. This documentation is intended to guide you in using pyvyos for
-programmatic management of your VyOS devices.
+PyVyOS is a Python library for configuring and managing VyOS devices through
+their API.
-- `pyvyos Documentation on Read the Docs
- <https://pyvyos.readthedocs.io/en/latest/>`_ provides detailed instructions
- on the installation, configuration, and operation of the pyvyos library.
-- `pyvyos Source Code on GitHub <https://github.com/robertoberto/pyvyos>`_
- allows you to access and contribute to the library's code.
-- `pyvyos on PyPI <https://pypi.org/project/pyvyos/>`_ for easy installation
- via pip, the Python package installer. Execute `pip install pyvyos` in your
- terminal to install.
+**Key resources:**
+
+- `Documentation <https://pyvyos.readthedocs.io/en/latest/>`_: Provides
+ installation, configuration, and usage instructions.
+- `GitHub repository <https://github.com/robertoberto/pyvyos>`_: Hosts the
+ source code.
+- `PyPI <https://pypi.org/project/pyvyos/>`_: Hosts distribution packages for
+ installation via the Python package installer (``pip``).
Installation
------------
-You can install pyvyos using pip:
+To install PyVyOS via ``pip``, run:
.. code-block:: bash
pip install pyvyos
-Getting Started
+Getting started
---------------
-Importing and Disabling Warnings for verify=False
--------------------------------------------------
+Import and disable warnings for verify=false
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
import urllib3
urllib3.disable_warnings()
-Using API Response Class
-------------------------
+Use API response class
+^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -52,8 +51,8 @@ Using API Response Class
result: dict
error: str
-Initializing a VyDevice Object
-------------------------------
+Initialize a VyDevice object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -70,11 +69,11 @@ Initializing a VyDevice Object
device = VyDevice(hostname=hostname, apikey=apikey, port=port, protocol=protocol, verify=verify)
-Using pyvyos
-------------
+Use PyVyOS
+----------
-Configure, then Set
-^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then set
+^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -82,16 +81,16 @@ Configure, then Set
if not response.error:
print(response.result)
-Configure, then Show a Single Object Value
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then show a single object value
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.retrieve_return_values(path=["interfaces", "dummy", "dum1", "address"])
print(response.result)
-Configure, then Show Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then show object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
@@ -99,37 +98,37 @@ Configure, then Show Object
if not response.error:
print(response.result)
-Configure, then Delete Object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then delete object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.configure_delete(path=["interfaces", "dummy", "dum1"])
-Configure, then Save
-^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then save
+^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.config_file_save()
-Configure, then Save File
--------------------------
+Configure, then save file
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.config_file_save(file="/config/test300.config")
-Show Object
-^^^^^^^^^^^^^^
+Show object
+^^^^^^^^^^^
.. code-block:: none
response = device.show(path=["system", "image"])
print(response.result)
-Generate Object
-^^^^^^^^^^^^^^^^
+Generate object
+^^^^^^^^^^^^^^^
.. code-block:: none
@@ -137,8 +136,8 @@ Generate Object
keyrand = f'/tmp/key_{randstring}'
response = device.generate(path=["ssh", "client-key", keyrand])
-Reset Object
-^^^^^^^^^^^^^^
+Reset object
+^^^^^^^^^^^^
.. code-block:: none
@@ -146,8 +145,8 @@ Reset Object
if not response.error:
print(response.result)
-Configure, then Load File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Configure, then load file
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
generated by cgit v1.2.3 (git 2.39.1) at 2026-07-14 11:10:31 +0000