1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
:lastproofread: 2024-03-10
.. _vyos-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 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.
Installation
------------
You can install pyvyos using pip:
.. code-block:: bash
pip install pyvyos
Getting Started
---------------
Importing and Disabling Warnings for verify=False
-------------------------------------------------
.. code-block:: none
import urllib3
urllib3.disable_warnings()
Using API Response Class
------------------------
.. code-block:: none
@dataclass
class ApiResponse:
status: int
request: dict
result: dict
error: str
Initializing a VyDevice Object
------------------------------
.. code-block:: none
from dotenv import load_dotenv
load_dotenv()
hostname = os.getenv('VYDEVICE_HOSTNAME')
apikey = os.getenv('VYDEVICE_APIKEY')
port = os.getenv('VYDEVICE_PORT')
protocol = os.getenv('VYDEVICE_PROTOCOL')
verify_ssl = os.getenv('VYDEVICE_VERIFY_SSL')
verify = verify_ssl.lower() == "true" if verify_ssl else True
device = VyDevice(hostname=hostname, apikey=apikey, port=port, protocol=protocol, verify=verify)
Using pyvyos
------------
Configure, then Set
^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.configure_set(path=["interfaces", "ethernet", "eth0", "address", "192.168.1.1/24"])
if not response.error:
print(response.result)
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.retrieve_show_config(path=[])
if not response.error:
print(response.result)
Configure, then Delete Object
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.configure_delete(path=["interfaces", "dummy", "dum1"])
Configure, then Save
^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.config_file_save()
Configure, then Save File
-------------------------
.. code-block:: none
response = device.config_file_save(file="/config/test300.config")
Show Object
^^^^^^^^^^^^^^
.. code-block:: none
response = device.show(path=["system", "image"])
print(response.result)
Generate Object
^^^^^^^^^^^^^^^^
.. code-block:: none
randstring = ''.join(random.choice(string.ascii_letters + string.digits) for _ in range(20))
keyrand = f'/tmp/key_{randstring}'
response = device.generate(path=["ssh", "client-key", keyrand])
Reset Object
^^^^^^^^^^^^^^
.. code-block:: none
response = device.reset(path=["conntrack-sync", "internal-cache"])
if not response.error:
print(response.result)
Configure, then Load File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
response = device.config_file_load(file="/config/test300.config")
.. _pyvyos: https://github.com/robertoberto/pyvyos
|
