netutils

1.17.2 · active · verified Wed Apr 15

netutils is a Python library offering a collection of functions and objects for common network automation tasks, such as BGP ASN conversion, interface name standardization, MAC address formatting, IP address calculations, and configuration parsing. It is actively maintained with frequent releases, typically every few weeks, and is currently at version 1.17.2.

Warnings

breaking Direct instantiation of `HPEConfigParser` was deprecated in v1.17.0. Users should now subclass a private internal class instead.
Fix: Refactor code to subclass the appropriate private configuration parser class if extending HP Network OS parsing functionality. Consult the latest documentation for the correct base class.
gotcha The `encrypt_cisco_type7` function in versions prior to 1.15.2 incorrectly ignored a `salt=0` parameter, leading to unexpected encryption results for that specific salt value.
Fix: Upgrade to `netutils` version 1.15.2 or newer to ensure correct handling of `salt=0` in `encrypt_cisco_type7`.
gotcha Parsing empty Palo Alto Networks PanOS configurations in versions prior to 1.17.1 would raise an error.
Fix: Upgrade to `netutils` version 1.17.1 or newer to correctly parse empty Palo Alto Networks PanOS configurations.
breaking The library explicitly requires Python versions >=3.10 and <3.15.
Fix: Ensure your Python environment is within the supported range (e.g., Python 3.10, 3.11, 3.12, 3.13, 3.14).
gotcha Many configuration parsing functionalities (e.g., `ConfigParser`) rely on the `ntc-templates` library. Failure to install `ntc-templates` will result in `ImportError` or `ConfigParser` not being able to find device OS definitions.
Fix: Install `ntc-templates` explicitly: `pip install ntc-templates`.

Install

pip install netutils Basic Install
pip install netutils[napalm] Install with optional NAPALM dependencies

Imports

ConfigParser
```
from netutils.config.parser import ConfigParser
```
Used for parsing device configurations based on provided text and OS type.
encrypt_cisco_type7
```
from netutils.password import encrypt_cisco_type7
```
For encrypting Cisco Type 7 passwords.
normalize_interface_name
```
from netutils.interface import normalize_interface_name
```
For standardizing network interface names across different platforms.

Quickstart

This quickstart demonstrates how to use `netutils.config.parser.ConfigParser` to parse a sample Cisco IOS configuration. It also includes a basic example of an IP utility function. Note that `ntc-templates` is a required dependency for the `ConfigParser` to function correctly.

from netutils.config.parser import ConfigParser

# Example Cisco IOS configuration string
config_text = """
hostname my-router
interface GigabitEthernet0/0
 ip address 192.168.1.1 255.255.255.0
 no shutdown
interface Loopback0
 ip address 10.0.0.1 255.255.255.255
"""

# Instantiate the ConfigParser for Cisco IOS
# 'cisco_ios' is a key from ntc-templates, which is a required dependency
try:
    parser = ConfigParser(config_text, 'cisco_ios')
    parsed_config = parser.parse()
    print("Parsed Configuration:\n", parsed_config)

    # Example using an IP utility function
    from netutils.ip import is_valid_ipv4_address
    print(f"Is '192.168.1.1' a valid IPv4 address? {is_valid_ipv4_address('192.168.1.1')}")

except ImportError:
    print("Error: 'ntc-templates' not found. Please install it: pip install ntc-templates")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →