netconf 0.2.4 → 0.2.5

data/examples/jnpr/edit-config-jnpr.rb

@@ -2,21 +2,32 @@ require 'net/netconf/jnpr'
 
 puts "NETCONF v#{Netconf::VERSION}"
 
-login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+login = { :target => 'ex4', :username => "jeremy", :password => "jeremy1" }
   
-new_host_name = "vsrx-jjj"
+new_host_name = "ex4-abc"
 
 puts "Connecting to device: #{login[:target]}" 
 
 Netconf::SSH.new( login ){ |dev|
   puts "Connected!"
   
+  # when providing a collection of configuration,
+  # you need to include the <configuration> as the 
+  # toplevel element
+  
   location = Nokogiri::XML::Builder.new{ |x| 
-    x.system {
-      x.location {
-        x.building "Main Campus, D"
-        x.floor 22
-        x.rack 38
+    x.configuration {
+      x.system {
+        x.location {
+          x.building "Main Campus, D"
+          x.floor 22
+          x.rack 38
+        }
+      }
+      x.system {
+        x.services {
+          x.ftp;
+        }
       }
     }
   }
@@ -24,7 +35,12 @@ Netconf::SSH.new( login ){ |dev|
   begin
     
     rsp = dev.rpc.lock_configuration
-
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.load_configuration( location,  :action => 'replace' )
+    
     # --------------------------------------------------------------------    
     # configuration as BLOCK
     
@@ -34,10 +50,6 @@ Netconf::SSH.new( login ){ |dev|
       }
     }
     
-    # --------------------------------------------------------------------
-    # configuration as PARAM
-    
-    rsp = dev.rpc.load_configuration( location )
     rpc = dev.rpc.check_configuration
     rpc = dev.rpc.commit_configuration
     rpc = dev.rpc.unlock_configuration

data/examples/jnpr/get-config-jnpr.rb

@@ -2,7 +2,7 @@ require 'net/netconf/jnpr'      # note: including Juniper specific extension
 
 puts "NETCONF v.#{Netconf::VERSION}"
 
-login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+login = { :target => 'ex4', :username => "jeremy", :password => "jeremy1" }
   
 puts "Connecting to device: #{login[:target]}" 
 
@@ -22,6 +22,7 @@ Netconf::SSH.new( login ){ |dev|
   
   cfgsvc1_1 = dev.rpc.get_configuration{ |x|
     x.system { x.services }
+    x.system { x.login }
   }
   
   cfgsvc1_1.xpath('system/services/*').each{|s| puts s.name }
@@ -36,10 +37,12 @@ Netconf::SSH.new( login ){ |dev|
   
   # ----------------------------------------------------------------------
   # specifying a filter as a parameter to get_configuration
+  # you must wrap the config in a toplevel <configuration> element
   
-  filter = Nokogiri::XML::Builder.new{ |x|
+  filter = Nokogiri::XML::Builder.new{ |x| x.configuration {
     x.system { x.services }
-  }
+    x.system { x.login }
+  }}
 
   puts "Retrieved services by PARAM, as XML"  
   

data/lib/net/netconf.rb

@@ -7,11 +7,9 @@ require 'net/netconf/transport'
 require 'net/netconf/ssh'
 
 module Netconf  
-  VERSION = "0.2.4"   
-  
-  NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0"
-  
-  DEFAULT_OS_TYPE = :JUNOS  
+  VERSION = "0.2.5"   
+  NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0"  
+  DEFAULT_OS_TYPE = :Junos  
   DEFAULT_TIMEOUT = 10
   DEFAULT_WAITIO = 0
 end

data/lib/net/netconf/ioproc.rb

@@ -0,0 +1,88 @@
+module Netconf
+  
+  class IOProc < Netconf::Transport
+    
+    DEFAULT_RDBLKSZ = (1024*1024)
+    
+    attr_reader :args
+        
+    def initialize( args_h = {}, &block )
+      os_type = args_h[:os_type] || Netconf::DEFAULT_OS_TYPE
+            
+      @args = args_h.clone
+      
+      # an OS specific implementation must exist to support this transport type
+      extend Netconf::const_get( os_type )::IOProc        
+      
+      @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
+      @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
+
+      super( &block )      
+    end      
+        
+    # the OS specific transport must implement this method
+    def trans_open # :yield: self      
+      raise "Unsupported IOProc"
+    end
+    
+    def trans_receive_hello
+      trans_receive()
+    end
+    
+    def trans_send_hello
+      nil
+    end
+    
+    def trans_close
+      @trans.write Netconf::RPC::MSG_CLOSE_SESSION
+      @trans.close
+    end
+    
+    def trans_send( cmd_str )
+      @trans.write( cmd_str )
+    end
+    
+    def trans_receive
+      got = waitfor( Netconf::RPC::MSG_END_RE )
+      msg_end = got.rindex( Netconf::RPC::MSG_END )
+      got[msg_end .. -1] = ''
+      got
+    end
+        
+    def puts( str = nil )
+      @trans.puts( str )
+    end
+        
+    def waitfor( on_re )      
+      
+      time_out = @trans_timeout
+      wait_io = @trans_waitio
+
+      time_out = nil if time_out == false
+      done = false
+      rx_buf = ''      
+                  
+      until( rx_buf.match( on_re ) and not IO::select( [@trans], nil, nil, wait_io ) )
+              
+        unless IO::select( [@trans], nil, nil, time_out )
+          raise TimeoutError, "Netconf IO timed out while waiting for more data"
+        end
+      
+        begin                   
+          
+          rx_some = @trans.readpartial( DEFAULT_RDBLKSZ )                       
+          
+          rx_buf += rx_some
+          break if rx_buf.match( on_re )
+          
+        rescue EOFError # End of file reached
+          rx_buf = nil if rx_buf == ''
+          break   # out of outer 'until' loop
+        end        
+        
+      end      
+      rx_buf
+    end     
+    
+  end # class: IOProc
+end # module: Netconf

data/lib/net/netconf/jnpr.rb

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

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

@@ -0,0 +1,14 @@
+require 'net/netconf'
+require 'net/netconf/ioproc'
+require 'net/netconf/jnpr'
+
+module Netconf
+  module Junos
+    module IOProc
+      def trans_open   
+        @trans = IO.popen( "xml-mode netconf need-trailer", "r+")                             
+        self
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+#
+# Copyright (c) 2012 Juniper Networks, Inc.
+# All Rights Reserved
+#
+# JUNIPER PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+
+module Netconf
+
+  class JunosConfig
+
+    DELETE = { :delete => 'delete' }
+    REPLACE = { :replace => 'replace' }
+ 
+    attr_reader :doc
+    attr_reader :collection
+
+    def initialize( options )
+      @doc_ele = "configuration"
+
+      if options == :TOP
+        @doc = Nokogiri::XML("<#{@doc_ele}/>")
+        return
+      end
+
+      unless options[:TOP].nil?
+        @doc_ele = options[:TOP]
+        @doc = Nokogiri::XML("<#{@doc_ele}/>")
+        return
+      end
+
+      unless defined? @collection
+        edit = "#{@doc_ele}/#{options[:edit].strip}"
+        @at_name = edit[edit.rindex('/') + 1, edit.length]
+        @edit_path = edit
+        @collection = Hash.new
+        @to_xml = options[:build]
+      end
+    end
+
+    def <<( obj )
+      if defined? @collection
+        @collection[obj[:name]] = obj
+      elsif defined? @doc
+        obj.build_xml( @doc )
+      else
+        # TBD:error
+      end
+    end
+
+    def build_xml( ng_xml, &block )
+      at_ele = ng_xml.at( @edit_path )
+      if at_ele.nil?
+        # no xpath anchor point, so we need to create it
+        at_ele = edit_path( ng_xml, @edit_path )
+      end
+      build_proc = (block_given?) ? block : @to_xml
+
+      @collection.each do |k,v|
+        with( at_ele ) do |e|
+          build_proc.call( e, v )
+        end
+      end
+    end
+
+    def edit_path( ng_xml, xpath )
+      # junos configuration always begins with
+      # the 'configuration' element, so don't make
+      # the user enter it all the time
+
+      cfg_xpath = xpath
+      dot = ng_xml.at( cfg_xpath )
+      return dot if dot
+
+      # we need to determine how much of the xpath
+      # we need to create.  walk down the xpath
+      # children to determine what exists and
+      # what needs to be added
+
+      xpath_a = cfg_xpath.split('/')
+      need_a = []
+      until xpath_a.empty? or dot
+        need_a.unshift xpath_a.pop
+        check_xpath = xpath_a.join('/')
+        dot = ng_xml.at( check_xpath )
+      end
+
+      # start at the deepest level of what
+      # actually exists and then start adding
+      # the children that were missing
+
+      dot = ng_xml.at(xpath_a.join('/'))
+      need_a.each do |ele|
+        dot = dot.add_child( Nokogiri::XML::Node.new( ele, ng_xml ))
+      end
+      return dot
+    end
+
+    def with( ng_xml, &block )
+      Nokogiri::XML::Builder.with( ng_xml, &block )
+    end
+  end
+   #-- class end
+end
+

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

@@ -14,7 +14,7 @@
 
 module Netconf
   module RPC
-    module JUNOS            
+    module Junos            
       
       def lock_configuration
         lock( 'candidate' )
@@ -55,9 +55,8 @@ module Netconf
               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
+          # filter must have toplevel = <configuration>
+          rpc.first_element_child << filter.dup   # *MUST* use the .dup so we don't disrupt the original filter
         end
                
         @trans.rpc_exec( rpc )
@@ -69,7 +68,7 @@ module Netconf
         
         # default format is XML
         attrs = { :format => 'xml' }
-        
+                
         while arg = args.shift
           case arg.class.to_s
           when /^Nokogiri/ 
@@ -78,7 +77,7 @@ module Netconf
               when Nokogiri::XML::Document then arg.root
               else arg
               end                
-          when 'Hash' then attrs = arg
+          when 'Hash' then attrs.merge! arg
           when 'Array' then config = arg.join("\n")
           when 'String' then config = arg
           end
@@ -93,8 +92,8 @@ module Netconf
           toplevel = 'configuration-text'          
         when 'xml'
           toplevel = 'configuration'          
-        end
-                        
+        end                        
+        
         rpc = Nokogiri::XML('<rpc><load-configuration/></rpc>').root
         ld_cfg = rpc.first_element_child
         Netconf::RPC.add_attributes( ld_cfg, attrs ) if attrs   
@@ -112,14 +111,15 @@ module Netconf
         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            
+            # config assumes toplevel = <configuration> given            
+            ld_cfg << config.dup        # duplicate the config so as to not distrupt it            
           else
-            # config is stringy, so just add it as the text node
+            # config is stringy, so just add it as the text node            
+            c_node = Nokogiri::XML::Node.new( toplevel, rpc )            
             c_node.content = config
+            ld_cfg << c_node            
           end
-          ld_cfg << c_node
         end
                                            
         # set a specific exception class on this RPC so it can be

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

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

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

@@ -3,14 +3,14 @@ require 'net/netconf/telnet'
 require 'net/netconf/jnpr'
 
 module Netconf
-  module TransTelnet
-    module JUNOS
+  module Junos  
+    module TransTelnet
       
       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
+        @exec_netconf = ($1 == '%') ? Netconf::Junos::NETCONF_SHELL : Netconf::Junos::NETCONF_CLI
       end
       
       def trans_start_netconf

data/lib/net/netconf/serial.rb

@@ -26,7 +26,7 @@ module Netconf
       # this must be provided! if the caller does not, this will 
       # throw a NameError exception.
       
-      extend Netconf::TransSerial::const_get( os_type )        
+      extend Netconf::const_get( os_type )::TransSerial        
       
       @trans_timeout = @args[:timeout] || Netconf::DEFAULT_TIMEOUT
       @trans_waitio = @args[:waitio] || Netconf::DEFAULT_WAITIO
@@ -86,7 +86,6 @@ module Netconf
     
     def trans_send( cmd_str )
       @trans.write( cmd_str )
-      @trans.fsync          
     end
     
     def trans_receive
@@ -98,7 +97,6 @@ module Netconf
         
     def puts( str = nil )
       @trans.puts str 
-      @trans.fsync          
     end
         
     def waitfor( this_re = nil )      
@@ -121,8 +119,6 @@ module Netconf
           
           rx_some = @trans.readpartial( DEFAULT_RDBLKSZ )                       
           
-          $stdout.puts rx_some
-          
           rx_buf += rx_some
           break if rx_buf.match( on_re )
           

data/lib/net/netconf/telnet.rb

@@ -11,7 +11,7 @@ module Netconf
       # extend this instance with the capabilities of the specific console
       # type; it needs to define #login and #start_netconf session
       begin
-        extend Netconf::TransTelnet::const_get( os_type )        
+        extend Netconf::const_get( os_type )::TransTelnet        
       rescue NameError
         # no extensions available ...
       end     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netconf
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -51,11 +51,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/net/netconf/exception.rb
+- lib/net/netconf/ioproc.rb
+- lib/net/netconf/jnpr/ioproc.rb
+- lib/net/netconf/jnpr/junos_config.rb
 - lib/net/netconf/jnpr/rpc.rb
 - lib/net/netconf/jnpr/serial.rb
 - lib/net/netconf/jnpr/telnet.rb
 - lib/net/netconf/jnpr.rb
-- lib/net/netconf/localhost.rb
 - lib/net/netconf/rpc.rb
 - lib/net/netconf/rpc_std.rb
 - lib/net/netconf/serial.rb

data/lib/net/netconf/localhost.rb

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