vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

+ pyvyos python sdk improved titles

Browse Source
This commit is contained in:
Roberto Berto 2023-12-15 17:32:23 -03:00
parent b2c1c8a31b
commit ddc9c32d02
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/automation/index.rst
View File

@ -13,9 +13,9 @@ VyOS Automation
vyos-api vyos-api
vyos-ansible vyos-ansible
vyos-napalm vyos-napalm
vyos-pyvyos
vyos-netmiko vyos-netmiko
vyos-salt vyos-salt
command-scripting command-scripting
cloud-init cloud-init
vyos-pyvyos

40
docs/automation/vyos-pyvyos.rst
View File

@ -23,14 +23,16 @@ You can install PyVyOS using pip:
Getting Started Getting Started
--------------- ---------------
### Importing and Disabling Warnings for verify=False Importing and Disabling Warnings for verify=False
-------------------------------------------------
.. code-block:: none .. code-block:: none
import urllib3 import urllib3
urllib3.disable_warnings() urllib3.disable_warnings()
### Using API Response Class Using API Response Class
------------------------
.. code-block:: none .. code-block:: none
@ -41,7 +43,8 @@ Getting Started
result: dict result: dict
error: str error: str
### Initializing a VyDevice Object Initializing a VyDevice Object
------------------------------
.. code-block:: none .. code-block:: none
@ -61,7 +64,8 @@ Getting Started
Using PyVyOS Using PyVyOS
------------ ------------
### Configure, then Set Configure, then Set
^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
@ -69,14 +73,16 @@ Using PyVyOS
if not response.error: if not response.error:
print(response.result) print(response.result)
### Configure, then Show a Single Object Value Configure, then Show a Single Object Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
response = device.retrieve_return_values(path=["interfaces", "dummy", "dum1", "address"]) response = device.retrieve_return_values(path=["interfaces", "dummy", "dum1", "address"])
print(response.result) print(response.result)
### Configure, then Show Object Configure, then Show Object
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
@ -84,32 +90,37 @@ Using PyVyOS
if not response.error: if not response.error:
print(response.result) print(response.result)
### Configure, then Delete Object Configure, then Delete Object
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
response = device.configure_delete(path=["interfaces", "dummy", "dum1"]) response = device.configure_delete(path=["interfaces", "dummy", "dum1"])
### Configure, then Save Configure, then Save
^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
response = device.config_file_save() response = device.config_file_save()
### Configure, then Save File Configure, then Save File
-------------------------
.. code-block:: none .. code-block:: none
response = device.config_file_save(file="/config/test300.config") response = device.config_file_save(file="/config/test300.config")
### Show Object Show Object
^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
response = device.show(path=["system", "image"]) response = device.show(path=["system", "image"])
print(response.result) print(response.result)
### Generate Object Generate Object
^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
@ -117,7 +128,8 @@ Using PyVyOS
keyrand = f'/tmp/key_{randstring}' keyrand = f'/tmp/key_{randstring}'
response = device.generate(path=["ssh", "client-key", keyrand]) response = device.generate(path=["ssh", "client-key", keyrand])
### Reset Object Reset Object
^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
@ -125,10 +137,12 @@ Using PyVyOS
if not response.error: if not response.error:
print(response.result) print(response.result)
### Configure, then Load File Configure, then Load File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none .. code-block:: none
response = device.config_file_load(file="/config/test300.config") response = device.config_file_load(file="/config/test300.config")
. _pyvyos: https://github.com/robertoberto/pyvyos . _pyvyos: https://github.com/robertoberto/pyvyos