cisco-config-parse 0.0.5

data/README.md

@@ -0,0 +1,29 @@
+# cisco-config-parse
+
+## What?
+
+cisco-config-parse is a gem that given a Cisco configuration file, parses it to provide an easy breakdown of information for manipulation. For example, you can get the list of interfaces as a hash with relevant details, such as the description on the port, the VLAN configuration, etc. 
+
+## How to use
+
+    require 'cisco-config-parse'
+    parser = CiscoConfigParse.new(IO.readlines("/path/to/file"))
+    # Parse the file
+    parser.parse
+    # Get a hash of the interfaces
+    puts parser.get_interfaces
+    
+    {"FastEthernet0"=>{}, "GigabitEthernet0/1"=>{:description=>"host0119.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, "GigabitEthernet0/2"=>{:description=>"host0120.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, "GigabitEthernet0/3"=>{:description=>"host0123.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, "GigabitEthernet0/4"=>{:description=>"host0124.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, "GigabitEthernet0/5"=>{:description=>"host0127.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, "GigabitEthernet0/6"=>{:description=>"host0128.ilo", :access_vlan=>"21", :bpduguard=>"enable"}, ...[snip]
+
+## Methods
+
+* *parse* - Parses the configuration, required for any other operation
+* *get\_interfaces* - Returns a hash of all interfaces in config along with their details
+* *get\_hostname* - Returns the hostname of the switch
+* *get\_version* - Returns the version of the software running on the switch
+
+## Bugs? Improvements?
+Probably; this does the bare minimum right now (in my case, I wanted to compare the VLANs on all interfaces on two switches. Please do let me know if anything is broken, and as always please do submit pull requests with any improvements. 
+
+### Thanks
+* Half of this code was written by Geoff Garside (https://github.com/geoffgarside), so thanks for letting me take, finish and publish! 

data/lib/cisco-config-parse.rb

@@ -0,0 +1,135 @@
+#!/bin/env ruby
+
+class CiscoConfigParse
+    def initialize(io)
+        @io = io
+    end
+
+    def parse
+        @io.each do |line|
+            if line =~ /^\!$/ or line =~ /^$/ # terminate current block
+                end_config
+                next
+            elsif line =~ /^\!/ # Comment
+                next
+            end
+            parse_config(line)
+        end
+    end
+
+    def get_interfaces
+        return @interfaces
+    end
+
+    def get_vlans
+        return @vlans
+    end
+
+    def get_hostname
+        return @config_hostname
+    end
+
+    def get_version
+        return @software_version
+    end
+
+    private
+    def state
+        @state ||= []
+    end
+    def end_config
+        meth = ['e_config', state].flatten.join('_')
+        send(meth) if respond_to?(meth)
+        state.pop
+    end
+    def parse_config(line)
+        cmd, opts = line.strip.split(' ', 2)
+        meth, opts = meth_and_opts(cmd, opts)
+        send(meth, opts) if respond_to?(meth)
+    end
+    def meth_and_opts(cmd, opts)
+        return negated_meth_and_opts(opts) if cmd =~ /no/
+            [['p_config', state, cmd.gsub('-', '_')].flatten.join('_'), opts]
+    end
+    def negated_meth_and_opts(line)
+        cmd, opts = line.split(' ', 2)
+        [['n_config', state, cmd.gsub('-', '_')].flatten.join('_'), opts]
+    end
+
+    protected
+    def p_config_hostname(str)
+        @config_hostname = str
+    end
+
+    def p_config_version(str)
+        @software_version = str
+    end
+
+    def p_config_vlan(ids)
+        @current_vlan = {:ids => ids}
+    end
+
+    def e_config_vlan
+        @vlans ||= {}
+        @vlans[@current_vlan.delete(:ids)] = @current_vlan
+    end
+
+    def p_config_interface(name)
+        state.push(:interface)
+        @current_interface = {:id => name}
+    end
+
+    def e_config_interface
+        @interfaces ||= {}
+        @interfaces[@current_interface.delete(:id)] = @current_interface
+    end
+
+    def p_config_interface_description(str)
+        @current_interface[:description] = str
+    end
+
+    def p_config_interface_switchport(str)
+        # Parse the switchport string
+        command = str.split(' ', 3)
+        case command[0]
+        when "trunk"
+            # Its a trunk command; continue to figure out what kind
+            if command[1] == "allowed"
+                # allow vlan
+                allowed_type = str.split(' ', 5)
+                # Split up the rest of the string for the list of vlans
+                vlan_list = str.gsub(',',' ').split(' ')
+                if allowed_type[3] == "add" then
+                    @current_interface[:added_allowed_vlans] = vlan_list.slice(4, vlan_list.length)
+                else
+                    @current_interface[:allowed_vlans] = vlan_list.slice(3, vlan_list.length)
+                end
+            end
+        when "access"
+            @current_interface[:access_vlan] = command[2]
+        end
+    end
+
+    def p_config_interface_inherit(str)
+        @current_interface[:inherit] = str
+    end
+
+    def p_config_interface_spanning_tree(str)
+        # Parse the spanning tree config options
+        command = str.split(' ')
+        case command[0]
+        when "port"
+            @current_interface[:spanning_tree_port_type] = command[2]
+        when "guard"
+            @current_interface[:spanning_tree_guard] = command[1]
+        when "bpduguard"
+            @current_interface[:bpduguard] = command[1]
+        end
+    end
+
+    def p_config_interface_channel_group(str)
+        # Is the port in a port channel?
+        @current_interface[:channel_group] = str.split(' ')[0]
+
+    end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: cisco-config-parse
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Laurie Denness
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-28 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: "Parses a cisco config file on disk (probably from a tool such as Rancid) and returns simple hashes of parsed data, for example interfaces, VLANs, software version, hostname. "
+email: laurie@denness.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- lib/cisco-config-parse.rb
+has_rdoc: true
+homepage: https://github.com/lozzd/cisco-config-parse
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cisco-config-parse
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Parses a Cisco config file on disk for easy manipulation of interfaces, VLANs etc.
+test_files: []
+