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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: cisco_config_parser
-Version: 2.2
-Summary: This Package Will Parse Cisco IOS, IOS-XE, IOS-XR and NXOS Configuration File.
+Version: 2.2.2
+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
@@ -9,15 +9,28 @@ 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
+```
 
-# New Version 2.0 
 
 ## Classes in this library
 
 ```python
-IOSRouteParser
+IOSStaticRouteConfig
+IOSOSPFConfig
+IOSEIGRPConfig
+IOSBGPConfig
+IOSBGPConfig
 L3InterfaceParser
 L2InterfaceParser
 ParentChildParser
@@ -29,7 +42,7 @@ there more Classes are being built, and will be released in the upcoming version
 ```python
 from cisco_config_parser.helper import helper 
 
-helper = helper.IOSRouteParser()
+helper = helper.IOSStaticRouteConfig()
 
 print(helper)
 ```
@@ -46,56 +59,11 @@ with open("show_run.txt", "r") as file_output:
 
 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)
-
+obj.get_static_routes() << Returns a list of objects
+obj.get_static_routes(return_json=True) << Returns a list of dictionaries 
 
 ```
 
-
-
-
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
 - methods are unified 
@@ -103,7 +71,7 @@ for i in eigrp:
 - able to set custom regex and create dynamic method 
 
 
-* Example: 
+* L3Interface Example: 
 
 ```python
 from cisco_config_parser import ConfigParser
@@ -136,7 +104,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 
 
@@ -169,14 +137,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.2 → cisco_config_parser-2.2.2}/README.md

@@ -1,13 +1,26 @@
 # 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
+```
 
-# New Version 2.0 
 
 ## Classes in this library
 
 ```python
-IOSRouteParser
+IOSStaticRouteConfig
+IOSOSPFConfig
+IOSEIGRPConfig
+IOSBGPConfig
+IOSBGPConfig
 L3InterfaceParser
 L2InterfaceParser
 ParentChildParser
@@ -19,7 +32,7 @@ there more Classes are being built, and will be released in the upcoming version
 ```python
 from cisco_config_parser.helper import helper 
 
-helper = helper.IOSRouteParser()
+helper = helper.IOSStaticRouteConfig()
 
 print(helper)
 ```
@@ -36,56 +49,11 @@ with open("show_run.txt", "r") as file_output:
 
 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)
-
+obj.get_static_routes() << Returns a list of objects
+obj.get_static_routes(return_json=True) << Returns a list of dictionaries 
 
 ```
 
-
-
-
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
 - methods are unified 
@@ -93,7 +61,7 @@ for i in eigrp:
 - able to set custom regex and create dynamic method 
 
 
-* Example: 
+* L3Interface Example: 
 
 ```python
 from cisco_config_parser import ConfigParser
@@ -126,7 +94,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 
 
@@ -159,14 +127,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.2.2/cisco_config_parser/helper/help.py

@@ -0,0 +1,164 @@
+
+
+RTP_IOS_STATIC_HELP = """
+
+Example Usage For Static Routes:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+# Return it as a json object
+obj.get_static_routes(return_json=True)
+
+# or as a list of StaticRoute objects
+obj.get_static_routes()
+"""
+
+
+RTP_IOS_OSPF_HELP = """
+
+Example Usage For OSPF Routes:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+# Return it as a json object
+ospf = obj.get_ospf_config(return_json=True)
+
+# or as a list of OSPFConfig objects
+ospf = obj.get_ospf_config()
+for i in ospf:
+    print(i.children)
+    print(i.network)
+    print(i.no_passive_interface)
+
+"""
+RTP_IOS_EIGRP_HELP = """
+
+Example Usage For EIGRP Routes:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+# Return it as a json object
+eigrp = obj.get_eigrp_config(return_json=True)
+
+# or as a list of EIGRPConfig objects
+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)
+"""
+
+
+RTP_IOS_BGP_HELP = """
+
+Example Usage For BGP Routes:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+# Return it as a json object
+bgp = obj.get_bgp_config(return_json=True)
+
+
+# or as a list of BGPConfig objects
+bgp = obj.get_bgp_config()
+for i in bgp:
+    print(i.children)
+    print(i.network)
+    print(i.vrf_children) << returns a list of BGPVrfChildren objects
+    vrf_children = i.vrf_children
+    for vrf in vrf_children:
+        print(vrf.network)
+        print(vrf.children)
+"""
+
+PARENT_CHILD_HELP = """
+
+Example Usage For Parent Child:
+====================================================================================================
+
+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 For Layer3 Interfaces:
+====================================================================================================
+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 For Layer2 Interfaces:
+====================================================================================================
+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.2/cisco_config_parser/helper/helper.py

@@ -0,0 +1,38 @@
+from .help import *
+
+
+class IOSStaticRouteConfig:
+    def __repr__(self):
+        return RTP_IOS_STATIC_HELP
+
+class IOSOSPFConfig:
+    def __repr__(self):
+        return RTP_IOS_OSPF_HELP
+
+
+class IOSEIGRPConfig:
+    def __repr__(self):
+        return RTP_IOS_EIGRP_HELP
+
+class IOSBGPConfig:
+    def __repr__(self):
+        return RTP_IOS_BGP_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.2 → cisco_config_parser-2.2.2}/cisco_config_parser/parser/__init__.py

@@ -32,6 +32,15 @@ class ConfigParser(Parser):
         return self._get_eigrp_config(return_json=return_json)
 
 
+    def get_bgp_config(self, return_json=False):
+        """
+        Get the eigrp configuration from the config file
+        :return: list of eigrp objects or json
+        """
+        return self._get_bgp_config(return_json=return_json)
+
+
+
     def get_vlan_info(self):
         """
         Get the vlan information from the config file

