netconf 0.2.1

data/examples/jnpr/get-inventory-serial-explicit.rb

@@ -0,0 +1,29 @@
+require 'net/netconf/jnpr/serial'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { 
+  :port => '/dev/ttyS4', 
+  :username => "root", :password => "juniper1" 
+}
+
+# we want to mount the USB drive, so we need to explicity
+# do something special when opening the serial console ...
+# therefore, we can *NOT* pass a block directly to new()
+
+dev = Netconf::Serial.new( login )
+dev.open { |con|
+  # login has occurred successfully
+  
+  con.puts 'mount_msdosfs /dev/da1s1 /mnt'  
+  
+  # netconf will be started once block completes
+}
+
+inv = dev.rpc.get_chassis_inventory
+
+binding.pry
+
+dev.close
+
+

data/examples/jnpr/get-inventory-serial.rb

@@ -0,0 +1,29 @@
+require 'net/netconf/jnpr/serial'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+serial_port = '/dev/ttyS4'
+
+login = { 
+  :port => serial_port,
+  :username => "jeremy", :password => "jeremy1" 
+}
+
+puts "Connecting to SERIAL: #{serial_port} ... please wait."
+
+Netconf::Serial.new( login ){ |dev|
+  
+  puts "Connected."
+  puts "Nabbing Inventory ..."
+
+  inv = dev.rpc.get_chassis_inventory      
+  
+  puts "Chassis: " + inv.xpath('chassis/description').text
+  puts "Chassis Serial-Number: " + inv.xpath('chassis/serial-number').text
+  
+  binding.pry
+
+}
+
+
+

data/examples/jnpr/get-inventory-telnet.rb

@@ -0,0 +1,15 @@
+require 'net/netconf/jnpr/telnet'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+
+Netconf::Telnet.new( login ){ |dev|  
+  inv = dev.rpc.get_chassis_inventory    
+  puts "Chassis: " + inv.xpath('chassis/description').text
+  puts "Chassis Serial-Number: " + inv.xpath('chassis/serial-number').text
+  
+  binding.pry
+}
+
+

data/examples/jnpr/get-inventory.rb

@@ -0,0 +1,19 @@
+require 'net/netconf'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => '192.168.10.2', 
+  :username => "jeremy", 
+  :password => "jeremy1" }
+
+Netconf::SSH.new( login ){ |dev|  
+
+  inv = dev.rpc.get_chassis_inventory  
+
+  puts "Chassis: " + inv.xpath('chassis/description').text
+  puts "Chassis Serial-Number: " + inv.xpath('chassis/serial-number').text  
+    
+}
+
+
+

data/examples/jnpr/scp.rb

@@ -0,0 +1,22 @@
+require 'net/netconf'
+require 'net/scp'
+
+login = { :target => 'vsrx', :username => "jeremy" }
+
+file_name = __FILE__  
+
+Netconf::SSH.new( login ){ |dev|  
+
+  inv = dev.rpc.get_chassis_inventory  
+
+  puts "Chassis: " + inv.xpath('chassis/description').text
+  puts "Chassis Serial-Number: " + inv.xpath('chassis/serial-number').text  
+    
+  puts "Copying file #{file_name} to home directory ..."  
+  dev.scp.upload! file_name, file_name
+ 
+  puts "Copying latest config file from target to local machine ..."
+  
+  dev.scp.download! "/config/juniper.conf.gz", "/var/tmp/config.gz"
+}
+

data/lib/net/netconf.rb

@@ -0,0 +1,14 @@
+
+require 'nokogiri'
+
+require 'net/netconf/rpc'
+require 'net/netconf/exception'         
+require 'net/netconf/transport'
+require 'net/netconf/ssh'
+
+module Netconf  
+  VERSION = "0.2.1"   
+  DEFAULT_OS_TYPE = :JUNOS  
+  DEFAULT_TIMEOUT = 10
+  DEFAULT_WAITIO = 0
+end

data/lib/net/netconf/exception.rb

@@ -0,0 +1,38 @@
+module Netconf
+  
+  class InitError < StandardError
+  end
+  
+  class StateError < StandardError
+  end
+  
+  class OpenError < StandardError
+  end
+  
+  class RpcError < StandardError
+    attr_reader :trans
+    attr_reader :cmd, :rsp
+    
+    def initialize( trans, cmd, rsp )
+      @trans = trans
+      @cmd = cmd; @rsp = rsp; 
+    end
+    
+    def to_s
+      "RPC command error: #{cmd.first_element_child.name}"
+    end
+  end
+  
+  class EditError < Netconf::RpcError
+  end
+  
+  class LockError < Netconf::RpcError
+  end
+  
+  class CommitError < Netconf::RpcError
+  end
+  
+  class ValidateError < Netconf::RpcError
+  end
+
+end

