sc-napalm 1.0.0__py3-none-any.whl

custom_napalm/utils.py

@@ -0,0 +1,74 @@
+from typing import Union
+import logging
+import sys
+import argparse
+from decouple import config
+from os import getenv
+
+LOG_LEVELS = {
+    "DEBUG": logging.DEBUG,
+    "INFO": logging.INFO,
+    "WARNING": logging.WARNING,
+    "ERROR": logging.WARNING,
+    "CRITICAL": logging.CRITICAL,
+}
+LOG_FORMAT = "%(asctime)-15s  %(levelname)8s %(name)s %(message)s"
+
+
+def configure_logging(
+    log_level: Union[int, str],
+    log_globally: bool = False,
+    log_file: str = None,
+    log_to_console: bool = False,
+):
+    """
+    Configures logging for the module, or globally as indicated by the input
+    """
+
+    if log_globally:
+        logger = logging.getLogger()
+    else:
+        module_name = __name__.split(".")[0]
+        logger = logging.getLogger(module_name)
+
+    if isinstance(log_level, str):
+        log_level = LOG_LEVELS[log_level.upper()]
+    logger.setLevel(log_level)
+
+    if log_file:
+        file_handler = logging.handlers.RotatingFileHandler(
+            log_file, maxBytes=1024 * 1024 * 10, backupCount=20
+        )
+        file_handler.setFormatter(logging.Formatter(LOG_FORMAT))
+        logger.addHandler(file_handler)
+
+    if log_to_console:
+        stdout_handler = logging.StreamHandler(sys.stdout)
+        stdout_handler.setFormatter(logging.Formatter(LOG_FORMAT))
+        logger.addHandler(stdout_handler)
+
+
+def get_from_args_or_env(
+    cli_arg: str, parsed_args: argparse.Namespace = None, required=True
+) -> str:
+    """
+    Pull a value from parsed arparse, if it's not there look for it
+    in .env, and if it's not there, check the user's environment.
+    """
+    cli_arg = cli_arg.replace("-", "_")
+
+    if getattr(parsed_args, cli_arg, False):
+        return getattr(parsed_args, cli_arg)
+
+    env_arg = cli_arg.upper()
+    if config(env_arg, None):
+        return config(env_arg)
+
+    if getenv(env_arg):
+        return getenv(env_arg)
+
+    if required:
+        raise ValueError(
+            f"ERROR: Please provide {cli_arg} as cli input or set as {env_arg} environment variable"
+        )
+    return None