{cisco_config_parser-2.2 → cisco_config_parser-2.2.2}/cisco_config_parser/parser/parser.py

@@ -2,7 +2,12 @@ from cisco_config_parser.layer3_interface import L3InterfaceParser
 from cisco_config_parser.layer2_interface import L2InterfaceParser
 from cisco_config_parser.parent_child import ParentChildParser
 from cisco_config_parser.global_search import GlobalParser
-from cisco_config_parser.routing_protocol.rtp_ios_parser import IOSRouteParser
+from cisco_config_parser.routing_protocol.ios.rtp_ospf import IOSOSPFConfig
+from cisco_config_parser.routing_protocol.ios.rtp_eigtp import IOSEIGRPConfig
+from cisco_config_parser.routing_protocol.ios.rtp_static import IOSStaticRouteConfig
+from cisco_config_parser.routing_protocol.ios.rtp_bgp import IOSBGPConfig
+
+
 from cisco_config_parser.parser_regex.regex import *
 
 
@@ -14,11 +19,10 @@ class Parser:
         self._l2_parser_obj = L2InterfaceParser(self._content)
         self._parent_child_parser_obj = ParentChildParser(self._content)
         self._global_parser_obj = GlobalParser(self._content)
-        self._routing_protocol_parser_obj = IOSRouteParser(self._content)
 
 
 
-    def determine_platform(self):
+    def determine_platform(self, TARGET_CLASS):
         """
         Determine the platform of the device
         IOS, NXOS, IOSXR
@@ -29,7 +33,7 @@ class Parser:
         """
 
         if IOS_PLATFORM_REGEX_1.search(self._content):
-            return IOSRouteParser
+            return TARGET_CLASS
 
         elif NXOS_PLATFORM_REGEX_1.search(self._content) or NXOS_PLATFORM_REGEX_2.search(self._content):
             return "NXOS"
@@ -57,12 +61,12 @@ class Parser:
             if user provides the platform, then use the platform to fetch the static routes
             """
             if "ios" in self._platform.lower():
-                return self._routing_protocol_parser_obj._fetch_static_route_config(return_json=return_json)
+                return IOSStaticRouteConfig(self._content)._fetch_static_route_config(return_json=return_json)
 
         """
         if platform is not provided, then use internal logic to determine the platform
         """
-        relevant_object = self.determine_platform()
+        relevant_object = self.determine_platform(IOSStaticRouteConfig)
         return relevant_object(self._content)._fetch_static_route_config(return_json=return_json)
 
 
@@ -76,12 +80,12 @@ class Parser:
             if user provides the platform, then use the platform to fetch the static routes
             """
             if "ios" in self._platform.lower():
-                return self._routing_protocol_parser_obj._fetch_ospf_config(return_json=return_json)
+                return IOSOSPFConfig(self._content)._fetch_ospf_config(return_json=return_json)
 
         """
         if platform is not provided, then use internal logic to determine the platform
         """
-        relevant_object = self.determine_platform()
+        relevant_object = self.determine_platform(IOSOSPFConfig)
         return relevant_object(self._content)._fetch_ospf_config(return_json=return_json)
 
 
@@ -96,15 +100,35 @@ class Parser:
             if user provides the platform, then use the platform to fetch the static routes
             """
             if "ios" in self._platform.lower():
-                return self._routing_protocol_parser_obj._fetch_eigrp_config(return_json=return_json)
+                return IOSEIGRPConfig(self._content)._fetch_eigrp_config(return_json=return_json)
 
         """
         if platform is not provided, then use internal logic to determine the platform
         """
-        relevant_object = self.determine_platform()
+        relevant_object = self.determine_platform(IOSEIGRPConfig)
         return relevant_object(self._content)._fetch_eigrp_config(return_json=return_json)
 
 
+    def _get_bgp_config(self, return_json=False):
+        """
+        Get the static routes from the config file
+        :return: list of static route objects
+        """
+        if self._platform:
+            """
+            if user provides the platform, then use the platform to fetch the static routes
+            """
+            if "ios" in self._platform.lower():
+                return IOSBGPConfig(self._content)._fetch_bgp_config(return_json=return_json)
+
+        """
+        if platform is not provided, then use internal logic to determine the platform
+        """
+        relevant_object = self.determine_platform(IOSBGPConfig)
+        return relevant_object(self._content)._fetch_bgp_config(return_json=return_json)
+
+
+
 
     def _get_vlan_info(self):
         """