data/lib/net/netconf/jnpr.rb

@@ -0,0 +1,8 @@
+require 'net/netconf'
+require 'net/netconf/jnpr/rpc'
+
+module Netconf::JUNOS
+  NETCONF_CLI = "junoscript netconf need-trailer"
+  NETCONF_SHELL = "exec xml-mode netconf need-trailer"
+end
+  

data/lib/net/netconf/jnpr/rpc.rb

@@ -0,0 +1,134 @@
+## -----------------------------------------------------------------------
+## This file contains the Junos specific RPC methods that are generated 
+## specifically and different as generated by the Netconf::RPC::Builder 
+## module.  These are specifically the following:
+##
+##   get_configuration      - alternative NETCONF: 'get-config'
+##   load_configuration     - alternative NETCONF: 'edit-config'
+##   lock_configuration     - alternative NETCONF: 'lock'
+##   commit_configuration   - alternative NETCONF: 'commit'
+##
+## note: unlock_configuration is not included in this file since
+##       the Netconf::RPC::Builder works "as-is" in this case
+## -----------------------------------------------------------------------
+
+module Netconf
+  module RPC
+    module JUNOS            
+      
+      def lock_configuration
+        lock( 'candidate' )
+      end      
+      
+      def check_configuration
+        validate( 'candidate' )
+      end            
+      
+      def commit_configuration( params = nil, attrs = nil )
+        rpc = Netconf::RPC::Builder.commit_configuration( params, attrs )
+        Netconf::RPC.set_exception( rpc, Netconf::CommitError )
+        @trans.rpc_exec( rpc )   
+      end
+
+      def get_configuration( *args )
+              
+        filter = nil
+        
+        while arg = args.shift
+          case arg.class.to_s
+          when /^Nokogiri/ 
+            filter = case arg
+              when Nokogiri::XML::Builder  then arg.doc.root
+              when Nokogiri::XML::Document then arg.root
+              else arg
+              end            
+          when 'Hash' then attrs = arg
+          end
+        end
+
+        rpc = Nokogiri::XML('<rpc><get-configuration/></rpc>').root
+        Netconf::RPC.add_attributes( rpc.first_element_child, attrs ) if attrs            
+        
+        if block_given?
+          Nokogiri::XML::Builder.with(rpc.at( 'get-configuration' )){ |xml|
+            xml.configuration {
+              yield( xml )
+          }}
+        elsif filter
+          f_node = Nokogiri::XML::Node.new( 'configuration', rpc )
+          f_node << filter.dup                    # *MUST* use the .dup so we don't disrupt the original filter
+          rpc.first_element_child << f_node
+        end
+               
+        @trans.rpc_exec( rpc )
+      end
+      
+      def load_configuration( *args )
+                
+        config = nil
+        
+        # default format is XML
+        attrs = { :format => 'xml' }
+        
+        while arg = args.shift
+          case arg.class.to_s
+          when /^Nokogiri/ 
+            config = case arg
+              when Nokogiri::XML::Builder  then arg.doc.root
+              when Nokogiri::XML::Document then arg.root
+              else arg
+              end                
+          when 'Hash' then attrs = arg
+          when 'Array' then config = arg.join("\n")
+          when 'String' then config = arg
+          end
+        end
+        
+        case attrs[:format]
+        when 'set'
+          toplevel = 'configuration-set'
+          attrs[:format] = 'text'
+          attrs[:action] = 'set'          
+        when 'text'
+          toplevel = 'configuration-text'          
+        when 'xml'
+          toplevel = 'configuration'          
+        end
+                        
+        rpc = Nokogiri::XML('<rpc><load-configuration/></rpc>').root
+        ld_cfg = rpc.first_element_child
+        Netconf::RPC.add_attributes( ld_cfg, attrs ) if attrs   
+        
+        if block_given?
+          if attrs[:format] == 'xml'
+            Nokogiri::XML::Builder.with( ld_cfg ){ |xml|
+              xml.send( toplevel ) {
+                yield( xml )
+            }} 
+          else
+            config = yield  # returns String | Array(of stringable)            
+            config = config.join("\n") if config.class == Array  
+          end
+        end
+        
+        if config
+          c_node = Nokogiri::XML::Node.new( toplevel, rpc )
+          if attrs[:format] == 'xml'
+            c_node << config.dup        # duplicate the config so as to not distrupt it            
+          else
+            # config is stringy, so just add it as the text node
+            c_node.content = config
+          end
+          ld_cfg << c_node
+        end
+                                           
+        # set a specific exception class on this RPC so it can be
+        # properlly handled by the calling enviornment
+        
+        Netconf::RPC::set_exception( rpc, Netconf::EditError )    
+        @trans.rpc_exec( rpc )
+      end      
+            
+    end # module: JUNOS    
+  end # module: RPC
+end # module: Netconf

