cisco-config-parser 2.1__tar.gz → 2.2.1__tar.gz

cisco_config_parser-2.1/README.md → cisco_config_parser-2.2.1/PKG-INFO

@@ -1,8 +1,106 @@
+Metadata-Version: 2.1
+Name: cisco_config_parser
+Version: 2.2.1
+Summary: This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+Home-page: https://github.com/arezazadeh/cisco_config_parser
+Author: Ahmad Rezazadeh
+Author-email: ahmad@klevernet.io
+License: MIT License
+Description-Content-Type: text/markdown
+
 # Cisco Configuration Parser
-## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
+This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+
+##  New Version 2.0 
+
+## Install the package
+
+https://pypi.org/project/cisco-config-parser/
+
+```bash
+pip install cisco-config-parser
+```
+
+
+## Classes in this library
+
+```python
+IOSRouteParser
+L3InterfaceParser
+L2InterfaceParser
+ParentChildParser
+```
+there more Classes are being built, and will be released in the upcoming versions. 
+
+## Get Example usage:
+
+```python
+from cisco_config_parser.helper import helper 
+
+helper = helper.IOSRouteParser()
+
+print(helper)
+```
+
+**Output**:
+```
 
-# New Version 2.0
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+
+#
+##
+###
+#### Static Routes Example:
+###
+##
+#
+obj.get_static_routes()
+obj.get_static_routes(return_json=True)
+
+
+#
+##
+###
+#### OSPF Example:
+###
+##
+#
+ospf = obj.get_ospf_config(return_json=True)
+ospf = obj.get_ospf_config()
+for i in ospf:
+    print(i.children)
+    print(i.network)
+    print(i.no_passive_interface)
+
+#
+##
+###
+#### EIGRP Example:
+###
+##
+#
+eigrp = obj.get_eigrp_config(return_json=True)
+eigrp = obj.get_eigrp_config()
+for i in eigrp:
+    print(i.children)
+    print(i.network)
+    print(i.vrf_children) << returns a list of EIGRPVrfChildren objects
+    vrf_children = i.vrf_children
+    for vrf in vrf_children:
+        print(vrf.network)
+        print(vrf.children)
+
+
+```
 
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
@@ -10,6 +108,7 @@
 - platform agnostic 
 - able to set custom regex and create dynamic method 
 
+
 * Example: 
 
 ```python
@@ -43,7 +142,7 @@ None
 <hr>
 <hr>
 
-# Old Version < 2.0  
+## Old Version < 2.0  
 
 There are two ways to parse the config, 1, SSH which is not recommended, and 2, feeding the running-config file 
 
@@ -76,14 +175,6 @@ pass the kwargs then it will login to your device and does the `show running-con
 
 **if you select `json=True` then the object will return the result in json format. else, it would return as list of objects.**
 
-## Install the package
-
-https://pypi.org/project/cisco-config-parser/
-
-```ruby
-pip install cisco-config-parser
-```
-
 
 ## Regex Search Strings:
 

cisco_config_parser-2.1/PKG-INFO → cisco_config_parser-2.2.1/README.md

@@ -1,18 +1,96 @@
-Metadata-Version: 2.1
-Name: cisco_config_parser
-Version: 2.1
-Summary: This Package Will Parse Cisco IOS, IOS-XE, IOS-XR and NXOS Configuration File.
-Home-page: https://github.com/arezazadeh/cisco_config_parser
-Author: Ahmad Rezazadeh
-Author-email: ahmad@klevernet.io
-License: MIT License
-Description-Content-Type: text/markdown
-
 # Cisco Configuration Parser
-## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
+This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+
+##  New Version 2.0 
+
+## Install the package
+
+https://pypi.org/project/cisco-config-parser/
+
+```bash
+pip install cisco-config-parser
+```
+
+
+## Classes in this library
+
+```python
+IOSRouteParser
+L3InterfaceParser
+L2InterfaceParser
+ParentChildParser
+```
+there more Classes are being built, and will be released in the upcoming versions. 
+
+## Get Example usage:
+
+```python
+from cisco_config_parser.helper import helper 
+
+helper = helper.IOSRouteParser()
+
+print(helper)
+```
+
+**Output**:
+```
 
-# New Version 2.0
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+
+#
+##
+###
+#### Static Routes Example:
+###
+##
+#
+obj.get_static_routes()
+obj.get_static_routes(return_json=True)
+
+
+#
+##
+###
+#### OSPF Example:
+###
+##
+#
+ospf = obj.get_ospf_config(return_json=True)
+ospf = obj.get_ospf_config()
+for i in ospf:
+    print(i.children)
+    print(i.network)
+    print(i.no_passive_interface)
+
+#
+##
+###
+#### EIGRP Example:
+###
+##
+#
+eigrp = obj.get_eigrp_config(return_json=True)
+eigrp = obj.get_eigrp_config()
+for i in eigrp:
+    print(i.children)
+    print(i.network)
+    print(i.vrf_children) << returns a list of EIGRPVrfChildren objects
+    vrf_children = i.vrf_children
+    for vrf in vrf_children:
+        print(vrf.network)
+        print(vrf.children)
+
+
+```
 
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
@@ -20,6 +98,7 @@ Description-Content-Type: text/markdown
 - platform agnostic 
 - able to set custom regex and create dynamic method 
 
