cisco-config-parser 2.0__tar.gz → 2.2__tar.gz

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cisco_config_parser
-Version: 2.0
+Version: 2.2
 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
@@ -12,7 +12,89 @@ Description-Content-Type: text/markdown
 ## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
 
-# New Features
+# New Version 2.0 
+
+## 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**:
+```
+
+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,9 +102,12 @@ Description-Content-Type: text/markdown
 - platform agnostic 
 - able to set custom regex and create dynamic method 
 
+
 * Example: 
 
 ```python
+from cisco_config_parser import ConfigParser
+
 l3_intf = ConfigParser(res)
 l3 = l3_intf.get_l3_interfaces(ip_pim="ip pim *",  ospf="ip ospf.*")
 
@@ -51,12 +136,20 @@ None
 <hr>
 <hr>
 
+# 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 
+
 * to use file, use `ConfigParser(method="file", content=<your_file>, json=True/False)`. 
 * to use SSH:
-```ruby
-ConfigParser(
+
+
+```python
+from cisco_config_parser import ConfigParserOld
+
+
+
+ConfigParserOld(
     method="int_ssh",
     ssh=True, 
     user="username", 
@@ -112,7 +205,8 @@ parse.find_parent_child("^.*Loopback")
 
 
 ```ruby
->>> nxos_parser = ConfigParser(method="file", content=file1)
+
+>>> nxos_parser = ConfigParserOld(method="file", content=file1)
 >>> vlan_info = nxos_parser.nxos_get_vlan_info()
 >>> vlan_info.vlan = "2626"
 >>> print(vlan_info.vlan)
@@ -149,11 +243,11 @@ evpn
 
 ```ruby 
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 my_file = "running-config.txt"
 
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 obj = parser.ios_get_routed_port()
 
@@ -191,11 +285,11 @@ there are two different mode on switchport, `access` and `trunk`. you should spe
 
 ```ruby
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 my_file = "switch01_run_config.txt"
 
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 obj = parser.ios_get_switchport(mode="access")
 
@@ -229,11 +323,11 @@ Voice  vlan 700
 
 * Finding Routing Protocol
 ```ruby
-    from cisco_config_parser import ConfigParser
+    from cisco_config_parser import ConfigParserOld
     
     
     my_file = "switch01_running_config.txt"
-    parse = ConfigParser(method="file", content=my_file)
+    parse = ConfigParserOld(method="file", content=my_file)
     
     
     obj_list = parse.find_parent_child("^router")
@@ -271,11 +365,11 @@ Voice  vlan 700
  * Finding Interface and Helper address Example 
 
 ```ruby
-    from cisco_config_parser import ConfigParser
+    from cisco_config_parser import ConfigParserOld
 
 
     my_file = "switch01_running_config.txt"
-    parse = ConfigParser(method="file", content=my_file)
+    parse = ConfigParserOld(method="file", content=my_file)
     obj_list = parse.find_parent_child("^interface")
 
     for i in obj_list:
@@ -298,12 +392,12 @@ interface Vlan200
 
 ```ruby 
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 
 
 my_file = "switch_01-run_config.txt"
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 res = parser.ios_get_svi_objects()
 

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/README.md

@@ -2,7 +2,89 @@
 ## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
 
-# New Features
+# New Version 2.0 
+
+## 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**:
+```
+
+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,9 +92,12 @@
 - platform agnostic 
 - able to set custom regex and create dynamic method 
 
+
 * Example: 
 
 ```python
+from cisco_config_parser import ConfigParser
+
 l3_intf = ConfigParser(res)
 l3 = l3_intf.get_l3_interfaces(ip_pim="ip pim *",  ospf="ip ospf.*")
 
@@ -41,12 +126,20 @@ None
 <hr>
 <hr>
 
+# 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 
+
 * to use file, use `ConfigParser(method="file", content=<your_file>, json=True/False)`. 
 * to use SSH:
-```ruby
-ConfigParser(
+
+
+```python
+from cisco_config_parser import ConfigParserOld
+
+
+
+ConfigParserOld(
     method="int_ssh",
     ssh=True, 
     user="username", 
@@ -102,7 +195,8 @@ parse.find_parent_child("^.*Loopback")
 
 
 ```ruby
->>> nxos_parser = ConfigParser(method="file", content=file1)
+
+>>> nxos_parser = ConfigParserOld(method="file", content=file1)
 >>> vlan_info = nxos_parser.nxos_get_vlan_info()
 >>> vlan_info.vlan = "2626"
 >>> print(vlan_info.vlan)
@@ -139,11 +233,11 @@ evpn
 
 ```ruby 
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 my_file = "running-config.txt"
 
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 obj = parser.ios_get_routed_port()
 
@@ -181,11 +275,11 @@ there are two different mode on switchport, `access` and `trunk`. you should spe
 
 ```ruby
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 my_file = "switch01_run_config.txt"
 
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 obj = parser.ios_get_switchport(mode="access")
 
@@ -219,11 +313,11 @@ Voice  vlan 700
 
 * Finding Routing Protocol
 ```ruby
-    from cisco_config_parser import ConfigParser
+    from cisco_config_parser import ConfigParserOld
     
     
     my_file = "switch01_running_config.txt"
-    parse = ConfigParser(method="file", content=my_file)
+    parse = ConfigParserOld(method="file", content=my_file)
     
     
     obj_list = parse.find_parent_child("^router")
@@ -261,11 +355,11 @@ Voice  vlan 700
  * Finding Interface and Helper address Example 
 
 ```ruby
-    from cisco_config_parser import ConfigParser
+    from cisco_config_parser import ConfigParserOld
 
 
     my_file = "switch01_running_config.txt"
-    parse = ConfigParser(method="file", content=my_file)
+    parse = ConfigParserOld(method="file", content=my_file)
     obj_list = parse.find_parent_child("^interface")
 
     for i in obj_list:
@@ -288,12 +382,12 @@ interface Vlan200
 
 ```ruby 
 
-from cisco_config_parser import ConfigParser
+from cisco_config_parser import ConfigParserOld
 
 
 
 my_file = "switch_01-run_config.txt"
-parser = ConfigParser(method="file", content=my_file)
+parser = ConfigParserOld(method="file", content=my_file)
 
 res = parser.ios_get_svi_objects()
 

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/cisco_config_parser/__init__.py

@@ -1,8 +1,9 @@
-from .cisco_config_parser import ConfigParser
+from .cisco_config_parser import ConfigParser, ConfigParserOld
 
 
 _ALL_ = [
     "ConfigParser"
+    "ConfigParserOld",
 ]
 
 __version__ = "1.4.6"

cisco_config_parser-2.2/cisco_config_parser/cisco_config_parser.py

@@ -0,0 +1,3 @@
+
+from .parser import ConfigParser
+from .parser import ConfigParserOld

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/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/cisco_config_parser/helper/help.py

@@ -0,0 +1,73 @@
+
+
+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)
+
+"""

cisco_config_parser-2.2/cisco_config_parser/helper/helper.py

@@ -0,0 +1,23 @@
+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 "L3 Interface Usage"
+
+
+
+
+
+

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/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.0 → cisco_config_parser-2.2}/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.0 → cisco_config_parser-2.2}/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.2/cisco_config_parser/old_version/__init__.py

@@ -0,0 +1,4 @@
+from .utils import  *
+from .exceptions import *
+from .obj import *
+from .old_parse import *

{cisco_config_parser-2.0 → cisco_config_parser-2.2}/cisco_config_parser/old_version/utils.py

@@ -3,7 +3,7 @@ from .ssh import *
 from .old_parse import *
 
 
-class Parser_backup:
+class OldParser:
     """
     - Example: Finding Routing Protocol
     my_file = "switch01_running_config.txt"