data/lib/net/netconf/jnpr/serial.rb

@@ -0,0 +1,17 @@
+require 'net/netconf'
+require 'net/netconf/serial'
+require 'net/netconf/jnpr'
+
+module Netconf
+  module TransSerial
+    module JUNOS      
+      
+      def trans_start_netconf( last_console )
+        last_console.match(/[^%]\s+$/)
+        netconf_cmd = ($1 == '%') ? Netconf::JUNOS::NETCONF_SHELL : Netconf::JUNOS::NETCONF_CLI
+        puts netconf_cmd
+      end
+      
+    end      
+  end
+end

data/lib/net/netconf/jnpr/telnet.rb

@@ -0,0 +1,23 @@
+require 'net/netconf'
+require 'net/netconf/telnet'
+require 'net/netconf/jnpr'
+
+module Netconf
+  module TransTelnet
+    module JUNOS
+      
+      def trans_login
+        l_rsp = @trans.login( @args[:username], @args[:password] )
+        # @@@/JLS: need to rescue the timeout ... ???      
+        l_rsp.match("([>%])\s+$")
+        @exec_netconf = ($1 == '%') ? Netconf::JUNOS::NETCONF_SHELL : Netconf::JUNOS::NETCONF_CLI
+      end
+      
+      def trans_start_netconf
+        @trans.puts @exec_netconf
+      end
+      
+    end
+  end  
+end    
+

data/lib/net/netconf/localhost.rb

@@ -0,0 +1,9 @@
+module Netconf
+  module NcDevice
+    class Localhost
+      def initialize( opt_hash )
+        puts "This is a localhost"
+      end
+    end
+  end
+end

data/lib/net/netconf/rpc.rb

@@ -0,0 +1,71 @@
+require 'net/netconf/rpc_std'
+
+module Netconf  
+  module RPC    
+    
+    def RPC.add_attributes( ele_nx, attr_h )
+      attr_h.each{ |k,v| ele_nx[k] = v }      
+    end
+    
+    def RPC.set_exception( rpc_nx, exception )
+      rpc_nx.instance_variable_set(:@netconf_exception, exception )
+    end
+    
+    def RPC.get_exception( rpc_nx )
+      rpc_nx.instance_variable_get(:@netconf_exception) || Netconf::RpcError
+    end
+    
+    module Builder      
+      # autogenerate an <rpc>, converting underscores (_)
+      # to hyphens (-) along the way ...
+      
+      def Builder.method_missing( method, params = nil, attrs = nil )    
+        
+        rpc_name = method.to_s.tr('_','-').to_sym        
+
+        if params
+          # build the XML starting at <rpc>, envelope the <method> toplevel element,
+          # and then create name/value elements for each of the additional params.  An element
+          # without a value should simply be set to true          
+          rpc_nx = Nokogiri::XML::Builder.new { |xml|
+            xml.rpc { xml.send( rpc_name ) {
+              params.each{ |k,v|
+                sym = k.to_s.tr('_','-').to_sym
+                xml.send(sym, (v==true) ? nil : v )
+              }
+            }}
+          }.doc.root
+        else
+          # -- no params 
+          rpc_nx = Nokogiri::XML("<rpc><#{rpc_name}/></rpc>").root
+        end
+        
+        # if a block is given it is used to set the attributes of the toplevel element         
+        RPC.add_attributes( rpc_nx.at( rpc_name ), attrs ) if attrs      
+        
+        # return the rpc command
+        rpc_nx               
+      end # def: method-missing?            
+      
+    end # module: Builder      
+    
+    class Executor
+      include Netconf::RPC::Standard
+      
+      def initialize( trans, os_type )
+        @trans = trans
+        begin  
+          extend Netconf::RPC::const_get( os_type )                
+        rescue NameError
+          # no extensions available ...
+        end        
+      end
+      
+      def method_missing( method, params = nil, attrs = nil )
+        @trans.rpc_exec( Netconf::RPC::Builder.send( method, params, attrs ))
+      end        
+    end # class: Executor
+    
+  end # module: RPC
+end # module: Netconf
+