NAPALM Vyos Driver
This commit is contained in:
Pieprzycki Piotr
parent
8eef0f24b2
commit
b4881c4acb
|
|
@ -51,14 +51,6 @@ coverage.xml
|
|||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
|
@ -66,24 +58,5 @@ docs/_build/
|
|||
# PyBuilder
|
||||
target/
|
||||
|
||||
# IPython Notebook
|
||||
#Ipython Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# celery beat schedule file
|
||||
celerybeat-schedule
|
||||
|
||||
# dotenv
|
||||
.env
|
||||
|
||||
# virtualenv
|
||||
venv/
|
||||
ENV/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
|
|
|||
|
|
@ -0,0 +1,31 @@
|
|||
language: python
|
||||
python:
|
||||
- 2.7
|
||||
install:
|
||||
- pip install -r requirements.txt
|
||||
- pip install .
|
||||
deploy:
|
||||
provider: pypi
|
||||
user: dbarroso
|
||||
password:
|
||||
secure: d9XnLqr0mmLiMONfoiSqShwQ761pD3THIwsEtllm1/1KknoFyOtyqYOfPvUIvy2wg7JGDYyRCfyj1j3SiYz1whmmtAmtOZYYB14wk3eftNBVHDERc1ROOVO2u3ahL6WwdZBhxjpuz6lXX0sSJtDxY2IBFGDy2cj2VzWyuiWKoS2YrQoLTLBt/FWPbHvVIIeUkQ1wZnZ/G0H45ZAntd9v9BCFkjKc2wEagPYv5Li+54Tet8nFiNFC/m+UBbcgtITFp5xNz0nbjMDTxKwIEgRNqXig/P/OOeh3aNtjPZtwLdeuJw/p4QBZ+eCnqD9paGcOdkCpK6b4i+8RV8n3/Dpz3qbyYBxpMqAn+JnOpVpWWnoARI3Kc+hHMpuT9fPLt+J5iqU/YZQhDRavmrggYWlnqWk67udFxDBec6BidQuZfksVhdT6CcD5cATRDrV0m7CchAQa0RDJ9NRUFu3L6h3vP5F49xzFPa87fG1s9l/Qccby5/rR3cryyHcnxsw1F1kPD1cpWbHwmkPnWYAqzYIso8rhJ8XjNj4Cw5/S4E1ri4e7fKRmYKYgB7Eq1QkefODAoDu6LBOkf2JtGOrSEa+bwLx2nnoGWfs6KkkRKzJNuNwBVYQYhfSRXLsXzWwfpYwqCuuEt/p4scgkqLtm5cGqZ5EG15g52N9gnQzpK8MK+uw=
|
||||
on:
|
||||
tags: true
|
||||
branch: master
|
||||
script:
|
||||
- cd test/unit
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_arp_table
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_bgp_neighbors
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_environment
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_facts
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_interfaces
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_interfaces_counters
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_interfaces_ip
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_lldp_neighbors
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_lldp_neighbors_detail
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_mac_address_table
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_ntp_stats
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_snmp_information
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_ios_only_bgp_time_conversion
|
||||
- nosetests -v TestIOSDriver:TestGetterIOSDriver.test_ping
|
||||
- cd ../..
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
David Barroso <dbarrosop@dravetech.com>
|
||||
Elisa Jasinska <elisa@bigwaveit.org>
|
||||
Shota Muto
|
||||
Piotr Pieprzycki <piotr.pieprzycki@dreamlab.pl>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
include requirements.txt
|
||||
include napalm_vyos/templates/*.j2
|
||||
include napalm_vyos/utils/textfsm_templates/*.tpl
|
||||
|
|
@ -1 +1,5 @@
|
|||
# napalm-vyos
|
||||
[](https://pypi.python.org/pypi/napalm-vyos)
|
||||
[](https://pypi.python.org/pypi/napalm-vyos)
|
||||
[](https://travis-ci.org/napalm-automation/napalm-vyos)
|
||||
|
||||
# napalm-vyos
|
||||
|
|
|
|||
|
|
@ -0,0 +1,16 @@
|
|||
# Copyright 2016 Dravetech AB. All rights reserved.
|
||||
#
|
||||
# The contents of this file are licensed under the Apache License, Version 2.0
|
||||
# (the "License"); you may not use this file except in compliance with the
|
||||
# License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations under
|
||||
# the License.
|
||||
|
||||
"""napalm_vyos package."""
|
||||
from vyos import VyOSDriver
|
||||
|
|
@ -0,0 +1 @@
|
|||
"""napalm.utils package."""
|
||||
|
|
@ -0,0 +1,788 @@
|
|||
# Copyright 2016 Dravetech AB. All rights reserved.
|
||||
#
|
||||
# The contents of this file are licensed under the Apache License, Version 2.0
|
||||
# (the "License"); you may not use this file except in compliance with the
|
||||
# License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations under
|
||||
# the License.
|
||||
|
||||
"""
|
||||
Napalm driver for VyOS.
|
||||
|
||||
Read napalm.readthedocs.org for more information.
|
||||
|
||||
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
|
||||
import vyattaconfparser
|
||||
|
||||
|
||||
from netmiko import ConnectHandler
|
||||
from netmiko import SCPConn
|
||||
|
||||
|
||||
# NAPALM base
|
||||
from napalm_base.base import NetworkDriver
|
||||
from napalm_base.exceptions import ConnectionException, SessionLockedException, \
|
||||
MergeConfigException, ReplaceConfigException,\
|
||||
CommandErrorException
|
||||
|
||||
|
||||
class VyOSDriver(NetworkDriver):
|
||||
|
||||
_MINUTE_SECONDS = 60
|
||||
_HOUR_SECONDS = 60 * _MINUTE_SECONDS
|
||||
_DAY_SECONDS = 24 * _HOUR_SECONDS
|
||||
_WEEK_SECONDS = 7 * _DAY_SECONDS
|
||||
_YEAR_SECONDS = 365 * _DAY_SECONDS
|
||||
_DEST_FILENAME = "/var/tmp/candidate_running.conf"
|
||||
_BACKUP_FILENAME = "/var/tmp/backup_running.conf"
|
||||
_BOOT_FILENAME = "/config/config.boot"
|
||||
|
||||
def __init__(self, hostname, username, password, timeout=60, optional_args=None):
|
||||
self._hostname = hostname
|
||||
self._username = username
|
||||
self._password = password
|
||||
self._timeout = timeout
|
||||
self._device = None
|
||||
self._scp_client = None
|
||||
self._new_config = None
|
||||
self._old_config = None
|
||||
self._ssh_usekeys = False
|
||||
|
||||
if optional_args is None:
|
||||
optional_args = {}
|
||||
self._port = optional_args.get('port', 22)
|
||||
self._ssh_keyfile = optional_args.get('ssh_keyfile', None)
|
||||
if self._ssh_keyfile != None:
|
||||
self._ssh_usekeys = True
|
||||
|
||||
|
||||
|
||||
|
||||
def open(self):
|
||||
|
||||
device = {
|
||||
'device_type': 'vyos',
|
||||
'ip': self._hostname,
|
||||
'username': self._username,
|
||||
'password': self._password,
|
||||
'use_keys': self._ssh_usekeys,
|
||||
'key_file': self._ssh_keyfile,
|
||||
'port' : self._port, # optional, defaults to 22
|
||||
'secret': 'secret', # optional, defaults to ''
|
||||
'verbose': False, # optional, defaults to False
|
||||
}
|
||||
|
||||
self._device = ConnectHandler(**device)
|
||||
self._scp_client = SCPConn(self._device)
|
||||
|
||||
|
||||
def close(self):
|
||||
self._device.close()
|
||||
|
||||
def load_replace_candidate(self, filename=None, config=None):
|
||||
"""
|
||||
Only configuration files are supported with load_replace_candidate.
|
||||
It must be a full config file like /config/config.boot
|
||||
Due to the OS nature, we do not
|
||||
support a replace using a configuration string.
|
||||
"""
|
||||
if filename is not None:
|
||||
if os.path.exists(filename) == True:
|
||||
self._scp_client.scp_transfer_file(filename, self._DEST_FILENAME)
|
||||
print self._device.send_command("cp "+self._BOOT_FILENAME+" "+self._BACKUP_FILENAME)
|
||||
output_loadcmd = self._device.send_config_set(['load '+self._DEST_FILENAME])
|
||||
match = re.findall("Load complete.", output_loadcmd)
|
||||
if not match:
|
||||
raise ReplaceConfigException("Failed replace config: "
|
||||
+output_loadcmd)
|
||||
else:
|
||||
raise ReplaceConfigException("config file is not found")
|
||||
else:
|
||||
raise ReplaceConfigException("no configuration found")
|
||||
|
||||
def load_merge_candidate(self, filename=None, config=None):
|
||||
"""
|
||||
Only configuration in set-format is supported with load_merge_candidate.
|
||||
"""
|
||||
if filename is not None:
|
||||
if os.path.exists(filename) == True:
|
||||
with open(filename) as f:
|
||||
print self._device.send_command("cp "+self._BOOT_FILENAME+" "+self._BACKUP_FILENAME)
|
||||
self._new_config = f.read()
|
||||
cfg = [x for x in self._new_config.split("\n") if x is not ""]
|
||||
self._device.send_config_set(cfg)
|
||||
else:
|
||||
raise MergeConfigException("config file is not found")
|
||||
elif config is not None:
|
||||
self._new_config = config
|
||||
else:
|
||||
raise MergeConfigException("no configuration found")
|
||||
|
||||
|
||||
def discard_config(self):
|
||||
self._device.send_config_set(['discard'])
|
||||
|
||||
def compare_config(self):
|
||||
output_compare = self._device.send_config_set(['compare'])
|
||||
match = re.findall("No changes between working and active configurations",
|
||||
output_compare)
|
||||
if match:
|
||||
return
|
||||
else:
|
||||
return output_compare
|
||||
|
||||
def commit_config(self):
|
||||
self._device.send_config_set(['commit', 'save'])
|
||||
|
||||
def rollback(self, filename=None):
|
||||
"""Rollback configuration to filename or to self.rollback_cfg file."""
|
||||
if filename is None:
|
||||
filename=self._BACKUP_FILENAME
|
||||
|
||||
output_loadcmd = self._device.send_config_set(['load '+filename])
|
||||
match = re.findall("Load complete.", output_loadcmd)
|
||||
if not match:
|
||||
raise ReplaceConfigException("Failed rollback config: "
|
||||
+output_loadcmd)
|
||||
else:
|
||||
self._device.send_config_set(['commit', 'save'])
|
||||
|
||||
|
||||
|
||||
def get_environment(self):
|
||||
|
||||
"""
|
||||
'vmstat' output:
|
||||
procs -----------memory---------- ---swap-- -----io---- -system-- ----cpu----
|
||||
r b swpd free buff cache si so bi bo in cs us sy id wa
|
||||
0 0 0 61404 139624 139360 0 0 0 0 9 14 0 0 100 0
|
||||
"""
|
||||
output_cpu = self._device.send_command("vmstat").split("\n")[-1]
|
||||
cpu = 100 - int(output_cpu.split()[-2])
|
||||
|
||||
"""
|
||||
'free' output:
|
||||
total used free shared buffers cached
|
||||
Mem: 508156 446784 61372 0 139624 139360
|
||||
-/+ buffers/cache: 167800 340356
|
||||
Swap: 0 0 0
|
||||
"""
|
||||
output_ram = self._device.send_command("free").split("\n")[1]
|
||||
available_ram, used_ram = output_ram.split()[1:3]
|
||||
|
||||
environment = {
|
||||
"fans": {
|
||||
"status": None
|
||||
},
|
||||
"temperature": {
|
||||
"temperature": None,
|
||||
"is_alert" : None,
|
||||
"is_critical": None
|
||||
},
|
||||
"power": {
|
||||
"status" : None,
|
||||
"capacity": None,
|
||||
"output" : None
|
||||
},
|
||||
"cpu": {
|
||||
"0": {
|
||||
"%usage": cpu
|
||||
},
|
||||
},
|
||||
"memory": {
|
||||
"available_ram": int(available_ram),
|
||||
"used_ram" : int(used_ram)
|
||||
}
|
||||
}
|
||||
|
||||
return environment
|
||||
|
||||
|
||||
def get_interfaces(self):
|
||||
"""
|
||||
"show interfaces" output example:
|
||||
Interface IP Address S/L Description
|
||||
--------- ---------- --- -----------
|
||||
br0 - u/D
|
||||
eth0 192.168.1.1/24 u/u Management
|
||||
eth1 192.168.1.2/24 u/u
|
||||
eth2 192.168.3.1/24 u/u foobar
|
||||
192.168.2.2/24
|
||||
lo 127.0.0.1/8 u/u
|
||||
::1/128
|
||||
"""
|
||||
output_iface = self._device.send_command("show interfaces")
|
||||
|
||||
# Collect all interfaces' name and status
|
||||
match = re.findall("(\S+)\s+[:\-\d/\.]+\s+([uAD])/([uAD])", output_iface)
|
||||
|
||||
# 'match' example:
|
||||
# [("br0", "u", "D"), ("eth0", "u", "u"), ("eth1", "u", "u")...]
|
||||
iface_state = {iface_name:{"State": state, "Link": link} for iface_name, state, link in match}
|
||||
|
||||
output_conf = self._device.send_command("show configuration")
|
||||
|
||||
# Convert the configuration to dictionary
|
||||
config = vyattaconfparser.parse_conf(output_conf)
|
||||
|
||||
iface_dict = dict()
|
||||
|
||||
for iface_type in config["interfaces"]:
|
||||
|
||||
ifaces_detail = config["interfaces"][iface_type]
|
||||
|
||||
for iface_name in ifaces_detail:
|
||||
|
||||
description = self._get_value("description", ifaces_detail[iface_name])
|
||||
speed = self._get_value("speed", ifaces_detail[iface_name])
|
||||
hw_id = self._get_value("hw-id", ifaces_detail[iface_name])
|
||||
|
||||
is_up = (iface_state[iface_name]["Link"] == "u")
|
||||
is_enabled = (iface_state[iface_name]["State"] == "u")
|
||||
|
||||
iface_dict.update({
|
||||
iface_name: {
|
||||
"is_up" : is_up,
|
||||
"is_enabled" : is_enabled,
|
||||
"description" : description,
|
||||
"last_flapped" : -1,
|
||||
"speed" : speed,
|
||||
"mac_address" : hw_id
|
||||
}
|
||||
})
|
||||
|
||||
return iface_dict
|
||||
|
||||
|
||||
# for avoiding KeyError
|
||||
@staticmethod
|
||||
def _get_value(key, target_dict):
|
||||
if key in target_dict:
|
||||
return target_dict[key]
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
def get_arp_table(self):
|
||||
# 'age' is not implemented yet
|
||||
|
||||
"""
|
||||
'show arp' output example:
|
||||
Address HWtype HWaddress Flags Mask Iface
|
||||
10.129.2.254 ether 00:50:56:97:af:b1 C eth0
|
||||
192.168.1.134 (incomplete) eth1
|
||||
192.168.1.1 ether 00:50:56:ba:26:7f C eth1
|
||||
10.129.2.97 ether 00:50:56:9f:64:09 C eth0
|
||||
192.168.1.3 ether 00:50:56:86:7b:06 C eth1
|
||||
"""
|
||||
output = self._device.send_command("show arp")
|
||||
output = output.split("\n")
|
||||
|
||||
# Skip the header line
|
||||
output = output[1:-1]
|
||||
|
||||
arp_table = list()
|
||||
for line in output:
|
||||
|
||||
line = line.split()
|
||||
# 'line' example:
|
||||
# ["10.129.2.254", "ether", "00:50:56:97:af:b1", "C", "eth0"]
|
||||
# [u'10.0.12.33', u'(incomplete)', u'eth1']
|
||||
if "incomplete" in line[1]:
|
||||
macaddr=None
|
||||
else:
|
||||
macaddr=unicode(line[2])
|
||||
|
||||
arp_table.append({
|
||||
"interface" : unicode(line[-1]),
|
||||
"mac" : macaddr,
|
||||
"ip" : unicode(line[0]),
|
||||
"age" : None
|
||||
})
|
||||
|
||||
return arp_table
|
||||
|
||||
|
||||
def get_ntp_stats(self):
|
||||
"""
|
||||
'ntpq -np' output example
|
||||
remote refid st t when poll reach delay offset jitter
|
||||
==============================================================================
|
||||
116.91.118.97 133.243.238.244 2 u 51 64 377 5.436 987971. 1694.82
|
||||
219.117.210.137 .GPS. 1 u 17 64 377 17.586 988068. 1652.00
|
||||
133.130.120.204 133.243.238.164 2 u 46 64 377 7.717 987996. 1669.77
|
||||
"""
|
||||
|
||||
output = self._device.send_command("ntpq -np").split("\n")[2:]
|
||||
ntp_stats = list()
|
||||
|
||||
for ntp_info in output:
|
||||
|
||||
remote, refid, st, t, when, hostpoll, reachability, delay, offset, jitter = ntp_info.split()
|
||||
|
||||
# 'remote' contains '*' if the machine synchronized with NTP server
|
||||
synchronized = "*" in remote
|
||||
|
||||
match = re.search("(\d+\.\d+\.\d+\.\d+)", remote)
|
||||
ip = match.group(1)
|
||||
|
||||
when = when if when != '-' else 0
|
||||
|
||||
ntp_stats.append({
|
||||
"remote" : unicode(ip),
|
||||
"referenceid" : unicode(refid),
|
||||
"synchronized": synchronized,
|
||||
"stratum" : int(st),
|
||||
"type" : unicode(t),
|
||||
"when" : int(when),
|
||||
"hostpoll" : int(hostpoll),
|
||||
"reachability": int(reachability),
|
||||
"delay" : float(delay),
|
||||
"offset" : float(offset),
|
||||
"jitter" : float(jitter)
|
||||
})
|
||||
|
||||
return ntp_stats
|
||||
|
||||
|
||||
def get_ntp_peers(self):
|
||||
output = self._device.send_command("ntpq -np").split("\n")[2:]
|
||||
|
||||
ntp_peers = dict()
|
||||
|
||||
for line in output:
|
||||
match = re.search("(\d+\.\d+\.\d+\.\d+)\s+", line)
|
||||
ntp_peers.update({
|
||||
unicode(match.group(1)): {}
|
||||
})
|
||||
|
||||
return ntp_peers
|
||||
|
||||
def get_bgp_neighbors(self):
|
||||
# 'description', 'sent_prefixes' and 'received_prefixes' are not implemented yet
|
||||
|
||||
"""
|
||||
'show ip bgp summary' output example:
|
||||
BGP router identifier 192.168.1.2, local AS number 64520
|
||||
IPv4 Unicast - max multipaths: ebgp 1 ibgp 1
|
||||
RIB entries 3, using 288 bytes of memory
|
||||
Peers 3, using 13 KiB of memory
|
||||
|
||||
Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd
|
||||
192.168.1.1 4 64519 7226 7189 0 0 0 4d23h40m 1
|
||||
192.168.1.3 4 64521 7132 7103 0 0 0 4d21h05m 0
|
||||
192.168.1.4 4 64522 0 0 0 0 0 never Active
|
||||
"""
|
||||
|
||||
|
||||
output = self._device.send_command("show ip bgp summary").split("\n")
|
||||
|
||||
match = re.search(".* router identifier (\d+\.\d+\.\d+\.\d+), local AS number (\d+)", output[0])
|
||||
if not match:
|
||||
return {}
|
||||
router_id = unicode(match.group(1))
|
||||
local_as = int(match.group(2))
|
||||
|
||||
bgp_neighbor_data = dict()
|
||||
bgp_neighbor_data["global"] = dict()
|
||||
bgp_neighbor_data["global"]["router_id"] = router_id
|
||||
bgp_neighbor_data["global"]["peers"] = {}
|
||||
|
||||
# delete the header and empty element
|
||||
bgp_info = [i.strip() for i in output[6:-2] if i is not ""]
|
||||
|
||||
for i in bgp_info:
|
||||
peer_id , bgp_version, remote_as, msg_rcvd, msg_sent, table_version, \
|
||||
in_queue, out_queue, up_time, state_prefix = i.split()
|
||||
|
||||
is_enabled = "(Admin)" not in state_prefix
|
||||
|
||||
received_prefixes = None
|
||||
|
||||
try:
|
||||
state_prefix = int(state_prefix)
|
||||
received_prefixes = int(state_prefix)
|
||||
is_up = True
|
||||
except ValueError:
|
||||
is_up = False
|
||||
|
||||
if bgp_version == "4":
|
||||
address_family = "ipv4"
|
||||
elif bgp_version == "6":
|
||||
address_family = "ipv6"
|
||||
else:
|
||||
raise ValueError("BGP neighbor parsing failed")
|
||||
|
||||
"""
|
||||
'show ip bgp neighbors 192.168.1.1' output example:
|
||||
BGP neighbor is 192.168.1.1, remote AS 64519, local AS 64520, external link
|
||||
BGP version 4, remote router ID 192.168.1.1
|
||||
For address family: IPv4 Unicast
|
||||
~~~
|
||||
Community attribute sent to this neighbor(both)
|
||||
1 accepted prefixes
|
||||
~~~
|
||||
"""
|
||||
bgp_detail = self._device.send_command("show ip bgp neighbors %s" % peer_id)
|
||||
|
||||
match_rid = re.search("remote router ID (\d+\.\d+\.\d+\.\d+).*", bgp_detail)
|
||||
remote_rid = match_rid.group(1)
|
||||
|
||||
match_prefix_accepted = re.search("(\d+) accepted prefixes", bgp_detail)
|
||||
accepted_prefixes = match_prefix_accepted.group(1)
|
||||
|
||||
bgp_neighbor_data["global"]["peers"].setdefault(peer_id, {})
|
||||
peer_dict = {
|
||||
"description": "",
|
||||
"is_enabled" : is_enabled,
|
||||
"local_as" : local_as,
|
||||
"is_up" : is_up,
|
||||
"remote_id" : unicode(remote_rid),
|
||||
"uptime" : self._bgp_time_conversion(up_time),
|
||||
"remote_as" : int(remote_as)
|
||||
}
|
||||
|
||||
af_dict = dict()
|
||||
af_dict[address_family] = {
|
||||
"sent_prefixes" : None,
|
||||
"accepted_prefixes": int(accepted_prefixes),
|
||||
"received_prefixes": received_prefixes
|
||||
}
|
||||
|
||||
peer_dict["address_family"] = af_dict
|
||||
bgp_neighbor_data["global"]["peers"][peer_id] = peer_dict
|
||||
|
||||
return bgp_neighbor_data
|
||||
|
||||
|
||||
def _bgp_time_conversion(self, bgp_uptime):
|
||||
uptime_letters = set(["y", "w", "h", "d"])
|
||||
|
||||
if "never" in bgp_uptime:
|
||||
return -1
|
||||
else:
|
||||
if "y" in bgp_uptime:
|
||||
match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
|
||||
uptime = ((int(match.group(1)) * self._YEAR_SECONDS) +
|
||||
(int(match.group(3)) * self._WEEK_SECONDS) +
|
||||
(int(match.group(5)) * self._DAY_SECONDS))
|
||||
return uptime
|
||||
elif "w" in bgp_uptime:
|
||||
match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
|
||||
uptime = ((int(match.group(1)) * self._WEEK_SECONDS) +
|
||||
(int(match.group(3)) * self._DAY_SECONDS) +
|
||||
(int(match.group(5)) * self._HOUR_SECONDS))
|
||||
return uptime
|
||||
elif "d" in bgp_uptime:
|
||||
match = re.search("(\d+)(\w)(\d+)(\w)(\d+)(\w)", bgp_uptime)
|
||||
uptime = ((int(match.group(1)) * self._DAY_SECONDS) +
|
||||
(int(match.group(3)) * self._HOUR_SECONDS) +
|
||||
(int(match.group(5)) * self._MINUTE_SECONDS))
|
||||
return uptime
|
||||
else:
|
||||
hours, minutes, seconds = map(int, bgp_uptime.split(":"))
|
||||
uptime = ((hours * self._HOUR_SECONDS) +
|
||||
(minutes * self._MINUTE_SECONDS) + seconds)
|
||||
return uptime
|
||||
|
||||
|
||||
def get_interfaces_counters(self):
|
||||
# 'rx_unicast_packet', 'rx_broadcast_packets', 'tx_unicast_packets',
|
||||
# 'tx_multicast_packets' and 'tx_broadcast_packets' are not implemented yet
|
||||
|
||||
"""
|
||||
'show interfaces detail' output example:
|
||||
eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
|
||||
link/ether 00:50:56:86:8c:26 brd ff:ff:ff:ff:ff:ff
|
||||
~~~
|
||||
RX: bytes packets errors dropped overrun mcast
|
||||
35960043 464584 0 221 0 407
|
||||
TX: bytes packets errors dropped carrier collisions
|
||||
32776498 279273 0 0 0 0
|
||||
"""
|
||||
output = self._device.send_command("show interfaces detail")
|
||||
|
||||
interfaces = re.findall("(\S+): <.*", output)
|
||||
count = re.findall("(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+", output)
|
||||
|
||||
counters = dict()
|
||||
|
||||
j = 0
|
||||
|
||||
for i in count:
|
||||
if j % 2 == 0:
|
||||
rx_errors = i[2]
|
||||
rx_discards = i[3]
|
||||
rx_octets = i[0]
|
||||
rx_unicast_packets = i[1]
|
||||
rx_multicast_packets = i[5]
|
||||
rx_broadcast_packets = None
|
||||
else:
|
||||
counters.update({
|
||||
interfaces[j / 2]: {
|
||||
"tx_errors" : i[2],
|
||||
"tx_discards" : i[3],
|
||||
"tx_octets" : i[0],
|
||||
"tx_unicast_packets" : i[1],
|
||||
"tx_multicast_packets": None,
|
||||
"tx_broadcast_packets": None,
|
||||
"rx_errors" : rx_errors,
|
||||
"rx_discards" : rx_discards,
|
||||
"rx_octets" : rx_octets,
|
||||
"rx_unicast_packets" : rx_unicast_packets,
|
||||
"rx_multicast_packets": rx_multicast_packets,
|
||||
"rx_broadcast_packets": rx_broadcast_packets
|
||||
}
|
||||
})
|
||||
j += 1
|
||||
|
||||
return counters
|
||||
|
||||
|
||||
def get_snmp_information(self):
|
||||
# 'acl' is not implemented yet
|
||||
|
||||
output = self._device.send_command("show configuration")
|
||||
# convert the configuration to dictionary
|
||||
config = vyattaconfparser.parse_conf(output)
|
||||
|
||||
snmp = dict()
|
||||
snmp["community"] = dict()
|
||||
|
||||
|
||||
try:
|
||||
for i in config["service"]["snmp"]["community"]:
|
||||
snmp["community"].update({
|
||||
i: {
|
||||
"acl": None,
|
||||
"mode": config["service"]["snmp"]["community"][i]["authorization"]
|
||||
}
|
||||
})
|
||||
|
||||
snmp.update({
|
||||
"contact": config["service"]["snmp"]["contact"],
|
||||
"location": config["service"]["snmp"]["location"]
|
||||
})
|
||||
|
||||
return snmp
|
||||
except KeyError:
|
||||
return {}
|
||||
|
||||
def get_facts(self):
|
||||
output_uptime = self._device.send_command("cat /proc/uptime | awk '{print $1}'")
|
||||
|
||||
|
||||
uptime = int(float(output_uptime))
|
||||
|
||||
|
||||
output = self._device.send_command("show version").split("\n")
|
||||
ver_str = [line for line in output if "Version" in line][0]
|
||||
version = self.parse_version(ver_str)
|
||||
|
||||
sn_str = [line for line in output if "S/N" in line][0]
|
||||
snumber = self.parse_snumber(sn_str)
|
||||
|
||||
hwmodel_str = [line for line in output if "HW model" in line][0]
|
||||
hwmodel = self.parse_hwmodel(hwmodel_str)
|
||||
|
||||
output = self._device.send_command("show configuration")
|
||||
config = vyattaconfparser.parse_conf(output)
|
||||
|
||||
if "host-name" in config["system"]:
|
||||
hostname = config["system"]["host-name"]
|
||||
else:
|
||||
hostname = None
|
||||
|
||||
if "domain-name" in config["system"]:
|
||||
fqdn = config["system"]["domain-name"]
|
||||
else:
|
||||
fqdn = None
|
||||
|
||||
iface_list = list()
|
||||
for iface_type in config["interfaces"]:
|
||||
for iface_name in config["interfaces"][iface_type]:
|
||||
iface_list.append(iface_name)
|
||||
|
||||
facts = {
|
||||
"uptime" : int(uptime),
|
||||
"vendor" : "VyOS",
|
||||
"os_version" : unicode(version),
|
||||
"serial_number" : unicode(snumber),
|
||||
"model" : unicode(hwmodel),
|
||||
"hostname" : unicode(hostname),
|
||||
"fqdn" : unicode(fqdn),
|
||||
"interface_list": iface_list
|
||||
}
|
||||
|
||||
return facts
|
||||
|
||||
|
||||
@staticmethod
|
||||
def parse_version(ver_str):
|
||||
version = ver_str.split()[-1]
|
||||
return version
|
||||
|
||||
|
||||
@staticmethod
|
||||
def parse_snumber(sn_str):
|
||||
sn = sn_str.split(":")
|
||||
return sn[1].strip()
|
||||
|
||||
@staticmethod
|
||||
def parse_hwmodel(model_str):
|
||||
model = model_str.split(":")
|
||||
return model[1].strip()
|
||||
|
||||
|
||||
def get_interfaces_ip(self):
|
||||
output = self._device.send_command("show interfaces")
|
||||
output = output.split("\n")
|
||||
|
||||
# delete the header line and the interfaces which has no ip address
|
||||
ifaces = [x for x in output[3:-1] if "-" not in x]
|
||||
|
||||
ifaces_ip = dict()
|
||||
|
||||
for iface in ifaces:
|
||||
iface = iface.split()
|
||||
|
||||
if len(iface) != 1:
|
||||
|
||||
iface_name = iface[0]
|
||||
|
||||
# Delete the "Interface" column
|
||||
iface = iface[1:-1]
|
||||
# Key initialization
|
||||
ifaces_ip[iface_name] = dict()
|
||||
|
||||
ip_addr, mask = iface[0].split("/")
|
||||
ip_ver = self._get_ip_version(ip_addr)
|
||||
|
||||
# Key initialization
|
||||
if ip_ver not in ifaces_ip[iface_name]:
|
||||
ifaces_ip[iface_name][ip_ver] = dict()
|
||||
|
||||
ifaces_ip[iface_name][ip_ver][ip_addr] = { "prefix_length": mask }
|
||||
|
||||
return ifaces_ip
|
||||
|
||||
|
||||
@staticmethod
|
||||
def _get_ip_version(ip_address):
|
||||
if ":" in ip_address:
|
||||
return "ipv6"
|
||||
elif "." in ip_address:
|
||||
return "ipv4"
|
||||
|
||||
|
||||
def get_users(self):
|
||||
output = self._device.send_command("show configuration commands").split("\n")
|
||||
|
||||
user_conf = [x.split() for x in output if "login user" in x]
|
||||
|
||||
# Collect all users' name
|
||||
user_name = list(set([x[4] for x in user_conf]))
|
||||
|
||||
user_auth = dict()
|
||||
|
||||
for user in user_name:
|
||||
|
||||
sshkeys = list()
|
||||
|
||||
# extract the configuration which relates to 'user'
|
||||
for line in [x for x in user_conf if user in x]:
|
||||
|
||||
# "set system login user alice authentication encrypted-password 'abc'"
|
||||
if line[6] == "encrypted-password":
|
||||
password = line[7].strip("'")
|
||||
|
||||
# set system login user alice level 'admin'
|
||||
elif line[5] == "level":
|
||||
if line[6].strip("'") == "admin":
|
||||
level = 15
|
||||
else:
|
||||
level = 0
|
||||
|
||||
# "set system login user alice authentication public-keys alice@example.com key 'ABC'"
|
||||
elif len(line) == 10 and line[8] == "key":
|
||||
sshkeys.append(line[9].strip("'"))
|
||||
|
||||
user_auth.update({
|
||||
user: {
|
||||
"level": level,
|
||||
"password": password,
|
||||
"sshkeys": sshkeys
|
||||
}
|
||||
})
|
||||
|
||||
return user_auth
|
||||
|
||||
|
||||
def ping(self, destination, source="", ttl=255, timeout=5, size=100, count=5):
|
||||
# does not support multiple destination yet
|
||||
|
||||
command = "ping %s " % destination
|
||||
command += "ttl %d " % ttl
|
||||
command += "deadline %d " % timeout
|
||||
command += "size %d " % size
|
||||
command += "count %d " % count
|
||||
if source != "":
|
||||
command += "interface %s " % source
|
||||
|
||||
ping_result = dict()
|
||||
|
||||
output_ping = self._device.send_command(command)
|
||||
|
||||
if "Unknown host" in output_ping:
|
||||
err ="Unknown host"
|
||||
else:
|
||||
err =""
|
||||
|
||||
if err is not "":
|
||||
ping_result["error"] = err
|
||||
else:
|
||||
# 'packet_info' example:
|
||||
# ['5', 'packets', 'transmitted,' '5', 'received,' '0%', 'packet', 'loss,', 'time', '3997ms']
|
||||
packet_info = output_ping.split("\n")[-2]
|
||||
|
||||
packet_info = [x.strip() for x in packet_info.split()]
|
||||
|
||||
|
||||
sent = int(packet_info[0])
|
||||
received = int(packet_info[3])
|
||||
lost = sent - received
|
||||
|
||||
# 'rtt_info' example:
|
||||
# ["0.307/0.396/0.480/0.061"]
|
||||
rtt_info = output_ping.split("\n")[-1]
|
||||
match = re.search("([\d\.]+)/([\d\.]+)/([\d\.]+)/[\d\.]+", rtt_info)
|
||||
|
||||
if match is not None:
|
||||
rtt_min = float(match.group(1))
|
||||
rtt_avg = float(match.group(2))
|
||||
else:
|
||||
rtt_min = None
|
||||
rtt_avg = None
|
||||
|
||||
ping_result["success"] = dict()
|
||||
ping_result["success"] = {
|
||||
"probes_sent": sent,
|
||||
"packet_loss": lost,
|
||||
"rtt_min" : rtt_min,
|
||||
"rtt_avg" : rtt_avg,
|
||||
"rtt_stdev" : None,
|
||||
"results" : {"ip_address": destination, "rtt": rtt_avg}
|
||||
}
|
||||
|
||||
return ping_result
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
[pylama]
|
||||
linters = mccabe,pep257,pep8,pyflakes
|
||||
ignore = D203,
|
||||
|
||||
[pylama:pep8]
|
||||
max_line_length = 120
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
napalm_base
|
||||
paramiko
|
||||
netmiko
|
||||
vyattaconfparser
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
"""setup.py file."""
|
||||
|
||||
import uuid
|
||||
|
||||
from setuptools import setup, find_packages
|
||||
from pip.req import parse_requirements
|
||||
|
||||
__author__ = 'Shota Muto <dos9954@gmail.com>'
|
||||
|
||||
install_reqs = parse_requirements('requirements.txt', session=uuid.uuid1())
|
||||
reqs = [str(ir.req) for ir in install_reqs]
|
||||
|
||||
setup(
|
||||
name="napalm-vyos",
|
||||
version="0.1.1",
|
||||
packages=find_packages(),
|
||||
author="Shota Muto",
|
||||
author_email="dos9954@gmail.com",
|
||||
description="Network Automation and Programmability Abstraction Layer with Multivendor support",
|
||||
classifiers=[
|
||||
'Topic :: Utilities',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Operating System :: POSIX :: Linux',
|
||||
'Operating System :: MacOS',
|
||||
],
|
||||
include_package_data=True,
|
||||
install_requires=reqs,
|
||||
)
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
# Copyright 2016 Dravetech AB. All rights reserved.
|
||||
#
|
||||
# The contents of this file are licensed under the Apache License, Version 2.0
|
||||
# (the "License"); you may not use this file except in compliance with the
|
||||
# License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations under
|
||||
# the License.
|
||||
|
||||
"""Tests."""
|
||||
|
||||
import unittest
|
||||
|
||||
from napalm_skeleton import skeleton
|
||||
from napalm_base.test.base import TestConfigNetworkDriver, TestGettersNetworkDriver
|
||||
import json
|
||||
|
||||
|
||||
class TestConfigDriver(unittest.TestCase, TestConfigNetworkDriver):
|
||||
"""Group of tests that test Configuration related methods."""
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
"""Run before starting the tests."""
|
||||
hostname = '127.0.0.1'
|
||||
username = 'vagrant'
|
||||
password = 'vagrant'
|
||||
cls.vendor = 'skeleton'
|
||||
|
||||
optional_args = {'port': 12443, }
|
||||
cls.device = skeleton.SkeletonDriver(hostname, username, password, timeout=60,
|
||||
optional_args=optional_args)
|
||||
cls.device.open()
|
||||
|
||||
cls.device.load_replace_candidate(filename='%s/initial.conf' % cls.vendor)
|
||||
cls.device.commit_config()
|
||||
|
||||
|
||||
class TestGetterDriver(unittest.TestCase, TestGettersNetworkDriver):
|
||||
"""Group of tests that test getters."""
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
"""Run before starting the tests."""
|
||||
cls.mock = True
|
||||
|
||||
hostname = '127.0.0.1'
|
||||
username = 'vagrant'
|
||||
password = 'vagrant'
|
||||
cls.vendor = 'skeleton'
|
||||
|
||||
optional_args = {'port': 12443, }
|
||||
cls.device = skeleton.SkeletonDriver(hostname, username, password, timeout=60,
|
||||
optional_args=optional_args)
|
||||
|
||||
if cls.mock:
|
||||
cls.device.device = FakeDevice()
|
||||
else:
|
||||
cls.device.open()
|
||||
|
||||
|
||||
class FakeDevice:
|
||||
"""Test double."""
|
||||
|
||||
@staticmethod
|
||||
def read_json_file(filename):
|
||||
"""Return the content of a file with content formatted as json."""
|
||||
with open(filename) as data_file:
|
||||
return json.load(data_file)
|
||||
|
||||
@staticmethod
|
||||
def read_txt_file(filename):
|
||||
"""Return the content of a file."""
|
||||
with open(filename) as data_file:
|
||||
return data_file.read()
|
||||
|
|
@ -0,0 +1 @@
|
|||
Initial configuration
|
||||
|
|
@ -0,0 +1 @@
|
|||
Some changes that will be merged while testing
|
||||
|
|
@ -0,0 +1 @@
|
|||
The diff when merging `merged_good.conf`
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
Some changes that will be merge while testing. Should contain a typo or something that triggers
|
||||
an error during the load/commmit phase
|
||||
|
|
@ -0,0 +1 @@
|
|||
A full new configuration. It will be used to test the replace operation
|
||||
|
|
@ -0,0 +1 @@
|
|||
A diff between `initial.conf` and `new_good.conf`
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
A full new configuration. However, it should contain a typo or something that triggers an error
|
||||
during commit/load phase.
|
||||
|
|
@ -0,0 +1,502 @@
|
|||
SER GENERAL PUBLIC LICENSE
|
||||
Version 2.1, February 1999
|
||||
|
||||
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
|
||||
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
[This is the first released version of the Lesser GPL. It also counts
|
||||
as the successor of the GNU Library Public License, version 2, hence
|
||||
the version number 2.1.]
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
Licenses are intended to guarantee your freedom to share and change
|
||||
free software--to make sure the software is free for all its users.
|
||||
|
||||
This license, the Lesser General Public License, applies to some
|
||||
specially designated software packages--typically libraries--of the
|
||||
Free Software Foundation and other authors who decide to use it. You
|
||||
can use it too, but we suggest you first think carefully about whether
|
||||
this license or the ordinary General Public License is the better
|
||||
strategy to use in any particular case, based on the explanations below.
|
||||
|
||||
When we speak of free software, we are referring to freedom of use,
|
||||
not price. Our General Public Licenses are designed to make sure that
|
||||
you have the freedom to distribute copies of free software (and charge
|
||||
for this service if you wish); that you receive source code or can get
|
||||
it if you want it; that you can change the software and use pieces of
|
||||
it in new free programs; and that you are informed that you can do
|
||||
these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
distributors to deny you these rights or to ask you to surrender these
|
||||
rights. These restrictions translate to certain responsibilities for
|
||||
you if you distribute copies of the library or if you modify it.
|
||||
|
||||
For example, if you distribute copies of the library, whether gratis
|
||||
or for a fee, you must give the recipients all the rights that we gave
|
||||
you. You must make sure that they, too, receive or can get the source
|
||||
code. If you link other code with the library, you must provide
|
||||
complete object files to the recipients, so that they can relink them
|
||||
with the library after making changes to the library and recompiling
|
||||
it. And you must show them these terms so they know their rights.
|
||||
|
||||
We protect your rights with a two-step method: (1) we copyright the
|
||||
library, and (2) we offer you this license, which gives you legal
|
||||
permission to copy, distribute and/or modify the library.
|
||||
|
||||
To protect each distributor, we want to make it very clear that
|
||||
there is no warranty for the free library. Also, if the library is
|
||||
modified by someone else and passed on, the recipients should know
|
||||
that what they have is not the original version, so that the original
|
||||
author's reputation will not be affected by problems that might be
|
||||
introduced by others.
|
||||
|
||||
Finally, software patents pose a constant threat to the existence of
|
||||
any free program. We wish to make sure that a company cannot
|
||||
effectively restrict the users of a free program by obtaining a
|
||||
restrictive license from a patent holder. Therefore, we insist that
|
||||
any patent license obtained for a version of the library must be
|
||||
consistent with the full freedom of use specified in this license.
|
||||
|
||||
Most GNU software, including some libraries, is covered by the
|
||||
ordinary GNU General Public License. This license, the GNU Lesser
|
||||
General Public License, applies to certain designated libraries, and
|
||||
is quite different from the ordinary General Public License. We use
|
||||
this license for certain libraries in order to permit linking those
|
||||
libraries into non-free programs.
|
||||
|
||||
When a program is linked with a library, whether statically or using
|
||||
a shared library, the combination of the two is legally speaking a
|
||||
combined work, a derivative of the original library. The ordinary
|
||||
General Public License therefore permits such linking only if the
|
||||
entire combination fits its criteria of freedom. The Lesser General
|
||||
Public License permits more lax criteria for linking other code with
|
||||
the library.
|
||||
|
||||
We call this license the "Lesser" General Public License because it
|
||||
does Less to protect the user's freedom than the ordinary General
|
||||
Public License. It also provides other free software developers Less
|
||||
of an advantage over competing non-free programs. These disadvantages
|
||||
are the reason we use the ordinary General Public License for many
|
||||
libraries. However, the Lesser license provides advantages in certain
|
||||
special circumstances.
|
||||
|
||||
For example, on rare occasions, there may be a special need to
|
||||
encourage the widest possible use of a certain library, so that it becomes
|
||||
a de-facto standard. To achieve this, non-free programs must be
|
||||
allowed to use the library. A more frequent case is that a free
|
||||
library does the same job as widely used non-free libraries. In this
|
||||
case, there is little to gain by limiting the free library to free
|
||||
software only, so we use the Lesser General Public License.
|
||||
|
||||
In other cases, permission to use a particular library in non-free
|
||||
programs enables a greater number of people to use a large body of
|
||||
free software. For example, permission to use the GNU C Library in
|
||||
non-free programs enables many more people to use the whole GNU
|
||||
operating system, as well as its variant, the GNU/Linux operating
|
||||
system.
|
||||
|
||||
Although the Lesser General Public License is Less protective of the
|
||||
users' freedom, it does ensure that the user of a program that is
|
||||
linked with the Library has the freedom and the wherewithal to run
|
||||
that program using a modified version of the Library.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow. Pay close attention to the difference between a
|
||||
"work based on the library" and a "work that uses the library". The
|
||||
former contains code derived from the library, whereas the latter must
|
||||
be combined with the library in order to run.
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License Agreement applies to any software library or other
|
||||
program which contains a notice placed by the copyright holder or
|
||||
other authorized party saying it may be distributed under the terms of
|
||||
this Lesser General Public License (also called "this License").
|
||||
Each licensee is addressed as "you".
|
||||
|
||||
A "library" means a collection of software functions and/or data
|
||||
prepared so as to be conveniently linked with application programs
|
||||
(which use some of those functions and data) to form executables.
|
||||
|
||||
The "Library", below, refers to any such software library or work
|
||||
which has been distributed under these terms. A "work based on the
|
||||
Library" means either the Library or any derivative work under
|
||||
copyright law: that is to say, a work containing the Library or a
|
||||
portion of it, either verbatim or with modifications and/or translated
|
||||
straightforwardly into another language. (Hereinafter, translation is
|
||||
included without limitation in the term "modification".)
|
||||
|
||||
"Source code" for a work means the preferred form of the work for
|
||||
making modifications to it. For a library, complete source code means
|
||||
all the source code for all modules it contains, plus any associated
|
||||
interface definition files, plus the scripts used to control compilation
|
||||
and installation of the library.
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running a program using the Library is not restricted, and output from
|
||||
such a program is covered only if its contents constitute a work based
|
||||
on the Library (independent of the use of the Library in a tool for
|
||||
writing it). Whether that is true depends on what the Library does
|
||||
and what the program that uses the Library does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Library's
|
||||
complete source code as you receive it, in any medium, provided that
|
||||
you conspicuously and appropriately publish on each copy an
|
||||
appropriate copyright notice and disclaimer of warranty; keep intact
|
||||
all the notices that refer to this License and to the absence of any
|
||||
warranty; and distribute a copy of this License along with the
|
||||
Library.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy,
|
||||
and you may at your option offer warranty protection in exchange for a
|
||||
fee.
|
||||
|
||||
2. You may modify your copy or copies of the Library or any portion
|
||||
of it, thus forming a work based on the Library, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) The modified work must itself be a software library.
|
||||
|
||||
b) You must cause the files modified to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
c) You must cause the whole of the work to be licensed at no
|
||||
charge to all third parties under the terms of this License.
|
||||
|
||||
d) If a facility in the modified Library refers to a function or a
|
||||
table of data to be supplied by an application program that uses
|
||||
the facility, other than as an argument passed when the facility
|
||||
is invoked, then you must make a good faith effort to ensure that,
|
||||
in the event an application does not supply such function or
|
||||
table, the facility still operates, and performs whatever part of
|
||||
its purpose remains meaningful.
|
||||
|
||||
(For example, a function in a library to compute square roots has
|
||||
a purpose that is entirely well-defined independent of the
|
||||
application. Therefore, Subsection 2d requires that any
|
||||
application-supplied function or table used by this function must
|
||||
be optional: if the application does not supply it, the square
|
||||
root function must still compute square roots.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Library,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Library, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote
|
||||
it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Library.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Library
|
||||
with the Library (or with a work based on the Library) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may opt to apply the terms of the ordinary GNU General Public
|
||||
License instead of this License to a given copy of the Library. To do
|
||||
this, you must alter all the notices that refer to this License, so
|
||||
that they refer to the ordinary GNU General Public License, version 2,
|
||||
instead of to this License. (If a newer version than version 2 of the
|
||||
ordinary GNU General Public License has appeared, then you can specify
|
||||
that version instead if you wish.) Do not make any other change in
|
||||
these notices.
|
||||
|
||||
Once this change is made in a given copy, it is irreversible for
|
||||
that copy, so the ordinary GNU General Public License applies to all
|
||||
subsequent copies and derivative works made from that copy.
|
||||
|
||||
This option is useful when you wish to copy part of the code of
|
||||
the Library into a program that is not a library.
|
||||
|
||||
4. You may copy and distribute the Library (or a portion or
|
||||
derivative of it, under Section 2) in object code or executable form
|
||||
under the terms of Sections 1 and 2 above provided that you accompany
|
||||
it with the complete corresponding machine-readable source code, which
|
||||
must be distributed under the terms of Sections 1 and 2 above on a
|
||||
medium customarily used for software interchange.
|
||||
|
||||
If distribution of object code is made by offering access to copy
|
||||
from a designated place, then offering equivalent access to copy the
|
||||
source code from the same place satisfies the requirement to
|
||||
distribute the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
5. A program that contains no derivative of any portion of the
|
||||
Library, but is designed to work with the Library by being compiled or
|
||||
linked with it, is called a "work that uses the Library". Such a
|
||||
work, in isolation, is not a derivative work of the Library, and
|
||||
therefore falls outside the scope of this License.
|
||||
|
||||
However, linking a "work that uses the Library" with the Library
|
||||
creates an executable that is a derivative of the Library (because it
|
||||
contains portions of the Library), rather than a "work that uses the
|
||||
library". The executable is therefore covered by this License.
|
||||
Section 6 states terms for distribution of such executables.
|
||||
|
||||
When a "work that uses the Library" uses material from a header file
|
||||
that is part of the Library, the object code for the work may be a
|
||||
derivative work of the Library even though the source code is not.
|
||||
Whether this is true is especially significant if the work can be
|
||||
linked without the Library, or if the work is itself a library. The
|
||||
threshold for this to be true is not precisely defined by law.
|
||||
|
||||
If such an object file uses only numerical parameters, data
|
||||
structure layouts and accessors, and small macros and small inline
|
||||
functions (ten lines or less in length), then the use of the object
|
||||
file is unrestricted, regardless of whether it is legally a derivative
|
||||
work. (Executables containing this object code plus portions of the
|
||||
Library will still fall under Section 6.)
|
||||
|
||||
Otherwise, if the work is a derivative of the Library, you may
|
||||
distribute the object code for the work under the terms of Section 6.
|
||||
Any executables containing that work also fall under Section 6,
|
||||
whether or not they are linked directly with the Library itself.
|
||||
|
||||
6. As an exception to the Sections above, you may also combine or
|
||||
link a "work that uses the Library" with the Library to produce a
|
||||
work containing portions of the Library, and distribute that work
|
||||
under terms of your choice, provided that the terms permit
|
||||
modification of the work for the customer's own use and reverse
|
||||
engineering for debugging such modifications.
|
||||
|
||||
You must give prominent notice with each copy of the work that the
|
||||
Library is used in it and that the Library and its use are covered by
|
||||
this License. You must supply a copy of this License. If the work
|
||||
during execution displays copyright notices, you must include the
|
||||
copyright notice for the Library among them, as well as a reference
|
||||
directing the user to the copy of this License. Also, you must do one
|
||||
of these things:
|
||||
|
||||
a) Accompany the work with the complete corresponding
|
||||
machine-readable source code for the Library including whatever
|
||||
changes were used in the work (which must be distributed under
|
||||
Sections 1 and 2 above); and, if the work is an executable linked
|
||||
with the Library, with the complete machine-readable "work that
|
||||
uses the Library", as object code and/or source code, so that the
|
||||
user can modify the Library and then relink to produce a modified
|
||||
executable containing the modified Library. (It is understood
|
||||
that the user who changes the contents of definitions files in the
|
||||
Library will not necessarily be able to recompile the application
|
||||
to use the modified definitions.)
|
||||
|
||||
b) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (1) uses at run time a
|
||||
copy of the library already present on the user's computer system,
|
||||
rather than copying library functions into the executable, and (2)
|
||||
will operate properly with a modified version of the library, if
|
||||
the user installs one, as long as the modified version is
|
||||
interface-compatible with the version that the work was made with.
|
||||
|
||||
c) Accompany the work with a written offer, valid for at
|
||||
least three years, to give the same user the materials
|
||||
specified in Subsection 6a, above, for a charge no more
|
||||
than the cost of performing this distribution.
|
||||
|
||||
d) If distribution of the work is made by offering access to copy
|
||||
from a designated place, offer equivalent access to copy the above
|
||||
specified materials from the same place.
|
||||
|
||||
e) Verify that the user has already received a copy of these
|
||||
materials or that you have already sent this user a copy.
|
||||
|
||||
For an executable, the required form of the "work that uses the
|
||||
Library" must include any data and utility programs needed for
|
||||
reproducing the executable from it. However, as a special exception,
|
||||
the materials to be distributed need not include anything that is
|
||||
normally distributed (in either source or binary form) with the major
|
||||
components (compiler, kernel, and so on) of the operating system on
|
||||
which the executable runs, unless that component itself accompanies
|
||||
the executable.
|
||||
|
||||
It may happen that this requirement contradicts the license
|
||||
restrictions of other proprietary libraries that do not normally
|
||||
accompany the operating system. Such a contradiction means you cannot
|
||||
use both them and the Library together in an executable that you
|
||||
distribute.
|
||||
|
||||
7. You may place library facilities that are a work based on the
|
||||
Library side-by-side in a single library together with other library
|
||||
facilities not covered by this License, and distribute such a combined
|
||||
library, provided that the separate distribution of the work based on
|
||||
the Library and of the other library facilities is otherwise
|
||||
permitted, and provided that you do these two things:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work
|
||||
based on the Library, uncombined with any other library
|
||||
facilities. This must be distributed under the terms of the
|
||||
Sections above.
|
||||
|
||||
b) Give prominent notice with the combined library of the fact
|
||||
that part of it is a work based on the Library, and explaining
|
||||
where to find the accompanying uncombined form of the same work.
|
||||
|
||||
8. You may not copy, modify, sublicense, link with, or distribute
|
||||
the Library except as expressly provided under this License. Any
|
||||
attempt otherwise to copy, modify, sublicense, link with, or
|
||||
distribute the Library is void, and will automatically terminate your
|
||||
rights under this License. However, parties who have received copies,
|
||||
or rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full compliance.
|
||||
|
||||
9. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Library or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Library (or any work based on the
|
||||
Library), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Library or works based on it.
|
||||
|
||||
10. Each time you redistribute the Library (or any work based on the
|
||||
Library), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute, link with or modify the Library
|
||||
subject to these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties with
|
||||
this License.
|
||||
|
||||
11. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Library at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Library by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Library.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under any
|
||||
particular circumstance, the balance of the section is intended to apply,
|
||||
and the section as a whole is intended to apply in other circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
12. If the distribution and/or use of the Library is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Library under this License may add
|
||||
an explicit geographical distribution limitation excluding those countries,
|
||||
so that distribution is permitted only in or among countries not thus
|
||||
excluded. In such case, this License incorporates the limitation as if
|
||||
written in the body of this License.
|
||||
|
||||
13. The Free Software Foundation may publish revised and/or new
|
||||
versions of the Lesser General Public License from time to time.
|
||||
Such new versions will be similar in spirit to the present version,
|
||||
but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Library
|
||||
specifies a version number of this License which applies to it and
|
||||
"any later version", you have the option of following the terms and
|
||||
conditions either of that version or of any later version published by
|
||||
the Free Software Foundation. If the Library does not specify a
|
||||
license version number, you may choose any version ever published by
|
||||
the Free Software Foundation.
|
||||
|
||||
14. If you wish to incorporate parts of the Library into other free
|
||||
programs whose distribution conditions are incompatible with these,
|
||||
write to the author to ask for permission. For software which is
|
||||
copyrighted by the Free Software Foundation, write to the Free
|
||||
Software Foundation; we sometimes make exceptions for this. Our
|
||||
decision will be guided by the two goals of preserving the free status
|
||||
of all derivatives of our free software and of promoting the sharing
|
||||
and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
||||
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
|
||||
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
||||
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
|
||||
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
|
||||
DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Libraries
|
||||
|
||||
If you develop a new library, and you want it to be of the greatest
|
||||
possible use to the public, we recommend making it free software that
|
||||
everyone can redistribute and change. You can do so by permitting
|
||||
redistribution under these terms (or, alternatively, under the terms of the
|
||||
ordinary General Public License).
|
||||
|
||||
To apply these terms, attach the following notices to the library. It is
|
||||
safest to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least the
|
||||
"copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the library's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the library, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the
|
||||
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1990
|
||||
Ty Coon, President of Vice
|
||||
|
||||
That's all there is to it!
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 Alexander Mironov
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
Loading…
Reference in New Issue