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
|
:lastproofread: 2023-01-16
.. _vyos-napalm:
Napalm
======
VyOS supports some napalm_ functions for configuration and op-mode.
It requires more tests.
Install ``napalm-vyos`` module
.. code-block:: none
apt install python3-pip
pip3 install napalm
pip3 install napalm-vyos
Op-mode
-------
.. code-block:: none
#!/usr/bin/env python3
import json
from napalm import get_network_driver
driver = get_network_driver('vyos')
vyos_router = driver(
hostname="192.0.2.1",
username="vyos",
password="vyospass",
optional_args={"port": 22},
)
vyos_router.open()
output = vyos_router.get_facts()
print(json.dumps(output, indent=4))
output = vyos_router.get_arp_table()
print(json.dumps(output, indent=4))
vyos_router.close()
Output op-mode
.. code-block:: none
$ ./vyos-napalm.py
{
"uptime": 7185,
"vendor": "VyOS",
"os_version": "1.3.0-rc5",
"serial_number": "",
"model": "Standard PC (Q35 + ICH9, 2009)",
"hostname": "r4-1.3",
"fqdn": "vyos.local",
"interface_list": [
"eth0",
"eth1",
"eth2",
"lo",
"vtun10"
]
}
[
{
"interface": "eth1",
"mac": "52:54:00:b2:38:2c",
"ip": "192.0.2.2",
"age": 0.0
},
{
"interface": "eth0",
"mac": "52:54:00:a2:b9:5b",
"ip": "203.0.113.11",
"age": 0.0
}
]
Configuration
-------------
We need 2 files, commands.conf and script itself.
Content of commands.conf
.. code-block:: none
set service ssh disable-host-validation
set service ssh port '2222'
set system name-server '192.0.2.8'
set system name-server '203.0.113.8'
set interfaces ethernet eth1 description 'FOO'
Script vyos-napalm.py
.. code-block:: none
#!/usr/bin/env python3
from napalm import get_network_driver
driver = get_network_driver('vyos')
vyos_router = driver(
hostname="192.0.2.1",
username="vyos",
password="vyospass",
optional_args={"port": 22},
)
vyos_router.open()
vyos_router.load_merge_candidate(filename='commands.conf')
diffs = vyos_router.compare_config()
if bool(diffs) == True:
print(diffs)
vyos_router.commit_config()
else:
print('No configuration changes to commit')
vyos_router.discard_config()
vyos_router.close()
Output
.. code-block:: none
$./vyos-napalm.py
[edit interfaces ethernet eth1]
+description FOO
[edit service ssh]
+disable-host-validation
+port 2222
[edit system]
+name-server 192.0.2.8
+name-server 203.0.113.8
[edit]
.. _napalm: https://napalm.readthedocs.io/en/latest/base.html
|
