net-ops 0.0.5.pre → 0.0.6.pre

data/regexs.yml

@@ -0,0 +1,12 @@
+cisco:
+  interfaces:
+    status:
+      regex: >
+        (?<short_type>Fa|Gi|Te)
+        (?<port_number>\d+\/\d+(\/\d+)?)\s+
+        (?<description>.+)?\s+
+        (?<status>connected|notconnect|disabled|err-disabled)\s+
+        (?<vlan>\w+|\d+)\s+
+        (?<duplex>auto|(a-)?full)\s+
+        (?<speed>auto|a-1000|10G)\s+
+        (?<type>.+)

data/tasks/downcase_hostname_task.rb

@@ -0,0 +1,144 @@
+# Task for converting hostname to lowercase.
+# Handle devices with SSH by regenerating crypto key.
+
+require '../lib/net/ops'
+
+class DowncaseHostnameTask < Net::Ops::Task
+
+  def initialize(host, options, credentials)
+    @host        = host
+    @options     = options
+    @credentials = credentials
+
+    @session = Session.new(host, options)
+
+    super(host)
+  end
+
+  # This is where all the logic is.
+  def work
+  
+    # First we need to open the session.
+    # I create a helper because we will have to
+    # (dis)connect several times during this task.
+    connect
+
+    # Set terminal length to 0 otherwise too long outputs will cause
+    # Net::Telnet to timeout while waiting for the prompt.
+    @session.privileged { set 'terminal length', 0 }
+
+    # Check ip http secure-server
+    https = /^ip http secure-server/.match(@session.get('run | i ip http'))
+    
+    # Get hostname from show version.
+    match = /(?<hostname>.+)\s+uptime.+/.match(@session.get('version'))
+
+    # Check if we found the hostname
+    # and convert it if needed.
+    # `match['hostname'].downcase!` return nil
+    # if the hostname is already in lowercase.
+    if !https && match && match['hostname'].downcase!
+    
+      # If we are connected using SSH we enable Telnet
+      # in case bad crypto key prevent us from logging.
+      enable_telnet if ssh?
+      
+      # Convert the hostname
+      info "Converting #{ match['hostname'] } => #{ match['hostname'].downcase }"
+      @session.configuration(:enforce_save) { set 'hostname', match['hostname'].downcase }
+      
+      # If SSH is enabled regenerate crypto key
+      # and verify SSH is still working.
+      if ssh?
+
+        # Delete the existing crypto key
+        # then regenerate it.
+        regenerate_crypto
+        
+        # Close the session and reopen it
+        # to see if we are still able to
+        # connect via SSH.
+        info 'Verifying SSH is still working'
+        reconnect
+        
+        # If SSH is still working we can disable Telnet.
+        if ssh?
+          info 'Hooray SSH is still working !'
+          disable_telnet
+        else warn 'SSH is not working :('
+        end
+        
+      end
+
+    elsif match && !match['hostname'].downcase! then info 'Nothing to do'
+    else error 'Unable to find hostname'; end
+    
+    @session.close
+  end
+  
+  # Below are the helpers methods.
+  # I wrote them to be DRY and reduce code.
+
+  # Open the session and show the transport used.
+  def connect
+    info "Connecting to #{ @host }"
+
+    begin @session.open(@credentials)
+    rescue Exception => e
+      error e.message
+    end
+    
+    info "Transport is #{ @session.transport.class }"
+  end
+  
+  # Alias for session.close
+  def disconnect
+    @session.close
+  end
+  
+  # Disconnect, then reconnect.
+  def reconnect
+    disconnect; connect
+  end
+  
+  # True if the transport it SSH.
+  def ssh?
+    @session.transport.class.to_s.include?('SSH')
+  end
+  
+  # Enable Telnet and SSH on all VTY lines.
+  def enable_telnet
+    info 'Enabling Telnet'
+    
+    @session.configuration(:enforce_save) do
+      lines('vty 0 4')  { set 'transport input', 'ssh telnet' }
+      # lines('vty 5 15') { set 'transport input', 'ssh telnet' }
+    end
+  end
+  
+  # Set SSH only on all VTY lines.
+  def disable_telnet
+    info 'Disabling Telnet'
+    
+    @session.configuration(:enforce_save) do
+      lines('vty 0 4')  { set 'transport input', 'ssh' }
+      # lines('vty 5 15') { set 'transport input', 'ssh' }
+    end
+  end
+  
+  # Delete the crypto key then regenerate it.
+  def regenerate_crypto
+    info 'Regenerate crypto key'
+    
+    @session.configuration(:enforce_save) do
+      zeroize 'crypto key'
+      begin
+        generate 'crypto key', 'rsa general-keys modulus 2048'
+      rescue Exception => e
+        generate 'crypto key', 'rsa modulus 2048'
+      end
+      set 'ip ssh version', 2
+    end
+  end
+
+end

