├── Scripts ├── README.md ├── Clear_Device_Dependency_Map.py ├── Oxid_Config_Downloader.py ├── PollingGroupSorter.py ├── Oxid-Batfish-Sync.py └── Device_Dependency_Generator.py ├── .env.example ├── README.md ├── LibreNMSAPIClient.py └── LICENSE /Scripts/README.md: -------------------------------------------------------------------------------- 1 | Here's some standalone scripts I've written using this Library. 2 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | LibreNMS_APIToken='someapikeygoeshere' 2 | LibreNMS_URL='http://YourLibreURL' 3 | -------------------------------------------------------------------------------- /Scripts/Clear_Device_Dependency_Map.py: -------------------------------------------------------------------------------- 1 | #This script clears Dependency Map of all Device dependencies. 2 | 3 | from Libs.LibreNMSAPIClient import LibreNMSAPIClient 4 | libreapi=LibreNMSAPIClient() 5 | print("Starting to Clear Dependencies") 6 | for device in libreapi.list_devices(): 7 | libreapi.i_delete_parents_from_host(device['device_id']) 8 | print("Dependency cleared for " +device['sysName']) 9 | 10 | print("Done to Clearing Dependencies") 11 | -------------------------------------------------------------------------------- /Scripts/Oxid_Config_Downloader.py: -------------------------------------------------------------------------------- 1 | #This Script downloads all of your device configs from Oxidized. 2 | 3 | from Libs.LibreNMSAPIClient import LibreNMSAPIClient 4 | import os 5 | libreapi = LibreNMSAPIClient() 6 | 7 | output_dir="configs/" #Output Directory 8 | 9 | 10 | 11 | if not os.path.exists(output_dir): 12 | os.makedirs(output_dir) 13 | 14 | device_hostname_sysname={} 15 | for device in libreapi.list_devices(): 16 | device_hostname_sysname[device['hostname']]=device['sysName'] 17 | 18 | for dev in libreapi.list_oxidized(): 19 | dev_config=libreapi.i_get_oxidized_config(dev['hostname']) #Get Config from Oxidized 20 | if(len(dev_config) != 0 and dev_config != "node not found"): #Verify Valid Config 21 | f=open(output_dir + device_hostname_sysname[dev['hostname']] + ".txt","w") 22 | f.write(dev_config) 23 | f.close() 24 | 25 | print("Done Downloading Configs!") 26 | -------------------------------------------------------------------------------- /Scripts/PollingGroupSorter.py: -------------------------------------------------------------------------------- 1 | #This script goes through all devices in the default poller group, and regroups them based on their dependency map parent. 2 | 3 | from Libs.LibreNMSAPIClient import LibreNMSAPIClient 4 | libreapi=LibreNMSAPIClient() 5 | 6 | devices=libreapi.list_devices() 7 | devices_byid={} 8 | for device in devices: 9 | devices_byid[str(device['device_id'])]=device 10 | 11 | 12 | def find_pollergroup(device): #Finds poller group based on parent 13 | if device['poller_group'] != 0: 14 | return device['poller_group'] 15 | if device['dependency_parent_id']: 16 | for parent_id in device['dependency_parent_id'].split(","): 17 | parent_pollergroup=find_pollergroup(devices_byid[parent_id]) 18 | if parent_pollergroup != 0: 19 | return parent_pollergroup 20 | return 0 21 | 22 | 23 | def update_pollergroup(device): 24 | new_pollergroup=find_pollergroup(device) 25 | if new_pollergroup != 0: 26 | libreapi.update_device_field({'field':'poller_group','data':new_pollergroup},device['device_id']) 27 | print("Group Updated!") 28 | return True 29 | return False 30 | 31 | 32 | for device in devices: 33 | if device['poller_group'] == 0: 34 | print(device['sysName']) 35 | update_pollergroup(device) 36 | print("DONE!") 37 | -------------------------------------------------------------------------------- /Scripts/Oxid-Batfish-Sync.py: -------------------------------------------------------------------------------- 1 | import pandas as pd 2 | from pybatfish.client.session import Session 3 | from pybatfish.datamodel import * 4 | from pybatfish.datamodel.answer import * 5 | from pybatfish.datamodel.flow import * 6 | 7 | from Libs.LibreNMSAPIClient import LibreNMSAPIClient 8 | import re 9 | import tempfile 10 | import os 11 | libreapi=LibreNMSAPIClient() 12 | 13 | 14 | def download_config(tempdir,os,sysdescr_exclude_regex=""): 15 | for device in libreapi.list_devices(): 16 | if device['os'] == os and (sysdescr_exclude_regex == "" or not re.search(sysdescr_exclude_regex,device['sysDescr'])) and not ('attribs' in device and 'override_Oxidized_disable' in device['attribs'] and device['attribs']['override_Oxidized_disable'] == 'true'): 17 | with open(tempdir.name + '/configs/' + device['hostname'] + '.cfg', 'w') as f: 18 | cfg=libreapi.i_get_oxidized_config(device['hostname']) 19 | if type(cfg) == str and cfg != "node not found": 20 | f.write(cfg) 21 | print(device['sysName']) 22 | 23 | #Download configs from Oxid into Temp directory compatible with Batfish 24 | tempdir=tempfile.TemporaryDirectory() 25 | os.mkdir(tempdir.name + "/configs") 26 | download_config(tempdir,'ios') 27 | download_config(tempdir,'iosxe') 28 | download_config(tempdir,'iosxr') 29 | download_config(tempdir,'nxos','aci') 30 | 31 | #Upload configs from Temp directory to Batfish 32 | bf = Session(host="localhost") 33 | bf.set_network("Auto-Import") 34 | bf.init_snapshot(tempdir.name, name="Full", overwrite=True) 35 | 36 | #Test Q/A to Batfish 37 | #answer=bf.q.nodeProperties().answer() 38 | #answer_df = answer.frame() 39 | #answer_df.to_csv('output.csv') 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LibreNMSAPIClient 2 | A Python API client library for (https://www.librenms.org/ "LibreNMS"). 3 | LibreNMS is a fully featured network monitoring system that provides a wealth of features and device support. 4 | 5 | ## Quick start 6 | To begin import the API Client and create an instance of the LibreNMSAPIClient class. You can either hard code Libre's URL (without trailing / ) and API Token in the script, or rely on the .env file. 7 | 8 | Once you have your API Client instance, you can begin calling Libre API functions directly as they appear in the Libre documentation. 9 | 10 | The parameter order is: dataobject (if function requires one), then the route parameters in the order that they're in the route then any additional Query parameters. Checkout the Scripts folder for more examples. 11 | 12 | ``` python 13 | from LibreNMSAPIClient import LibreNMSAPIClient 14 | 15 | # test = LibreNMSAPIClient() # .env example 16 | test = LibreNMSAPIClient("http://YourLibreURL","api_token") # URL and Token hardcode example 17 | 18 | testval=test.get_device("devicehostname") 19 | print(testval) 20 | ``` 21 | 22 | # Advanced 23 | You can input lists in the parameter fields and it will iterate through all possiblities for routes parameters. 24 | 25 | For Query parameters, all list entries will be applied to all. 26 | 27 | 28 | ## Function Flag 29 | You can append function flags to the beginning of functions followed by and underscore to adjust how the API behaves. 30 | 31 | {flags}_{function}({Parameters}) 32 | 33 | Flags: 34 | 35 | i-ignore response errors. Responses are just dropped. 36 | 37 | l-return response in list even if there's only one response/request. 38 | 39 | e-entire response. Returns entire JSON object response. 40 | 41 | r-raw response object that was received from requests. Skips all JSON conversion and most validation. 42 | 43 | c-combines all of the API responses into a single list instead of a separate list for each response. 44 | 45 | o-optional - makes all parameters optional. 46 | 47 | 48 | # Contributing 49 | If you want to contribute please fork this project, push your changes and send a pull request. 50 | 51 | # Todo 52 | -Better error codes 53 | 54 | -Support functions that output images 55 | 56 | -------------------------------------------------------------------------------- /Scripts/Device_Dependency_Generator.py: -------------------------------------------------------------------------------- 1 | #This script builds a Dependency Map in Libre utilizing FDB,xDP, and ARP. 2 | 3 | 4 | from Libs.LibreNMSAPIClient import LibreNMSAPIClient #https://github.com/electrocret/LibreNMSAPIClient 5 | import sys 6 | from datetime import date 7 | 8 | class Dependency_Map: 9 | """ Dependency_Map Class creates an object for building Libre Dependency Maps""" 10 | def child_count(self): 11 | """returns dict of Counts of the direct children of each device. {'device_id':count} """ 12 | children_count={} 13 | for did,Dependency_Obj in self.Device_Dependency_Map.items(): 14 | for parent in Dependency_Obj.Parents: 15 | children_count[parent]=1 if parent not in children_count else children_count[parent] + 1 16 | return children_count 17 | 18 | def remove_loops(self): 19 | """Searches through Dependency Map looking for loops. Currently only looks at direct parent/child relationships and doesn't look at grandchildren etc""" 20 | print("Searching for Dependency Loops") 21 | children_count=self.child_count() 22 | for child,Dependency_Obj in self.Device_Dependency_Map.items(): 23 | for parent in Dependency_Obj.Parents: 24 | if(parent in self.Device_Dependency_Map and child in self.Device_Dependency_Map[parent].Parents): #Find Loop source 25 | print("Loop found between " + child + " and " + parent + " (Child Tiebreaker:" + str(children_count[child]) + ">" + str(children_count[parent]) + ")") 26 | self.loops_prevented=self.loops_prevented + 1 27 | if children_count[child] > children_count[parent]: #Determine who's the parent based on child count, then remove child. 28 | self.Device_Dependency_Map[parent].Parents.remove(child) 29 | else: 30 | Dependency_Obj.Parents.remove(parent) 31 | print("Finished searching for Dependency Loops") 32 | 33 | def try_ARP(self,exclude_monitoring_ports=True,max_allowed_parents=2,overwrite=False): 34 | """ 35 | Finds Dependencies based on ARP. 36 | 37 | Parameters: 38 | exclude_monitoring_ports - Boolean - Whether to exclude ports that Libre is monitoring against for parental consideration. 39 | max_allowed_parents - int - Maximum number of parents allowed. If exceeded then no valid parent is considered found. (2 is generaly a good number. For HSRP/VRRP Gateways) 40 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 41 | 42 | """ 43 | Monitored_IPs=[] 44 | for device in self.libreapi.list_devices(): 45 | Monitored_IPs.append(device['hostname'] if device['ip'] == "" else device['ip']) 46 | print("Building Dependency Map based on ARP") 47 | for Device in self.libreapi.list_devices(): 48 | if not self.gen_dependency(Device,overwrite): 49 | continue 50 | parents=[] 51 | for arp_ent in self.libreapi.list_arp(Device['hostname'] if Device['ip'] == "" else Device['ip']): 52 | monitoring_port=False 53 | if exclude_monitoring_ports: 54 | for port_ip in self.libreapi.i_get_port_ip_info(arp_ent['port_id']): 55 | if 'ipv4_address' in port_ip and port_ip['ipv4_address'] in Monitored_IPs: 56 | monitoring_port=True 57 | break 58 | if not monitoring_port: 59 | port_info=self.libreapi.get_port_info(arp_ent['port_id']) 60 | port_did=str(port_info['device_id']) 61 | if port_info['device_id'] != Device['device_id'] and port_did not in parents: 62 | parents.append(port_did) 63 | self.build_dependency(Device,parents,"ARP",max_allowed_parents,overwrite) 64 | print("Finished building Dependency Map based on ARP") 65 | 66 | def try_Network_Neighbors(self,max_allowed_parents=1,overwrite=False): 67 | """ 68 | Makes educated guess as to what the parent of a device is based on what's most common parent among other hosts in the network. 69 | 70 | Parameters: 71 | max_allowed_parents - int - Maximum number of parents function will set 72 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 73 | """ 74 | print("Building Dependency Map based on Network Neighbors") 75 | for Device in self.libreapi.list_devices(): 76 | if not self.gen_dependency(Device,overwrite): 77 | continue 78 | polling_network_id = 0 79 | for address in self.libreapi.i_get_device_ip_addresses(Device['device_id']): 80 | if('ipv4_address' in address): 81 | if(Device['hostname'] == address['ipv4_address'] or Device['ip'] == address['ipv4_address']): 82 | polling_network_id = address['ipv4_network_id'] 83 | break 84 | if(polling_network_id != 0): # Check if Polling network was found 85 | parents=[] 86 | for address in self.libreapi.get_network_ip_addresses(polling_network_id): 87 | did=str(self.libreapi.get_port_info(address['port_id'])['device_id']) 88 | if did in self.Device_Dependency_Map and self.Device_Dependency_Map[did].Source != "Network_Neighbors": 89 | parents=parents + self.Device_Dependency_Map[did].Parents 90 | if len(parents) > 0: 91 | if str(Device['device_id']) in parents: 92 | while str(Device['device_id']) in parents: 93 | parents.remove(str(Device['device_id'])) 94 | dedup_parents=list(dict.fromkeys(parents)) 95 | while len(parents) > max_allowed_parents: 96 | for parent in dedup_parents: 97 | if parent in parents and len(parents) > max_allowed_parents: 98 | parents.remove(parent) 99 | self.build_dependency(Device,parents,"Network_Neighbors",max_allowed_parents,overwrite) 100 | print("Finished building Dependency Map based on Network Neighbors") 101 | 102 | def try_xDP(self,max_allowed_parents=1,overwrite=False): 103 | """ 104 | Finds Dependencies based on xDP (CDP/LLDP). 105 | 106 | Parameters: 107 | max_allowed_parents - int - Maximum number of parents allowed. If exceeded then no valid parent is considered found. 108 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 109 | 110 | Note: From my experience, this method isn't very reliable since the Libre's Discovery module needs some TLC. 111 | 112 | """ 113 | print("Building Dependency Map based on xDP") 114 | for Device in self.libreapi.list_devices(): 115 | if not self.gen_dependency(Device,overwrite): 116 | continue 117 | polling_port_id = 0 118 | for address in self.libreapi.i_get_device_ip_addresses(Device['device_id']): 119 | if('ipv4_address' in address): 120 | if(Device['hostname'] == address['ipv4_address'] or Device['ip'] == address['ipv4_address']): 121 | polling_port_id = address['port_id'] 122 | break 123 | if(polling_port_id != 0): # Check if Polling port was found 124 | parents=[] 125 | for link in self.libreapi.i_get_links(Device['device_id']): #Find xDP neighbors of polling port 126 | if(link['local_port_id'] == polling_port_id and link['remote_device_id'] not in parents and link['remote_device_id'] != 0): 127 | parents.append(link['remote_device_id']) 128 | self.build_dependency(Device,parents,"xDP",max_allowed_parents,overwrite) 129 | print("Finished building Dependency Map based on xDP") 130 | 131 | def try_FDB(self,allowed_mac_count=1,max_allowed_parents=2,overwrite=False): 132 | """ 133 | Finds Dependencies based on FDB. 134 | 135 | Parameters: 136 | allowed_mac_count - int - Number of MACs that can be discovered on a port for it to be considered a source port. (Libre's algorithm uses 1, however some devices have multiple MACs) 137 | max_allowed_parents - int - Maximum number of parents allowed. If exceeded then no valid parent is considered found. 138 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 139 | 140 | """ 141 | print("Downloading FDB") 142 | FDB=self.libreapi.oi_list_fdb() 143 | if len(FDB) == 0 : 144 | print("Downloading Full FDB Failed. Trying to get it by Device.") 145 | for device in self.libreapi.list_devices(): 146 | FDB = FDB + self.libreapi.get_device_fdb(device['device_id']) 147 | PhysAddresses=[] 148 | for phys in self.libreapi.get_all_ports('columns','ifPhysAddress'): 149 | PhysAddresses.append(phys['ifPhysAddress']) 150 | FDB_count_map={} 151 | for entry in FDB: 152 | counter_id=str(entry['port_id']) 153 | if counter_id in FDB_count_map: 154 | FDB_count_map[counter_id]['count']=FDB_count_map[counter_id]['count'] + 1 155 | else: 156 | FDB_count_map[counter_id]={'device_id':entry['device_id'],'count':1} 157 | print("Building Dependency Map based on FDB") 158 | for Device in self.libreapi.list_devices(): 159 | if not self.gen_dependency(Device,overwrite): 160 | continue 161 | Arp_Entries=self.libreapi.i_list_arp(Device['hostname'] if Device['ip'] == "" else Device['ip']) 162 | if len(Arp_Entries) > 0 and PhysAddresses.count(Arp_Entries[0]['mac_address']) == 1: 163 | parents=[] 164 | for entry in FDB: #Try FDB - Look up source port of Mac Address (Devices with ports where only this Mac is being learned.) 165 | if entry['mac_address'] == Arp_Entries[0]['mac_address']: 166 | PID=str(entry['port_id']) 167 | if FDB_count_map[PID]['count']<= allowed_mac_count and str(FDB_count_map[PID]['device_id']) not in parents and FDB_count_map[PID]['device_id'] != Device['device_id'] : 168 | parents.append(str(FDB_count_map[PID]['device_id'])) 169 | self.build_dependency(Device,parents,"FDB",max_allowed_parents,overwrite) 170 | print("Finished building Dependency Map based on FDB") 171 | 172 | def set_dependency(self,Children,parents,overwrite=False): 173 | """ 174 | Staticly sets dependency 175 | 176 | Parameters: 177 | Children - List - List of Device IDs to set Parent for 178 | Parents - List - List of Parent Device IDs 179 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 180 | 181 | """ 182 | for Device in self.libreapi.list_devices(): 183 | if str(Device['device_id']) in Children: 184 | self.build_dependency(Device,parents,"static",len(parents),overwrite,len(parents)) 185 | 186 | def gen_dependency(self,Device,overwrite=False): 187 | """ 188 | Tells try functions whether they should try to generate a dependency. 189 | Based on whether a dependency already exists for the Device in the Device_Dependency_Map 190 | 191 | Parameters: 192 | Device - Dict - Device Dictionary from Libre 193 | overwrite - boolean - Overwrite variable given to "try_" functions 194 | """ 195 | return overwrite or str(Device['device_id']) not in self.Device_Dependency_Map or ( str(Device['device_id']) in self.Device_Dependency_Map and len(self.Device_Dependency_Map[str(Device['device_id'])].Parents) == 0) 196 | 197 | 198 | def build_dependency(self, Device, parents, Source,max_allowed_parents,overwrite=False,min_parents=1): 199 | """ 200 | Builds dependency Dependency_Obj. 201 | 202 | Parameters: 203 | Device - Dict - Device Dictionary from Libre 204 | Source - Str - Name for source function. (used internally for stats & diagnostics) 205 | max_allowed_parents - int - Maximum number of parents allowed. If exceeded then no valid parent is considered found. 206 | overwrite - boolean - Whether to overwrite existing Dependency Map mappings that may have been found by previous functions. 207 | min_parents - int - Minimum number of parents allowed. 208 | """ 209 | if len(parents) <= max_allowed_parents and len(parents) >= min_parents and self.gen_dependency(Device,overwrite) : 210 | print(Dependency_Obj(self,Device,parents,Source)) 211 | 212 | def stats_dependent_source(self,dSource): 213 | """ 214 | Returns an int count of how many dependencies were found from this source. 215 | Parameters: 216 | dSource - Str - String each source identifies by ie. ARP,FDB,xDP 217 | """ 218 | count=0 219 | for did,Dependency_Obj in self.Device_Dependency_Map.items(): 220 | if Dependency_Obj.Source == dSource: 221 | count=count + 1 222 | return count 223 | 224 | def stats_dependents(self): 225 | """ 226 | Returns an int count of how many dependencies are in the map. 227 | """ 228 | return len(self.Device_Dependency_Map) 229 | 230 | def stats_independents(self): 231 | """ 232 | Returns an int count of how many dependencies aren't in the map. 233 | """ 234 | return len(self.libreapi.list_devices()) - len(self.Device_Dependency_Map) 235 | 236 | def stats_loops_prevented(self): 237 | """ 238 | Returns an int count of how many loops were found & prevented using the remove_loops function. 239 | """ 240 | return self.loops_prevented 241 | 242 | def update_libre(self,force=False): 243 | """ 244 | Updates Libre's dependency map with Dependency_Map Object's Map. 245 | Parameters: 246 | force - boolean - Forces update to Libre even if the Dependency_Obj has no parents. (When false - if Dependency_Obj has no Parent in it then it will be skipped) 247 | """ 248 | print("Updating Libre Dependency Map") 249 | for did,Dependency_Obj in self.Device_Dependency_Map.items(): 250 | Dependency_Obj.update_libre(force) 251 | print("Finished updating Libre Dependency Map") 252 | 253 | def __init__(self,libreapi): 254 | self.Device_Dependency_Map={} # {:Dependency_Obj}} 255 | self.libreapi=libreapi 256 | self.loops_prevented=0 257 | 258 | 259 | class Dependency_Obj: 260 | """ Device Dependency info container. """ 261 | def grandparents(self,depth=0): 262 | """ 263 | Returns a list of this Dependency_Obj's Parent device IDs 264 | Parameters: 265 | depth - int - How many generations to go back 266 | """ 267 | grandparents=[] 268 | for parent in self.Parents: 269 | if parent in self.DMap.Device_Dependency_Map: 270 | grandparents = grandparents + self.DMap.Device_Dependency_Map[parent].Parents 271 | if depth > 0: 272 | grandparents = grandparents + self.DMap.Device_Dependency_Map[parent].grandparents(depth - 1) 273 | return list(dict.fromkeys(grandparents)) 274 | 275 | def update_libre(self,force=False): 276 | """ 277 | Updates Libre's dependency map with this Dependency_Obj. 278 | Parameters: 279 | force - boolean - Forces update to Libre even if the Dependency_Obj has no parents. (When false - if Dependency_Obj has no Parent in it then it will be skipped) 280 | """ 281 | if len(self.Parents) > 0 or force: 282 | self.DMap.libreapi.i_delete_parents_from_host(self.Device_ID) #Clear existing parent 283 | if len(self.Parents) > 0: 284 | self.DMap.libreapi.i_add_parents_to_host({'parent_ids':",".join(self.Parents)},self.Device_ID) #Set new parents 285 | 286 | def __init__(self,DMap,Device,Parent_List,Source=""): 287 | self.Device_ID=str(Device['device_id']) 288 | DMap.Device_Dependency_Map[self.Device_ID]=self 289 | self.DMap=DMap 290 | self.Source=Source 291 | self.Parents=[] 292 | for Parent in Parent_List: 293 | self.Parents.append(str(Parent)) 294 | def __str__(self): 295 | return "Device:" + self.Device_ID + " Parents:" + str(self.Parents) + " Source:" +self.Source 296 | 297 | 298 | 299 | 300 | ### Script Start ### 301 | 302 | original_stdout = sys.stdout 303 | print("Starting!") 304 | with open('Dependency_Generator.txt', 'w') as f: 305 | sys.stdout = f 306 | print("Executed: " + str(date.today())) 307 | dep_map=Dependency_Map(LibreNMSAPIClient()) 308 | dep_map.try_FDB() #Try to find endpoint switchport of Device. (Uses similar algorithm to Libre's FDB) 309 | dep_map.try_FDB(2) #Try to find endpoint switchport of Device. (Uses similar algorithm to Libre's FDB except with the allowance of 2 MAC's sourced from port. For compatibility with some devices.) 310 | dep_map.remove_loops() 311 | dep_map.try_ARP() #Try to find Device's GW using ARP. 312 | dep_map.remove_loops() 313 | dep_map.try_xDP() #Try to find endpoint switchport using xDP. (xDP info is unreliable and buggy) 314 | dep_map.remove_loops() 315 | dep_map.try_Network_Neighbors() #Make Educated guess based on peers in Device's network. 316 | dep_map.remove_loops() 317 | print("##Dependency Generator Stats##") 318 | print("Dependent Devices:" + str(dep_map.stats_dependents())) 319 | print("Independent Devices:" + str(dep_map.stats_independents())) 320 | print("FDB Dependents:" + str(dep_map.stats_dependent_source('FDB'))) 321 | print("ARP Dependents:" + str(dep_map.stats_dependent_source('ARP'))) 322 | print("xDP Dependents:" + str(dep_map.stats_dependent_source('xDP'))) 323 | print("Network Neightbor Dependents:" + str(dep_map.stats_dependent_source('Network_Neighbors'))) 324 | print("Loops prevented:" + str(dep_map.stats_loops_prevented())) 325 | dep_map.update_libre() #Update Dependency Map in Libre 326 | sys.stdout = original_stdout 327 | print("Dependency Done!") 328 | -------------------------------------------------------------------------------- /LibreNMSAPIClient.py: -------------------------------------------------------------------------------- 1 | #!/bin/python 2 | import requests 3 | import json 4 | import os 5 | import re 6 | import urllib3 7 | urllib3.disable_warnings() 8 | 9 | 10 | ## 11 | ##Function Flags: 12 | ## i-ignore response error. Drops response from return. 13 | ## l-return responses in list even if there's only one response/request. (For iterated Parameters) 14 | ## e-entire response. Returns entire JSON object response 15 | ## r-raw response object that was received from requests. Skips all JSON conversion and most validation. 16 | ## c-combines all of the API responses into a single list instead of a separate list for each response. 17 | ## o-optional - makes all parameters optional. 18 | ## s-single response object. For functions that return a single object as their response. 19 | ## f-force JSON response through - skips JSON checks 20 | ## 21 | 22 | class LibreNMSAPIClientException(Exception): 23 | def __init__(self, message): 24 | super(LibreNMSAPIClientException, self).__init__(message) 25 | 26 | 27 | class LibreNMSAPIClient: 28 | cache = {} 29 | functions = { 30 | # 'example_function' : { 31 | # 'route': '/route/:to/function/:param', 32 | # 'request_method': 'GET', 33 | # 'response_key':'key', -specify's the response key API call returns otherwise gets 'message' value or 'status' value 34 | # 'flags':'', -Any required function flags. 35 | # }, 36 | 'list_functions' : { 37 | 'route': '/api/v0/', 38 | 'request_method': 'GET', 39 | 'flags': 'e', 40 | 'cache':True 41 | }, 42 | 'get_alert' : { 43 | 'route': '/api/v0/alerts/:id', 44 | 'request_method': 'GET', 45 | 'response_key':'alerts', 46 | 'cache':True, 47 | 'flags':'s', 48 | }, 49 | 'ack_alert' : { 50 | 'route': '/api/v0/alerts/:id', 51 | 'request_method': 'PUT', 52 | }, 53 | 'unmute_alert' : { 54 | 'route': '/api/v0/alerts/unmute/:id', 55 | 'request_method': 'PUT', 56 | }, 57 | 'list_alerts' : { 58 | 'route': '/api/v0/alerts', 59 | 'request_method': 'GET', 60 | 'response_key':'alerts', 61 | 'cache':True 62 | }, 63 | 'get_alert_rule' : { 64 | 'route': '/api/v0/rules/:id', 65 | 'request_method': 'GET', 66 | 'response_key':'rules', 67 | 'cache':True, 68 | 'flags':'s', 69 | }, 70 | 'delete_rule' : { 71 | 'route': '/api/v0/rules/:id', 72 | 'request_method': 'DELETE', 73 | }, 74 | 'list_alert_rules' : { 75 | 'route': '/api/v0/rules', 76 | 'request_method': 'GET', 77 | 'response_key':'rules', 78 | 'cache':True, 79 | }, 80 | 'add_rule' : { 81 | 'route': '/api/v0/rules', 82 | 'request_method': 'POST', 83 | 'response_key':'alerts', 84 | }, 85 | 'edit_rule' : { 86 | 'route': '/api/v0/rules', 87 | 'request_method': 'PUT', 88 | }, 89 | 'list_arp' : { 90 | 'route': '/api/v0/resources/ip/arp/:query', 91 | 'request_method': 'GET', 92 | 'response_key':'arp', 93 | 'cache':True 94 | }, 95 | 'list_bills' : { 96 | 'route': '/api/v0/bills', 97 | 'request_method': 'GET', 98 | 'response_key':'bills', 99 | }, 100 | 'get_bill' : { 101 | 'route': '/api/v0/bills/:id', 102 | 'request_method': 'GET', 103 | 'response_key':'bills', 104 | 'flags':'o', 105 | }, 106 | 'get_bill_graph' : { #Need to look into compatibility. docs say response is graph image 107 | 'route': '/api/v0/bills/:id/graphs/:graph_type', 108 | 'request_method': 'GET', 109 | }, 110 | 'get_bill_graphdata' : { #Need to look into compatibility. docs don't show graph_data as a list which isn't normal. 111 | 'route': '/api/v0/bills/:id/graphdata/:graph_type', 112 | 'request_method': 'GET', 113 | 'response_key':'graph_data', 114 | }, 115 | 'get_bill_history' : { 116 | 'route': '/api/v0/bills/:id/history', 117 | 'request_method': 'GET', 118 | 'response_key':'bill_history', 119 | 'cache':True 120 | }, 121 | 'get_bill_history_graph' : { #Need to look into compatibility. docs say response is graph image 122 | 'route': '/api/v0/bills/:id/history/:bill_hist_id/graphs/:graph_type', 123 | 'request_method': 'GET', 124 | }, 125 | 'get_bill_history_graphdata' : { #Need to check compatibility. docs don't specify response. (Guessed based off of get_bill_graphdata) 126 | 'route': '/api/v0/bills/:id/history/:bill_hist_id/graphdata/:graph_type', 127 | 'request_method': 'GET', 128 | 'response_key':'graph_data', 129 | }, 130 | 'get_poller_group' : { 131 | 'route': '/api/v0/poller_group/:poller_group', 132 | 'request_method': 'GET', 133 | 'response_key':'get_poller_group', 134 | 'flags':'o', 135 | }, 136 | 'delete_bill' : { 137 | 'route': '/api/v0/bills/:id', 138 | 'request_method': 'DELETE', 139 | }, 140 | 'create_edit_bill' : { 141 | 'route': '/api/v0/bills', 142 | 'request_method': 'POST', 143 | 'response_key':'bill_id', 144 | }, 145 | 'get_devicegroups' : { 146 | 'route': '/api/v0/devicegroups', 147 | 'request_method': 'GET', 148 | 'response_key':'groups', 149 | 'cache':True 150 | }, 151 | 'add_devicegroup' : { 152 | 'route': '/api/v0/devicegroups', 153 | 'request_method': 'POST', 154 | 'response_key':'id', 155 | }, 156 | 'get_devices_by_group' : { 157 | 'route': '/api/v0/devicegroups/:name', 158 | 'request_method': 'GET', 159 | 'response_key':'devices', 160 | 'cache':True 161 | }, 162 | 'maintenance_devicegroup' : { 163 | 'route': '/api/v0/devicesgroups/:name/maintenance', 164 | 'request_method': 'POST', 165 | }, 166 | 'del_device' : { 167 | 'route': '/api/v0/devices/:hostname', 168 | 'request_method': 'DELETE', 169 | 'response_key':'devices', 170 | 'flags':'s', 171 | }, 172 | 'get_device' : { 173 | 'route': '/api/v0/devices/:hostname', 174 | 'request_method': 'GET', 175 | 'response_key':'devices', 176 | 'flags':'s', 177 | 'cache':True 178 | }, 179 | 'discover_device' : { 180 | 'route': '/api/v0/devices/:hostname/discover', 181 | 'request_method': 'GET', 182 | 183 | }, 184 | 'availability' : { 185 | 'route': '/api/v0/devices/:hostname/availability', 186 | 'request_method': 'GET', 187 | 'response_key':'availability', 188 | 'cache':True 189 | }, 190 | 'outages' : { 191 | 'route': '/api/v0/devices/:hostname/outages', 192 | 'request_method': 'GET', 193 | 'response_key':'outages', 194 | 'cache':True 195 | }, 196 | 'get_graphs' : { 197 | 'route': '/api/v0/devices/:hostname/graphs', 198 | 'request_method': 'GET', 199 | 'response_key':'graphs', 200 | }, 201 | 'list_available_health_graphs' : { 202 | 'route': '/api/v0/devices/:hostname/health/:type/:sensor_id', 203 | 'request_method': 'GET', 204 | 'response_key':'graphs', 205 | 'flags':'o', 206 | 'cache':True 207 | }, 208 | 'list_available_wireless_graphs' : { 209 | 'route': '/api/v0/devices/:hostname/wireless/:type/:sensor_id', 210 | 'request_method': 'GET', 211 | 'response_key':'graphs', 212 | 'flags':'o', 213 | 'cache':True 214 | }, 215 | 'get_health_graph' : { #Doesn't support. output is graph image 216 | 'route': '/api/v0/devices/:hostname/graphs/health/:type/:sensor_id', 217 | 'request_method': 'GET', 218 | 'flags':'o' 219 | }, 220 | 'get_wireless_graph' : { #Doesn't support. output is graph image 221 | 'route': '/api/v0/devices/:hostname/graphs/wireless/:type/:sensor_id', 222 | 'request_method': 'GET', 223 | 'flags':'o' 224 | }, 225 | 'get_graph_generic_by_hostname' : { #Need to look into compatibility. docs say response is graph image 226 | 'route': '/api/v0/devices/:hostname/:type', 227 | 'request_method': 'GET', 228 | }, 229 | 'get_port_graphs' : { 230 | 'route': '/api/v0/devices/:hostname/ports', 231 | 'request_method': 'GET', 232 | 'response_key':'ports', 233 | }, 234 | 'get_device_fdb' : { 235 | 'route': '/api/v0/devices/:hostname/fdb', 236 | 'request_method': 'GET', 237 | 'response_key':'ports_fdb', 238 | 'cache':True 239 | }, 240 | 'get_device_ip_addresses' : { 241 | 'route': '/api/v0/devices/:hostname/ip', 242 | 'request_method': 'GET', 243 | 'response_key':'addresses', 244 | 'cache':True 245 | }, 246 | 'get_port_stack' : { 247 | 'route': '/api/v0/devices/:hostname/port_stack', 248 | 'request_method': 'GET', 249 | 'response_key':'mappings', 250 | 'cache':True 251 | }, 252 | 'get_components' : { 253 | 'route': '/api/v0/devices/:hostname/components', 254 | 'request_method': 'GET', 255 | 'response_key':'components', 256 | 'cache':True 257 | }, 258 | 'add_components' : { 259 | 'route': '/api/v0/devices/:hostname/components/:type', 260 | 'request_method': 'POST', 261 | 'response_key':'components', 262 | }, 263 | 'edit_components' : { 264 | 'route': '/api/v0/devices/:hostname/components', 265 | 'request_method': 'PUT', 266 | }, 267 | 'delete_components' : { 268 | 'route': '/api/v0/devices/:hostname/components/:component', 269 | 'request_method': 'DELETE', 270 | }, 271 | 'get_port_stats_by_port_hostname' : { 272 | 'route': '/api/v0/devices/:hostname/ports/:ifname', 273 | 'request_method': 'GET', 274 | 'response_key':'port', 275 | 'cache':True 276 | }, 277 | 'get_graph_by_port_hostname' : { #Need to look into compatibility. docs say response is graph image 278 | 'route': '/api/v0/devices/:hostname/ports/:ifname/:type', 279 | 'request_method': 'GET', 280 | }, 281 | 'list_locations' : { 282 | 'route': '/api/v0/resources/locations', 283 | 'request_method': 'GET', 284 | 'response_key':'locations', 285 | 'cache':True 286 | }, 287 | 'list_sensors' : { 288 | 'route': '/api/v0/resources/sensors', 289 | 'request_method': 'GET', 290 | 'response_key':'sensors', 291 | 'cache':True 292 | }, 293 | 'list_devices' : { 294 | 'route': '/api/v0/devices', 295 | 'request_method': 'GET', 296 | 'response_key':'devices', 297 | 'cache':True 298 | }, 299 | 'maintenance_device' : { 300 | 'route': '/api/v0/devices/:hostname/maintenance', 301 | 'request_method': 'POST', 302 | }, 303 | 'add_device' : { 304 | 'route': '/api/v0/devices', 305 | 'request_method': 'POST', 306 | 'response_key':'devices', 307 | }, 308 | 'list_oxidized' : { 309 | 'route': '/api/v0/oxidized/:hostname', 310 | 'request_method': 'GET', 311 | 'flags':'feo', 312 | 'cache':True 313 | }, 314 | 'update_device_field' : { 315 | 'route': '/api/v0/devices/:hostname', 316 | 'request_method': 'PATCH', 317 | }, 318 | 'update_device_port_notes' : { 319 | 'route': '/api/v0/devices/:hostname/port/:portid', 320 | 'request_method': 'PATCH', 321 | }, 322 | 'rename_device' : { 323 | 'route': '/api/v0/devices/:hostname/rename/:new_hostname', 324 | 'request_method': 'PATCH', 325 | }, 326 | 'get_device_groups' : { 327 | 'route': '/api/v0/devices/:hostname/groups', 328 | 'request_method': 'GET', 329 | 'response_key':'groups', 330 | 'cache':True 331 | }, 332 | 'search_oxidized' : { 333 | 'route': 'api/v0/oxidized/config/search/:searchstring', 334 | 'request_method': 'GET', 335 | 'response_key':'nodes', 336 | 'cache':True 337 | }, 338 | 'get_oxidized_config' : { 339 | 'route': '/api/v0/oxidized/config/:device_name', 340 | 'request_method': 'GET', 341 | 'response_key':'config', 342 | 'flags':'f', 343 | 'cache':True 344 | }, 345 | 'add_parents_to_host' : { 346 | 'route': '/api/v0/devices/:device/parents', 347 | 'request_method': 'POST', 348 | }, 349 | 'delete_parents_from_host' : { 350 | 'route': '/api/v0/devices/:device/parents', 351 | 'request_method': 'DELETE', 352 | }, 353 | 'get_inventory' : { 354 | 'route': '/api/v0/inventory/:hostname', 355 | 'request_method': 'GET', 356 | 'response_key':'inventory', 357 | 'cache':True 358 | }, 359 | 'get_inventory_for_device' : { 360 | 'route': '/api/v0/inventory/:hostname/all', 361 | 'request_method': 'GET', 362 | 'response_key':'inventory', 363 | 'cache':True 364 | }, 365 | 'add_location' : { 366 | 'route': '/api/v0/locations/', 367 | 'request_method': 'POST', 368 | }, 369 | 'edit_location' : { 370 | 'route': '/api/v0/locations/location', 371 | 'request_method': 'PATCH', 372 | }, 373 | 'list_eventlog' : { 374 | 'route': '/api/v0/logs/eventlog/:hostname', 375 | 'request_method': 'GET', 376 | 'response_key':'logs', 377 | 'cache':True 378 | }, 379 | 'list_syslog' : { 380 | 'route': '/api/v0/logs/syslog/:hostname', 381 | 'request_method': 'GET', 382 | 'response_key':'logs', 383 | 'cache':True 384 | }, 385 | 'list_alertlog' : { 386 | 'route': '/api/v0/logs/alertlog/:hostname', 387 | 'request_method': 'GET', 388 | 'response_key':'logs', 389 | 'cache':True 390 | }, 391 | 'list_authlog' : { 392 | 'route': '/api/v0/logs/authlog/:hostname', 393 | 'request_method': 'GET', 394 | 'response_key':'logs', 395 | 'cache':True 396 | }, 397 | 'get_port_groups' : { 398 | 'route': '/api/v0/port_groups', 399 | 'request_method': 'GET', 400 | 'response_key':'groups', 401 | 'cache':True 402 | }, 403 | 'get_ports_by_group' : { 404 | 'route': '/api/v0/port_groups/:name', 405 | 'request_method': 'GET', 406 | 'response_key':'ports', 407 | 'cache':True 408 | }, 409 | 'add_port_group' : { 410 | 'route': '/api/v0/port_groups', 411 | 'request_method': 'POST', 412 | 'response_key':'id', 413 | }, 414 | 'assign_port_group' : { 415 | 'route': '/api/v0/port_groups/:port_group_id/assign', 416 | 'request_method': 'POST', 417 | }, 418 | 'remove_port_group' : { 419 | 'route': '/api/v0/port_groups/:port_group_id/remove', 420 | 'request_method': 'POST', 421 | }, 422 | 'get_graph_by_portgroup' : { #Need to look into compatibility. docs say response is graph image 423 | 'route': '/api/v0/portgroups/:group', 424 | 'request_method': 'GET', 425 | }, 426 | 'get_graph_by_portgroup_multiport_bits' : { #Need to look into compatibility. docs say response is graph image 427 | 'route': '/api/v0/portgroups/multiport/bits/:id', 428 | 'request_method': 'GET', 429 | }, 430 | 'get_all_ports' : { 431 | 'route': '/api/v0/ports', 432 | 'request_method': 'GET', 433 | 'response_key':'ports', 434 | 'cache':True 435 | }, 436 | 'search_ports' : { 437 | 'route': '/api/v0/ports/search/:field/:search', 438 | 'request_method': 'GET', 439 | 'response_key':'ports', 440 | 'flags':'o', 441 | 'cache':True 442 | }, 443 | 'ports_with_associated_mac' : { 444 | 'route': '/api/v0/ports/mac/:search', 445 | 'request_method': 'GET', 446 | 'response_key':'port', 447 | 'cache':True 448 | }, 449 | 'get_port_info' : { 450 | 'route': '/api/v0/ports/:portid', 451 | 'request_method': 'GET', 452 | 'response_key':'port', 453 | 'flags':'s', 454 | 'cache':True 455 | }, 456 | 'get_port_ip_info' : { 457 | 'route': '/api/v0/ports/:portid/ip', 458 | 'request_method': 'GET', 459 | 'response_key':'addresses', 460 | 'cache':True 461 | }, 462 | 'list_bgp' : { 463 | 'route': '/api/v0/bgp', 464 | 'request_method': 'GET', 465 | 'response_key':'bgp_sessions', 466 | 'cache':True 467 | }, 468 | 'get_bgp' : { 469 | 'route': '/api/v0/bgp/:id', 470 | 'request_method': 'GET', 471 | 'response_key':'bgp_session', 472 | 'cache':True 473 | }, 474 | 'edit_bgp_descr' : { 475 | 'route': '/api/v0/bgp/:id', 476 | 'request_method': 'POST', 477 | }, 478 | 'list_cbgp' : { 479 | 'route': '/api/v0/routing/bgp/cbgp', 480 | 'request_method': 'GET', 481 | 'response_key':'bgp_counters', 482 | 'cache':True 483 | }, 484 | 'list_ip_addresses' : { 485 | 'route': '/api/v0/resources/ip/addresses', 486 | 'request_method': 'GET', 487 | 'response_key':'ip_addresses', 488 | 'cache':True 489 | }, 490 | 'get_network_ip_addresses' : { 491 | 'route': '/api/v0/resources/ip/networks/:id/ip', 492 | 'request_method': 'GET', 493 | 'response_key':'addresses', 494 | 'cache':True 495 | }, 496 | 'list_fdb_detail' : { 497 | 'route': '/api/v0/resources/fdb/:mac/detail', 498 | 'request_method': 'GET', 499 | 'response_key':'ports_fdb', 500 | 'cache':True 501 | }, 502 | 'list_ip_networks' : { 503 | 'route': '/api/v0/resources/ip/networks', 504 | 'request_method': 'GET', 505 | 'response_key':'ip_networks', 506 | 'cache':True 507 | }, 508 | 'list_ipsec' : { 509 | 'route': '/api/v0/routing/ipsec/data/:hostname', 510 | 'request_method': 'GET', 511 | 'response_key':'ipsec', 512 | 'cache':True 513 | }, 514 | 'list_ospf' : { 515 | 'route': '/api/v0/ospf', 516 | 'request_method': 'GET', 517 | 'response_key':'ospf_neighbours', 518 | 'cache':True 519 | }, 520 | 'list_ospf_ports' : { 521 | 'route': '/api/v0/ospf_ports', 522 | 'request_method': 'GET', 523 | 'response_key':'ospf_ports', 524 | 'cache':True 525 | }, 526 | 'list_vrf' : { 527 | 'route': '/api/v0/routing/vrf', 528 | 'request_method': 'GET', 529 | 'response_key':'vrfs', 530 | 'cache':True 531 | }, 532 | 'get_vrf' : { 533 | 'route': '/api/v0/routing/vrf/:id', 534 | 'request_method': 'GET', 535 | 'response_key':'vrf', 536 | 'cache':True 537 | }, 538 | 'list_mpls_services' : { 539 | 'route': '/api/v0/routing/mpls/services', 540 | 'request_method': 'GET', 541 | 'response_key':'mpls_services', 542 | 'cache':True 543 | }, 544 | 'list_mpls_saps' : { 545 | 'route': '/api/v0/routing/mpls/saps', 546 | 'request_method': 'GET', 547 | 'response_key':'saps', 548 | 'cache':True 549 | }, 550 | 'list_services' : { 551 | 'route': '/api/v0/services', 552 | 'request_method': 'GET', 553 | 'response_key':'services', 554 | 'cache':True 555 | }, 556 | 'get_service_for_host' : { 557 | 'route': '/api/v0/services/:hostname', 558 | 'request_method': 'GET', 559 | 'response_key':'services', 560 | 'cache':True 561 | }, 562 | 'add_service_for_host' : { 563 | 'route': '/api/v0/services/:hostname', 564 | 'request_method': 'POST', 565 | }, 566 | 'edit_service_from_host' : { 567 | 'route': '/api/v0/services/:service_id', 568 | 'request_method': 'PATCH', 569 | }, 570 | 'delete_service_from_host' : { 571 | 'route': '/api/v0/services/:service_id', 572 | 'request_method': 'DELETE', 573 | }, 574 | 'list_vlans' : { 575 | 'route': '/api/v0/resources/vlans', 576 | 'request_method': 'GET', 577 | 'response_key':'vlans', 578 | 'cache':True 579 | }, 580 | 'get_vlans' : { 581 | 'route': '/api/v0/devices/:hostname/vlans', 582 | 'request_method': 'GET', 583 | 'response_key':'vlans', 584 | 'cache':True 585 | }, 586 | 'list_links' : { 587 | 'route': '/api/v0/resources/links', 588 | 'request_method': 'GET', 589 | 'response_key':'links', 590 | 'cache':True 591 | }, 592 | 'get_links' : { 593 | 'route': '/api/v0/devices/:hostname/links', 594 | 'request_method': 'GET', 595 | 'response_key':'links', 596 | 'cache':True 597 | }, 598 | 'get_link' : { 599 | 'route': '/api/v0/resources/links/:id', 600 | 'request_method': 'GET', 601 | 'response_key':'links', 602 | 'cache':True 603 | }, 604 | 'list_fdb' : { 605 | 'route': '/api/v0/resources/fdb/:mac', 606 | 'request_method': 'GET', 607 | 'response_key':'ports_fdb', 608 | 'cache':True 609 | }, 610 | 'system' : { 611 | 'route': '/api/v0/system', 612 | 'request_method': 'GET', 613 | 'response_key':'system', 614 | 'cache':True 615 | }, 616 | } 617 | #Generates Query Parameters 618 | def _gen_qparams(self,qparams,first_qparam=True,param_value=False): 619 | output='' 620 | for qparam in qparams: 621 | if type(qparam) == int: 622 | qparam=str(qparam) 623 | if type(qparam) == str: 624 | if qparam == "": 625 | continue 626 | if param_value: 627 | output = output + '=' + qparam 628 | param_value=False 629 | elif first_qparam is True: 630 | output = output + '?' + qparam 631 | first_qparam=False 632 | param_value=True 633 | else: 634 | output = output + '&' + qparam 635 | param_value=True 636 | elif type(qparam) == list or type(qparam) == dict: 637 | if type(qparam) == dict : 638 | qparam=list(qparam.values()) 639 | nest_output,first_qparam=self._gen_qparams(qparam,first_qparam,param_value) 640 | output= output + nest_output 641 | else: 642 | raise LibreNMSAPIClientException("API received unsupported parameter value: %s " % qparam) 643 | return output,first_qparam 644 | #Generates Route using parameters 645 | def _gen_route(self,route,params): 646 | if len(params) == 0: 647 | if re.findall('\/:.*',route): 648 | route=re.sub('\/:.*',"",route,1) 649 | return [route] 650 | if re.findall('\/:',route) : #Checks if any params are in URL path ( /: ) ie required parameter. 651 | param=params.pop() 652 | if type(param) == dict : 653 | param=list(param.values()) 654 | if type(param) == list : 655 | output = list() 656 | for subparam in param: 657 | subparams = params.copy() 658 | subparams.append(subparam) 659 | output = output + self._gen_route(route,subparams) 660 | return output 661 | elif type(param) == int or str: 662 | if param == "": 663 | if 'o' in self._flags: 664 | if re.findall('/:.*?/',route) : 665 | return self._gen_route(re.sub('/:.*?/',"/",route, 1).rstrip("/"),params) 666 | return self._gen_route(re.sub('\/:.*',"/" ,route, 1).rstrip("/"),params) 667 | raise LibreNMSAPIClientException("API received empty parameter for %s" % route) 668 | if re.findall('/:.*?/',route) : 669 | return self._gen_route(re.sub('/:.*?/',"/%s/" % param,route, 1),params) 670 | return self._gen_route(re.sub('\/:.*',"/%s" % param,route, 1),params) 671 | raise LibreNMSAPIClientException("API received unsupported parameter value: %s " % param) 672 | if params: 673 | params.reverse() 674 | qparams,fp=self._gen_qparams(params) 675 | route = route + qparams 676 | return [route] 677 | 678 | #Performs API Call 679 | def _apicall(self, *t_params): 680 | params=list(t_params) 681 | params.reverse() 682 | if self.functions[self._function_name]['request_method'] in ['POST','PATCH','PUT']: #Retrieve request data for request_methods that need input data. 683 | if not params: 684 | raise LibreNMSAPIClientException("API '%s' function called without required request data." % self._function_name) 685 | request_data = params.pop() 686 | 687 | if len(re.findall('\/:',self.functions[self._function_name]['route'])) > len(params) and 'o' not in self._flags: #Ensures the needed number of Route parameters are provided 688 | raise LibreNMSAPIClientException("API '%s' function called without required parameters." % self._function_name) 689 | routes=self._gen_route(self.functions[self._function_name]['route'],params) #Generate Function Route/s with parameters 690 | responses=[] 691 | for route in routes: 692 | if('cache' in self.functions[self._function_name] and self.functions[self._function_name]['cache'] and (self.functions[self._function_name]['request_method'] + "-" + route) in self.cache) : 693 | response=self.cache[self.functions[self._function_name]['request_method'] + "-" + route] 694 | else: 695 | if(self.functions[self._function_name]['request_method'] == 'DELETE'): 696 | response=requests.delete( self._libre_url + route, headers=self._header, verify = False,stream=False) 697 | elif(self.functions[self._function_name]['request_method'] == 'GET'): 698 | response=requests.get( self._libre_url + route, headers=self._header, verify = False,stream=False) 699 | elif(self.functions[self._function_name]['request_method'] == 'PATCH'): 700 | response=requests.patch( self._libre_url + route, headers=self._header,json=request_data, verify = False,stream=False) 701 | elif(self.functions[self._function_name]['request_method'] == 'POST'): 702 | response=requests.post( self._libre_url + route, headers=self._header,json=request_data, verify = False,stream=False) 703 | elif(self.functions[self._function_name]['request_method'] == 'PUT'): 704 | response=requests.put( self._libre_url + route, headers=self._header,json=request_data, verify = False,stream=False) 705 | if 'cache' in self.functions[self._function_name] and self.functions[self._function_name]['cache']: 706 | self.cache[self.functions[self._function_name]['request_method'] + "-" + route]=response 707 | responses.append(response) 708 | 709 | call_output = [] 710 | for response in responses: 711 | if response.status_code < 200 or response.status_code > 299: #Check for invalid HTTP response 712 | if 'i' in self._flags : #if ignore error flag is enabled 713 | continue 714 | raise LibreNMSAPIClientException("API received invalid HTTP response %s" % response.text) 715 | if 'r' in self._flags: 716 | call_output.append(response) 717 | else: 718 | response_edata=json.loads(response.text) #Convert response to JSON object 719 | if 'f' not in self._flags: 720 | if 'status' not in response_edata: 721 | if 'i' in self._flags : #if ignore error flag is enabled 722 | continue 723 | raise LibreNMSAPIClientException("API received invalid JSON response. %s" % response.text) 724 | if response_edata['status'] != "ok": 725 | if 'i' in self._flags : #if ignore error flag is enabled 726 | continue 727 | raise LibreNMSAPIClientException("API received error response. %s" % response.text) 728 | if 'e' in self._flags: 729 | call_output.append(response_edata) 730 | else: 731 | if 'response_key' in self.functions[self._function_name]: 732 | if 'c'in self._flags: 733 | call_output = call_output + response_edata[self.functions[self._function_name]['response_key']] 734 | else: 735 | call_output.append(response_edata[self.functions[self._function_name]['response_key']][0] if "s" in self._flags else response_edata[self.functions[self._function_name]['response_key']]) 736 | elif 'message' in response_edata: 737 | call_output.append(response_edata['message']) 738 | else: 739 | call_output.append(response_edata['status']) 740 | 741 | if "l" not in self._flags and len(call_output) == 1 : 742 | call_output=call_output[0] 743 | 744 | self._flags='' 745 | return call_output 746 | 747 | #Returns meta API Call function 748 | def __getattr__(self, function_name): 749 | function_name=function_name.lower() 750 | if function_name not in self.functions: 751 | sfunction_name=function_name.split('_',1) #Check for flags in function call 752 | if len(sfunction_name)== 2 and sfunction_name[1] in self.functions: 753 | self._flags=sfunction_name[0] 754 | function_name=sfunction_name[1] 755 | else: 756 | raise LibreNMSAPIClientException("API Function '%s' does not exist" % function_name) 757 | self._function_name=function_name 758 | if 'flags' in self.functions[self._function_name]: #Check if function has required flags and concats them to existing flags. 759 | self._flags = self._flags + self.functions[self._function_name]['flags'] 760 | return self._apicall 761 | 762 | def __init__(self, libre_url=None, api_token=None): 763 | self._flags='' 764 | if api_token is None and libre_url is None: 765 | from dotenv import load_dotenv 766 | load_dotenv() 767 | api_token = os.environ['LibreNMS_APIToken'] 768 | self._libre_url = os.environ['LibreNMS_URL'] 769 | else: 770 | self._libre_url = libre_url 771 | self._header={ 772 | "Content-Type": "application/json", 773 | "Accept": "application/json", 774 | "X-Auth-Token": api_token 775 | } 776 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------