+
 * Example: 
 
 ```python
@@ -53,7 +132,7 @@ None
 <hr>
 <hr>
 
-# Old Version < 2.0  
+## Old Version < 2.0  
 
 There are two ways to parse the config, 1, SSH which is not recommended, and 2, feeding the running-config file 
 
@@ -86,14 +165,6 @@ pass the kwargs then it will login to your device and does the `show running-con
 
 **if you select `json=True` then the object will return the result in json format. else, it would return as list of objects.**
 
-## Install the package
-
-https://pypi.org/project/cisco-config-parser/
-
-```ruby
-pip install cisco-config-parser
-```
-
 
 ## Regex Search Strings:
 

{cisco_config_parser-2.1 → cisco_config_parser-2.2.1}/cisco_config_parser/global_search/global_parser.py

@@ -52,4 +52,6 @@ class GlobalParser:
             ]
             vlan_objects.append(vlan_obj)
 
-        return vlan_objects
+        return vlan_objects
+
+

cisco_config_parser-2.2.1/cisco_config_parser/helper/help.py

@@ -0,0 +1,122 @@
+
+
+RTP_IOS_HELP = """
+
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+
+#
+##
+###
+#### Static Routes Example:
+###
+##
+#
+obj.get_static_routes()
+obj.get_static_routes(return_json=True)
+
+
+#
+##
+###
+#### OSPF Example:
+###
+##
+#
+ospf = obj.get_ospf_config(return_json=True)
+ospf = obj.get_ospf_config()
+for i in ospf:
+    print(i.children)
+    print(i.network)
+    print(i.no_passive_interface)
+
+#
+##
+###
+#### EIGRP Example:
+###
+##
+#
+eigrp = obj.get_eigrp_config(return_json=True)
+eigrp = obj.get_eigrp_config()
+for i in eigrp:
+    print(i.children)
+    print(i.network)
+    print(i.vrf_children) << returns a list of EIGRPVrfChildren objects
+    vrf_children = i.vrf_children
+    for vrf in vrf_children:
+        print(vrf.network)
+        print(vrf.children)
+"""
+PARENT_CHILD_HELP = """
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+parent_child = obj.get_parent_child(custom_regex="(^snmp.*)|(^aaa.*)")
+
+for i in parent_child:
+    print(i.parent)
+    print(i.children)
+
+"""
+LAYER3_INTERFACE_HELP = """
+Example Usage:
+====================================================================================================
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+# returns dictionary of layer3 interfaces
+l3_intfs = obj.get_l3_interface_details()
+
+l3_intfs = obj.get_l3_interface()
+
+for intf in l3_intfs:
+    print(intf.name)
+    print(intf.ip_address)
+    print(intf.children)
+
+
+# you can also search for specific entry under layer3 interface with custom regex
+l3_intfs = obj.get_l3_interface(ip_pim="(ip\spim\s.*)", load_interval="(load\sinterval.*)")
+
+
+for intf in l3_intfs:
+    print(intf.name)
+    print(intf.ip_address)
+    print(intf.ip_pim) <<< dynamically creates an attribute based on the custom regex
+    print(intf.load_interval) <<< dynamically creates an attribute based on the custom regex
+
+"""
+
+LAYER2_INTERFACE_HELP = """
+Example Usage:
+====================================================================================================
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+# returns dictionary of layer2 interfaces
+l2_intfs = obj.get_l2_interface_details()
+
+l2_intfs = obj.get_l2_interface()
+
+for intf in l2_intfs:
+    print(intf.name)
+    print(intf.children)
+
+"""

cisco_config_parser-2.2.1/cisco_config_parser/helper/helper.py

@@ -0,0 +1,26 @@
+from .help import *
+
+
+class IOSRouteParser:
+    def __repr__(self):
+        return RTP_IOS_HELP
+
+
+
+class ParentChild:
+    def __repr__(self):
+        return PARENT_CHILD_HELP
+
+
+class L3Interface:
+    def __repr__(self):
+        return LAYER3_INTERFACE_HELP
+
+
+class L2Interface:
+    def __repr__(self):
+        return LAYER2_INTERFACE_HELP
+
+
+
+

{cisco_config_parser-2.1 → cisco_config_parser-2.2.1}/cisco_config_parser/layer3_interface/l3_interface_obj.py

@@ -32,4 +32,5 @@ class L3Interface:
         """
         If the attribute is not found, return None
         """
-        return None
+        return None
+

{cisco_config_parser-2.1 → cisco_config_parser-2.2.1}/cisco_config_parser/layer3_interface/l3_interface_parser.py