{cisco_config_parser-2.2 → cisco_config_parser-2.2.2}/cisco_config_parser/parser_regex/regex.py

@@ -61,8 +61,6 @@ VLAN_REGEX = re.compile(r"^vlan\s([0-9]+)", flags=re.MULTILINE)
 
 # Routing Protocol
 RTP_REGEX = re.compile(r"^router\s(.*)", flags=re.MULTILINE)
-
-RTP_BGP_REGEX = re.compile(r"^router bgp", flags=re.MULTILINE)
 RTP_ISIS_REGEX = re.compile(r"^router isis", flags=re.MULTILINE)
 RTP_RIP_REGEX = re.compile(r"^router rip", flags=re.MULTILINE)
 
@@ -99,6 +97,31 @@ RTP_EIGRP_REGEX = re.compile(r"^router eigrp", flags=re.MULTILINE)
 RTP_IOS_EIGRP_VRF_REGEX = re.compile(r"\s+address-family\sipv4\svrf\s(\S+)", flags=re.MULTILINE)
 RTP_IOS_EIGRP_NETWORK_REGEX = re.compile(r"\s+network\s(\d+\.\d+\.\d+\.\d+)\s(\d+\.\d+\.\d+\.\d+)", flags=re.MULTILINE)
 
+# IOS ROUTING PROTOCOL - BGP
+RTP_BGP_REGEX = re.compile(r"^router bgp", flags=re.MULTILINE)
+RTP_BGP_ROUTER_ID_REGEX = re.compile(r"\s+bgp\srouter-id\s(\d+\.\d+\.\d+\.\d+)", flags=re.MULTILINE)
+RTP_IOS_BGP_VRF_REGEX = re.compile(r"\s+address-family\sipv4\svrf\s(\S+)", flags=re.MULTILINE)
+RTP_IOS_BGP_NETWORK_REGEX = re.compile(r"\s+network\s(\d+\.\d+\.\d+\.\d+)\smask\s(\d+\.\d+\.\d+\.\d+)", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_IP_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\s(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_REMOTE_AS_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\sremote-as\s(\d+)", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_DESCR_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\sdescription\s(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_UPDATE_SRC_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\supdate-source\s(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_RM_INBOUND_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\sroute-map\s(.*)\sin", flags=re.MULTILINE)
+RTP_IOS_BGP_NEIGHBOR_RM_OUTBOUND_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\sroute-map\s(.*)\sout", flags=re.MULTILINE)
+
+RTP_IOS_BGP_PEER_GROUP_REGEX = re.compile(r"\s+neighbor\s(\S+)\speer-group$", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_REMOTE_AS_REGEX = re.compile(r"\s+neighbor\s(.*)\sremote-as\s(\S+)", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_UPDATE_SRC_REGEX = re.compile(r"\s+neighbor\s(.*)\supdate-source\s(\S+)", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_RM_IN_REGEX = re.compile(r"\s+neighbor\s(.*)\sroute-map\s(\S+)\sin", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_RM_OUT_REGEX = re.compile(r"\s+neighbor\s(.*)\sroute-map\s(\S+)\sout", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_NEIGHBOR_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\speer-group(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_PG_NEIGHBOR_DESCR_REGEX = re.compile(r"\s+neighbor\s(\d+\.\d+\.\d+\.\d+)\sdescription(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_GLOBAL_IPV4_REGEX = re.compile(r"\s+address-family\sipv4$", flags=re.MULTILINE)
+
+RTP_IOS_BGP_REDISTRIBUTE_REGEX = re.compile(r"\s+(redistribute\s.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_REDISTRIBUTE_W_RM_REGEX = re.compile(r"redistribute\s(\S+\s\S+|\S+)\s+route-map(.*)", flags=re.MULTILINE)
+RTP_IOS_BGP_REDISTRIBUTE_WO_RM_REGEX = re.compile(r"redistribute\s(\S+\s\S+|\S+)$", flags=re.MULTILINE)
+
 
 
 def find_vrf_section(vrf, item):

cisco_config_parser-2.2.2/cisco_config_parser/routing_protocol/__init__.py

@@ -0,0 +1,5 @@
+from cisco_config_parser.routing_protocol.utils.rtp_separator import IOSRoutingProtocolSeparator
+from .utils import *
+from .ios import *
+from .nxos import *
+from .xr import *

cisco_config_parser-2.2.2/cisco_config_parser/routing_protocol/ios/__init__.py

@@ -0,0 +1,6 @@
+
+from .rtp_bgp import *
+from .rtp_eigtp import *
+from .rtp_ospf import *
+from .rtp_static import *
+from .rtp_ios_rtp_obj import *