sc_napalm-1.0.0.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: sc-napalm
+Version: 1.0.0
+Summary: Add your description here
+Requires-Python: >=3.8
+Requires-Dist: gitpython>=3.1.45
+Requires-Dist: lxml>=6.0.2
+Requires-Dist: napalm-srl>=1.0.5
+Requires-Dist: napalm-sros>=1.0.2
+Requires-Dist: napalm>=5.1.0
+Requires-Dist: pynautobot>=2.1.1
+Requires-Dist: python-decouple>=3.8
+Description-Content-Type: text/markdown
+
+# sc-napalm
+
+This repo is for building custom [NAPALM](https://napalm.readthedocs.io/en/latest/) "getters" to pull operational data from network devices, as well as
+override existing NAPALM getters with custom code if needed. At the moment only one custom getter is implemented: `get_inventory`. This getter
+pulls model and serial numbers of device components: fans, psus, and optics.
+
+What's cool about NAPALM is that if you nest your custom drivers under `custom_napalm` as is done in this project, you can install your custom drivers
+in the same virtual environment as the main NAPALM package, and they will override NAPALM's core drivers. This allows us to leverage NAPALM in a pretty 
+seamless way - by that I mean applications that leverage NAPALM (like Nautobot or Nornir) can be easily altered to use this code instead.
+
+Right now, the following platforms are supported:
+* eos
+* iosxr (via netconf)
+* junos
+* nos (Drivenets)
+* nxos
+* srl (Nokia SR Linux)
+* sros
+
+
+## Using sc-napalm
+The package comes with a cli script called `sc-napalm-get` that will run a particular getter against a particular device and output the results
+to your terminal.
+
+To use the script, you can install the package from pypi, ideally into a virtual environment:
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install sc-napalm
+```
+Now that you've done this you can run `sc-napalm-get` from your venv. Note that you must either provide your credentials
+directly to the script, or set them as environment variables `SC_USERNAME` and `SC_PASSWORD`. Run it with `--help` to see all the
+various options.
+```
+(venv) aliebowitz@sysauto:~$ export SC_USERNAME=nso
+(venv) aliebowitz@sysauto:~$ export SC_PASSWORD=<redacted>
+(venv) aliebowitz@sysauto:~$ sc-napalm-get --help
+usage: sc-napalm-get [-h] [--ssh-cfg SSH_CFG] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL} | -L {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--logfile LOGFILE] [--sc_username SC_USERNAME]
+                     [--sc_password SC_PASSWORD]
+                     device {iosxr,nxos,junos,sros,srl,eos,nos} {get_config,get_facts,get_optics,get_lldp_neighbors,get_inventory}
+
+Run a specific sc_napalm "getter" against a device.
+
+positional arguments:
+  device                device hostname or IP address
+  {iosxr,nxos,junos,sros,srl,eos,nos}
+                        The platform of this device
+  {get_config,get_facts,get_optics,get_lldp_neighbors,get_inventory}
+                        The getter command to run against this device
+
+options:
+  -h, --help            show this help message and exit
+  --ssh-cfg SSH_CFG     Use SSH config file to connect
+  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
+                        Set log level for sc_napalm only
+  -L {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --LOG-LEVEL {DEBUG,INFO,WARNING,ERROR,CRITICAL}
+                        set global log level
+  --logfile LOGFILE     Save logging to a file (specified by name) instead of to stdout
+  --sc_username SC_USERNAME
+                        Specify credentials
+  --sc_password SC_PASSWORD
+                        Specify credentials
+(venv) aliebowitz@sysauto:~$ sc-napalm-get 2001:468:1f07:ff19::1d eos get_inventory
+[{'name': 'Ethernet45',
+  'part_number': 'QSFP-100G-LR4',
+  'serial_number': 'XYL252206819',
+  'subtype': 'QSFP-100G-LR4',
+  'type': 'optic'},
+ {'name': 'Ethernet46',
+  'part_number': 'QSFP-100G-LR4',
+  'serial_number': 'XYL252206822',
+  'subtype': 'QSFP-100G-LR4',
+  'type': 'optic'},
+ {'name': 'PSU 1',
+  'part_number': 'PWR-511-AC-RED',
+  'serial_number': 'EEWT2420216960',
+  'subtype': None,
+  'type': 'psu'},
+  ...
+```
+
+## Developing sc-napalm
+Currently, the getters that are exposed as options in the `get` script are defined in the [base class](https://scinet.supercomputing.org:8443/automation/sc25/sc-napalm/-/blob/main/src/custom_napalm/base.py?ref_type=heads) of the custom drivers.
+Note that because most of the custom classes inherit the NAPALM getters, we could easily define all the other NAPALM getters there, but I've only included ones I think are obviously useful to us.
+
+My hope is that instead of just printing out results we can write code that saves data in Nautobot, or some other place.
+This could be done with Nornir or Nautobot jobs.
+
+## To-dos
+* `get_inventory` methods for sros
+* Test/mock classes for custom getters
+

sc_napalm-1.0.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+custom_napalm/__init__.py,sha256=tb8thMjM7cm77r_yIjZ3YP1LiaFjYPVzIRZI1b-JAqY,770
+custom_napalm/base.py,sha256=AMZVPWFL5i8X9YaPxGsyqg00By4oUF3VyETeJ-wS-3s,3822
+custom_napalm/get.py,sha256=hfqriJVgrBZeXqbLvofUnZwMPK4ka6DaBRpLMnuAZtU,2448
+custom_napalm/models.py,sha256=4RoOfYM1fpsEmSg5ytQk5MHIkT6o-rH_gREgImCFue8,473
+custom_napalm/utils.py,sha256=SAa-g3N9eq8GjzmKvewTY1Chf9nGooqJ7Xnn5VHD5Go,2036
+custom_napalm/eos/__init__.py,sha256=OHS-WcwZx_VMizK2Ui0eh7KePsAiLTR-03VkEiq_IEg,29
+custom_napalm/eos/eos.py,sha256=GZQbr_Yq4erx20D0w7WYBlP3n9XrG-b7iyoaN5ijHZk,2966
+custom_napalm/iosxr/__init__.py,sha256=Y_kJcBzXGutAipwWiOdItybx1GN4hjRxTjs_m8ylFcE,27
+custom_napalm/iosxr/constants.py,sha256=9s04MM-z_xPfyfsRnC-uoKA14FB4grUp9XB0H7pri28,4194
+custom_napalm/iosxr/iosxr.py,sha256=WcrvIMOL4XL0aq2RJZLkFluXqbvUhsJWhAw9c5X9bAU,1577
+custom_napalm/junos/__init__.py,sha256=Z1u0FwvewtLL9RBj9SAfWk4LlTRNcwj8WMb4EpCK0ZY,27
+custom_napalm/junos/junos.py,sha256=LAqoE5MZYJxWkQ65vVeEWQZsYJLD8sgQImFEUxzhxZI,7741
+custom_napalm/junos/junos_views.py,sha256=FF4fOj4imvDC7EzC0ufyM3X2sxOEwqDKItYVJ1E3aOc,426
+custom_napalm/junos/junos_views.yml,sha256=xSfF55PiTliQNMPn32pUzw5qO8nPbGwkrCHBzMIs3Gw,4544
+custom_napalm/nos/__init__.py,sha256=9_lHFCrqhfIxmqP4r5ct_wynee-gsK5k5oAkFeDtxGA,29
+custom_napalm/nos/constants.py,sha256=ErqCmavFs5yhjkM4xx8mU7Y6SKw7e-48U9Ab_nly-JQ,3321
+custom_napalm/nos/nos.py,sha256=ThO4DtkwkNvKE_ml2mUlfthk_8Zk2i6rFSbCrwWeX_k,8771
+custom_napalm/nxos/__init__.py,sha256=UiBRkfxFQEKVOwhiRnOtAR-KSZYYyBvdre2VazHxxVM,25
+custom_napalm/nxos/nxos.py,sha256=A9KXHInjHk3VZaG8-Wq4cEdVD4RgGJBkivqjpv8l0gk,2637
+custom_napalm/nxos/utils/textfsm_templates/sh_int_transceiver.tpl,sha256=rMK9qg2eYR5klmoi6qPRufhBX6ooqRWmPaIM3J7aGxI,596
+custom_napalm/nxos/utils/textfsm_templates/sh_inventory.tpl,sha256=GrgUzRsIUzI5SxGExFlUSXF3I9puIXczrzzaEYnMKvk,159
+custom_napalm/srl/__init__.py,sha256=p5kiVIOBjp7O8d2955-Jj3wkLk66687wBxli34IBU_0,34
+custom_napalm/srl/srl.py,sha256=uZVv3QM8LuhO62xjM6aA-T6A9k4QjYPqEzNb8YObIgM,6134
+custom_napalm/srl_ssh/__init__.py,sha256=hMR8SbWrdhPB6bZwKjcWCdEi7rdTLcBwKQx-rKcadl8,39
+custom_napalm/srl_ssh/srl_ssh.py,sha256=uPNYwwPUGkNXQPNh-dCbfHDfkoXTkBavl5rBKeLNS7Y,1390
+custom_napalm/sros/__init__.py,sha256=SuDmNhd9m0eLJm4sQMQLg8ThydG48AFZwSfp70U8mfk,36
+custom_napalm/sros/nc_filters.py,sha256=tHMqEvDpww9W0nzmKV5rIdjlIs93iS08T758VYIA4xQ,508
+custom_napalm/sros/sros.py,sha256=hX2yd3fxFhtQ2MlUq6Hsz8Bi5mMCpqtZSKM_7sBFsjc,1975
+sc_napalm-1.0.0.dist-info/METADATA,sha256=7fRTRWsFD0xVqlfWUUQFwo_B1zevcw9VfC5MLuSe7cw,4715
+sc_napalm-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sc_napalm-1.0.0.dist-info/entry_points.txt,sha256=LTin-OoLE7iMryLisDgQi8tsl7doDckm50EEG8_VFr8,57
+sc_napalm-1.0.0.dist-info/RECORD,,

sc_napalm-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sc_napalm-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sc-napalm-get = custom_napalm.get:main