@@ -1,8 +1,13 @@
+import json
+
 from .l3_interface_separator import L3InterfaceSeparator
 from .l3_interface_obj import L3Interface
 from .l3_section_parser import _L3SectionParser
 from cisco_config_parser.parser_regex.regex import *
 from dataclasses import dataclass
+import re, ipaddress
+
+
 
 
 
@@ -65,6 +70,7 @@ class L3InterfaceParser:
             if ip_address_regex:
                 l3_intf_cls = _L3SectionParser._parse_ip_address_line(**ip_address_kwargs)
 
+
             if sec_ip_address_regex:
                 # set the primary flag to False to indicate that the ip address is a secondary ip address
                 ip_address_kwargs["primary"] = False
@@ -102,5 +108,26 @@ class L3InterfaceParser:
         return l3_intf_objects
 
 
+    def _fetch_subnet_and_usage(self, include_subnet_count=False):
+        """
+        Fetch the subnet usage from the config file
+        return: dictionary of subnet usage
+        """
 
+        subnet_usage = {}
+        subnet_count = {}
+        l3_interfaces = self._fetch_l3_interfaces()
+        for i in l3_interfaces:
+            if i.subnet:
+                cidr = str(ipaddress.IPv4Network(i.subnet, strict=False).prefixlen)
+                subnet_usage[i.name] = i.subnet
+                if subnet_count.get(f"/{cidr}"):
+                    subnet_count[f"/{cidr}"] += 1
+                else:
+                    subnet_count[f"/{cidr}"] = 1
+
+        if include_subnet_count:
+            subnet_usage["subnet_count"] = subnet_count
+
+        return subnet_usage
 

{cisco_config_parser-2.1 → cisco_config_parser-2.2.1}/cisco_config_parser/layer3_interface/l3_section_parser.py

@@ -5,6 +5,8 @@ import ipaddress
 
 class _L3SectionParser:
 
+
+
     @classmethod
     def _parse_ip_address_line(cls, **kwargs):
         """
@@ -16,11 +18,34 @@ class _L3SectionParser:
         mask using the ipaddress module
         return: l3_interface_obj
         """
+
+        def process_ip_address_with_cidr(ip_address_with_cidr, obj):
+            """
+            Process the ip address with cidr
+            :param ip_address_with_cidr: str
+            :param obj: L3Interface object
+            :return:
+            """
+            ip_address_config = ip_address_with_cidr.split("/")
+            ip_addr = ip_address_config[0].strip()
+            cidr = ip_address_config[1].strip()
+            subnet_ = ipaddress.IPv4Network(f"{ip_addr}/{cidr}", strict=False)
+            obj.ip_address = ip_addr.strip()
+            obj.mask = str(subnet_.netmask)
+            obj.subnet = str(subnet_).strip()
+            return obj
+
         ip_address_line_regex = kwargs.get("ip_address_line_regex")
         l3_interface_obj = kwargs.get("l3_interface_obj")
         primary = kwargs.get("primary", True)
 
         ip_address_regex = [ip_group for ip_group in ip_address_line_regex.groups() if ip_group]
+
+        # Check if the ip address has a CIDR - 10.1.1.1/24
+        if "/" in ip_address_regex[0]:
+            l3_interface_obj = process_ip_address_with_cidr(ip_address_regex[0], l3_interface_obj)
+            return l3_interface_obj
+
         ip_address_section = ip_address_regex[0].split()
         ip_address = ip_address_section[0].strip()
         mask = ip_address_section[1].strip()

{cisco_config_parser-2.1 → cisco_config_parser-2.2.1}/cisco_config_parser/parser/__init__.py

@@ -4,8 +4,33 @@ from .parser import Parser
 
 
 class ConfigParser(Parser):
-    def __init__(self, _content):
-        super().__init__(_content)
+    def __init__(self, _content, platform=None):
+        super().__init__(_content, platform=platform)
+
+
+    def get_static_config(self, return_json=False):
+        """
+        Get the static routes from the config file
+        :return: list of static route objects
+        """
+        return self._get_static_config(return_json=return_json)
+
+
+    def get_ospf_config(self, return_json=False):
+        """
+        Get the ospf configuration from the config file
+        :return: list of ospf objects or json
+        """
+        return self._get_ospf_config(return_json=return_json)
+
+
+    def get_eigrp_config(self, return_json=False):
+        """
+        Get the eigrp configuration from the config file
+        :return: list of eigrp objects or json
+        """
+        return self._get_eigrp_config(return_json=return_json)
+
 
     def get_vlan_info(self):
         """
@@ -28,6 +53,15 @@ class ConfigParser(Parser):
         """
         return self._get_parent_child(**kwargs)
 
+
+    def get_subnet_and_usage(self, include_subnet_count=False):
+        """
+        Fetch the subnet usage from the config file
+        return: dictionary of subnet usage
+        """
+        return self._get_subnet_and_usage(include_subnet_count=include_subnet_count)
+
+
     def get_l3_interfaces(self, **kwargs):
         """
         Get L3 interfaces from the config file