data/tasks/test.rb

@@ -0,0 +1,21 @@
+require './downcase_hostname_task'
+
+hosts = %w( 192.168.0.104 )
+
+credentials = YAML.load_file('credentials.yml')
+
+
+options     = { timeout: 30, prompt: /.+(#|>)/ }
+credentials = { username: credentials.fetch('username'),
+                password: credentials.fetch('username') }
+
+pool = Thread.pool(10)
+
+hosts.each do |host|
+  # pool.process do
+    t = DowncaseHostnameTask.new(host, options, credentials)
+    t.work
+  # end
+end
+
+pool.shutdown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ops
 version: !ruby/object:Gem::Version
-  version: 0.0.5.pre
+  version: 0.0.6.pre
 platform: ruby
 authors:
 - Maxime Mouchet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread
@@ -38,16 +38,61 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Framework to automate daily operations on network devices.
 email:
-- max@maxmouchet.com
+- mouchet.max@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/basic_script.rb
+- examples/commands.txt
+- examples/exec_file.rb
+- examples/hosts.txt
 - lib/net/ops.rb
-- lib/net/transport/ssh.rb
-- lib/net/transport/telnet.rb
+- lib/net/ops/parser.rb
+- lib/net/ops/session.rb
+- lib/net/ops/task.rb
+- lib/net/ops/transport/ssh.rb
+- lib/net/ops/transport/telnet.rb
+- lib/net/ops/version.rb
+- net-ops.gemspec
+- regexs.yml
+- tasks/downcase_hostname_task.rb
+- tasks/test.rb
 homepage: http://github.com/maxmouchet/qscripts
 licenses:
 - MIT

data/lib/net/transport/ssh.rb

@@ -1,39 +0,0 @@
-require 'net/ssh/telnet'
-
-module Net
-  module Ops
-    module Transport
-    
-      #
-      class SSH
-        
-        # Open an SSH session to the specified host using net/ssh/telnet.
-        #
-        # @param host [String] the destination host.
-        # @param options [Hash]
-        # @param credentials [Hash] credentials to use to connect.
-        def self.open(host, options, credentials)
-          session = nil
-
-          ssh = Net::SSH.start(host, credentials[:username], :password => credentials[:password])
-          session = Net::SSH::Telnet.new('Session' => ssh,
-                                         'Timeout' => options[:timeout],
-                                         'Prompt'  => options[:prompt])
-
-        rescue Errno::ECONNREFUSED => e
-          session = nil
-
-        rescue Net::SSH::AuthenticationFailed => e
-          session = nil
-
-        rescue Exception => e
-          session = nil
-
-        return session
-        end
-        
-      end
-    
-    end
-  end
-end

data/lib/net/transport/telnet.rb

@@ -1,53 +0,0 @@
-require 'net/telnet'
-
-module Net
-  module Ops
-    module Transport
-
-      #
-      class Telnet
-
-        # Open a Telnet session to the specified host using net/ssh.
-        #
-        # @param host [String] the destination host.
-        # @param options [Hash]
-        # @param credentials [Hash] credentials to use to connect.
-        def self.open(host, options, credentials)
-          session = nil
-
-          session = Net::Telnet.new('Host' => host,
-                                    'Timeout' => options[:timeout],
-                                    'Prompt'  => options[:prompt])
-
-          output = ''
-          session.cmd('String' => '', 'Match'  => /.+/) { |c| output += c }
-
-          if /[Uu]sername:/.match(output) then
-            session.cmd('String' => credentials[:username],
-                      'Match'  => /.+/)
-            session.cmd(credentials[:password])
-          end
-
-          if /[Pp]assword:/.match(output) then
-            session.cmd(credentials[:password])
-          end
-
-          return session
-
-        rescue Errno::ECONNREFUSED => e
-          session = nil
-
-        rescue Net::OpenTimeout => e
-          session = nil
-
-        rescue Exception => e
-          session = nil
-
-        return session
-        end
-
-      end
-
-    end
-  end
-end