cisco-acl
Python package to parse and manage Cisco ACL (Access Control List).
Supported platforms:
Cisco IOS (tested on ISR4331/K9, IOS XE version 16.09.06)
Cisco Nexus NX-OS (tested on N3K-C3172TQ-XL, NXOS version 7.0(3)I7(8))
Main features:
Supports wildcards, converts wildcards to prefixes
Supports uni-dimensional address groups (address-group inside other address-group is not supported)
Represents TCP/UDP ports and IP protocols as numbers or well-known names
Converts IOS syntax to NX-OS and vice vera
Generates sequence numbers for ACEs
Looks for and removes ACEs in the shadow (rules without hits)
Groups ACEs to blocks. After sorting, the order of ACEs within a group does not change
Acronyms
Acronym |
Definition |
|---|---|
ACL |
Access Control List |
ACE |
Access Control Entry |
ACEs |
Multiple Access Control Entries |
Requirements
Python >=3.8,<3.12
Installation
Install the package from pypi.org release
pip install cisco-aclor install the package from github.com release
pip install https://github.com/vladimirs-git/cisco-acl/archive/refs/tags/3.3.5.tar.gzor install the package from github.com repository
pip install git+https://github.com/vladimirs-git/cisco-aclacls()
cisco_acl.acls(config, kwargs) Creates Acl objects based on the “show running-config” output. Support address group objects. Each ACE line is treated as an independent Ace (default) or ACE lines can be grouped to AceGroup by text in remarks (param group_by)
Parameter |
Type |
Description |
|---|---|---|
config |
str |
Cisco config, “show running-config” output |
platform |
str |
Platform: “ios” (default), “nxos” |
version |
str |
Software version, default is “0”. |
names |
List[str] |
Parses only ACLs with specified names, skips any other |
max_ncwb |
int |
Max count of non-contiguous wildcard bits |
indent |
str |
ACE lines indentation (default “ “) |
protocol_nr |
bool |
Well-known ip protocols as numbers, True - all ip protocols as numbers, False - well-known ip protocols as names (default) |
port_nr |
bool |
Well-known TCP/UDP ports as numbers, True - all tcp/udp ports as numbers, False - well-known tcp/udp ports as names (default) |
group_by |
str |
Startswith in remark line. ACEs group, starting from the Remark, where line startswith group_by, will be applied to the same AceGroup, until next Remark that also startswith group_by |
- Return
List of Acl objects
Examples
aces()
cisco_acl.aces(config, kwargs) Creates Ace objects based on the “show running-config” output
Parameter |
Type |
Description |
|---|---|---|
config |
str |
Cisco config, “show running-config” output |
platform |
str |
Platform: “ios” (default), “nxos” |
version |
str |
Software version, default is “0”. |
max_ncwb |
int |
Max count of non-contiguous wildcard bits |
protocol_nr |
bool |
Well-known ip protocols as numbers, True - all ip protocols as numbers, False - well-known ip protocols as names (default) |
port_nr |
bool |
Well-known TCP/UDP ports as numbers, True - all tcp/udp ports as numbers, False - well-known tcp/udp ports as names (default) |
group_by |
str |
Startswith in remark line. ACEs group, starting from the Remark, where line startswith group_by, will be applied to the same AceGroup, until next Remark that also startswith group_by |
- Return
List of Ace objects
Examples
addrgroups()
cisco_acl.addrgroups(config, kwargs) Creates AddrGroup objects based on the “show running-config” output
Parameter |
Type |
Description |
|---|---|---|
config |
str |
Cisco config, “show running-config” output |
platform |
str |
Platform: “ios” (default), “nxos” |
version |
str |
Software version, default is “0”. |
max_ncwb |
int |
Max count of non-contiguous wildcard bits |
indent |
str |
ACE lines indentation (default “ “) |
- Return
List of AddrGroup objects
range_ports()
cisco_acl.range_ports(srcports, dstports, line, platform, port_nr) Generates ACEs in required range of TCP/UDP source/destination ports
Parameter |
Type |
Description |
|---|---|---|
srcports |
str |
Range of TCP/UDP source ports |
dstports |
str |
Range of TCP/UDP destination ports |
line |
str |
ACE pattern, on whose basis new ACEs will be generated (default “permit tcp any any”, operator “eq”) |
platform |
str |
Platform: “ios” (default), “nxos” |
version |
str |
Software version, default is “0”. |
port_nr |
bool |
Well-known TCP/UDP ports as numbers, True - all tcp/udp ports as numbers, False - well-known tcp/udp ports as names (default) |
- Return
List of newly generated ACE lines
Examples
range_protocols()
cisco_acl.range_protocols(protocols, line, platform, protocol_nr) Generates ACEs in required range of IP protocols
Parameter |
Type |
Description |
|---|---|---|
protocols |
str |
Range of IP protocols |
line |
str |
ACE pattern, on whose basis new ACEs will be generated (default “permit ip any any”) |
platform |
str |
Platform: “ios” (default), “nxos” |
version |
str |
Software version, default is “0”. |
protocol_nr |
bool |
Well-known ip protocols as numbers, True - all ip protocols as numbers, False - well-known ip protocols as names (default) |
- Return
List of newly generated ACE lines
Examples
Objects
Documentation of objects for deep-code divers
1 maintainer
Metadata
1 maintainer
Release files for cisco-acl 3.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cisco_acl-3.3.5.tar.gz | 48.4 kB | Without provenance | Details |
Release files / cisco_acl-3.3.5.tar.gz
| Download URL | cisco_acl-3.3.5.tar.gz |
|---|---|
| Size | 48.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2cd62dff934777509cd6e916345678f593a3fdaa107d810f51737cfd7f86da20
|
|
BLAKE2b-256 checksum How to use checksums |
dccfd3a2806298a8b90d805e27d4e70fdacd3e8f1782b991cc277c8abd78828b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.8.10
|
Security for cisco-acl 3.3.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
