Merge branch 'bile0026-master'

merging code improvements and v2.9 support

Author: lopes

.gitignore

@@ -106,3 +106,9 @@ venv.bak/
 # trash
 .vscode/
 
+scans/*
+logs/*
+
+test_api.py
+
+samples/custom-nmap-scan.sh

nbs/__init__.py

@@ -1,21 +1,37 @@
 import logging
+import requests
 
 from pynetbox import api
 
 
 class NetBoxScanner(object):
 
     def __init__(self, address, token, tls_verify, tag, cleanup):
-        self.netbox = api(address, token, ssl_verify=tls_verify)
-        self.tag = tag
-        self.cleanup = cleanup
-        self.stats = {
-            'unchanged': 0,
-            'created': 0,
-            'updated': 0,
-            'deleted': 0,
-            'errors': 0
-        }
+        if (tls_verify == 'no'):
+            session = requests.Session()
+            session.verify = False
+            self.netbox = api(address, token)
+            self.netbox.http_session = session
+            self.tag = tag
+            self.cleanup = cleanup
+            self.stats = {
+                'unchanged': 0,
+                'created': 0,
+                'updated': 0,
+                'deleted': 0,
+                'errors': 0
+            }
+        else:
+            self.netbox = api(address, token)
+            self.tag = tag
+            self.cleanup = cleanup
+            self.stats = {
+                'unchanged': 0,
+                'created': 0,
+                'updated': 0,
+                'deleted': 0,
+                'errors': 0
+            }
 
     def sync_host(self, host):
         '''Syncs a single host to NetBox
@@ -36,18 +52,20 @@ def sync_host(self, host):
                     aux = nbhost.description
                     nbhost.description = host[1]
                     nbhost.save()
-                    logging.info(f'updated: {host[0]}/32 "{aux}" -> "{host[1]}"')
+                    logging.info(
+                        f'updated: {host[0]}/32 "{aux}" -> "{host[1]}"')
                     self.stats['updated'] += 1
                 else:
                     logging.info(f'unchanged: {host[0]}/32 "{host[1]}"')
                     self.stats['unchanged'] += 1
             else:
-                    logging.info(f'unchanged: {host[0]}/32 "{host[1]}"')
-                    self.stats['unchanged'] += 1
+                logging.info(f'unchanged: {host[0]}/32 "{host[1]}"')
+                self.stats['unchanged'] += 1
         else:
             self.netbox.ipam.ip_addresses.create(
                 address=host[0],
-                # tags=[self.tag],
+                tags=[{"name": self.tag}],
+                # dns_name=host[1],
                 description=host[1]
             )
             logging.info(f'created: {host[0]}/32 "{host[1]}"')

nbs/nmap.py

@@ -28,4 +28,3 @@ def run(self):
                         host.find('address').attrib['addr'],
                         self.unknown
                     ))
-        

netbox-scanner.conf

@@ -1,29 +1,29 @@
 [NETBOX]
-address    = https://netbox.domain
-token      = 
+address    = <server>
+token      = <token>
+logs       = logs/
+# use lowercase no if you want to skip ssl verification.
+# any other value will verify the server ssl certificate.
 tls_verify = no
-logs       = .
 
 [NMAP]
-path     = /opt/netbox-scanner/samples/nmap
+path     = ./
 unknown  = autodiscovered:netbox-scanner
 tag      = nmap
-cleanup  = yes
+cleanup  = no
 
 [NETXMS]
 address    = https://netxms.domain
-username   = 
+username   =
 password   =
-tls_verify = no
 unknown    = autodiscovered:netbox-scanner
 tag        = netxms
 cleanup    = yes
 
 [PRIME]
 address    = https://prime.domain/webacs/api/v4
-username   = 
-password   = 
-tls_verify = no
+username   =
+password   =
 unknown    = autodiscovered:netbox-scanner
 tag        = prime
 cleanup    = yes

netbox-scanner.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
 import logging
+import sys
 
 from configparser import ConfigParser
 from argparse import ArgumentParser
@@ -10,9 +11,15 @@
 from urllib3.exceptions import InsecureRequestWarning
 
 from nbs import NetBoxScanner
-from nbs.nmap import Nmap
-from nbs.netxms import NetXMS
-from nbs.prime import Prime
+
+argument = str(sys.argv[1])
+
+if argument == 'nmap':
+    from nbs.nmap import Nmap
+if argument == 'netxms':
+    from nbs.netxms import NetXMS
+if argument == 'prime':
+    from nbs.prime import Prime
 
 
 local_config = expanduser('~/.netbox-scanner.conf')
@@ -27,29 +34,36 @@
     raise FileNotFoundError('Configuration file was not found.')
 
 netbox = config['NETBOX']
-nmap = config['NMAP']
-netxms = config['NETXMS']
-prime = config['PRIME']
+if argument == 'nmap':
+    nmap = config['NMAP']
+if argument == 'netxms':
+    netxms = config['NETXMS']
+if argument == 'prime':
+    prime = config['PRIME']
 
 parser = ArgumentParser(description='netbox-scanner')
 subparsers = parser.add_subparsers(title='Commands', dest='command')
 subparsers.required = True
-argsp = subparsers.add_parser('nmap', help='Nmap module')
-argsp = subparsers.add_parser('netxms', help='NetXMS module')
-argsp = subparsers.add_parser('prime', help='Cisco Prime module')
+if argument == 'nmap':
+    argsp = subparsers.add_parser('nmap', help='Nmap module')
+if argument == 'netxms':
+    argsp = subparsers.add_parser('netxms', help='NetXMS module')
+if argument == 'prime':
+    argsp = subparsers.add_parser('prime', help='Cisco Prime module')
 args = parser.parse_args()
 
 logfile = '{}/netbox-scanner-{}.log'.format(
     netbox['logs'],
     datetime.now().isoformat()
 )
 logging.basicConfig(
-    filename=logfile, 
-    level=logging.INFO, 
+    filename=logfile,
+    level=logging.INFO,
     format='%(asctime)s\tnetbox-scanner\t%(levelname)s\t%(message)s'
 )
 logging.getLogger().addHandler(logging.StreamHandler())
 
+# useful if you have tls_verify set to no
 disable_warnings(InsecureRequestWarning)
 
 
@@ -58,6 +72,7 @@ def cmd_nmap(s):  # nmap handler
     h.run()
     s.sync(h.hosts)
 
+
 def cmd_netxms(s):  # netxms handler
     h = NetXMS(
         netxms['address'],
@@ -69,12 +84,13 @@ def cmd_netxms(s):  # netxms handler
     h.run()
     s.sync(h.hosts)
 
+
 def cmd_prime(s):  # prime handler
     h = Prime(
         prime['address'],
         prime['username'],
         prime['password'],
-        prime.getboolean('tls_verify'), 
+        prime.getboolean('tls_verify'),
         prime['unknown']
     )
     h.run()  # set access_point=True to process APs
@@ -85,8 +101,8 @@ def cmd_prime(s):  # prime handler
     scanner = NetBoxScanner(
         netbox['address'],
         netbox['token'],
-        netbox.getboolean('tls_verify'), 
-        nmap['tag'], 
+        netbox['tls_verify'],
+        nmap['tag'],
         nmap.getboolean('cleanup')
     )
 

samples/networks.txt

@@ -0,0 +1,5 @@
+192.168.0.0/24
+192.168.1.0/24
+192.168.2.0/24
+192.168.3.0/24
+172.16.0.0/24