netconf 0.2.5 → 0.3.0

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

@@ -1,27 +1,27 @@
-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
-
-dev.close
-
-
+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
+
+dev.close
+
+

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

@@ -1,25 +1,25 @@
-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
-  
-}
-
-
-
+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
+  
+}
+
+
+

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

@@ -1,14 +1,14 @@
-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
-  
-}
-
-
+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
+  
+}
+
+

data/examples/jnpr/get-inventory.rb

@@ -1,16 +1,16 @@
-require 'net/netconf'
-
-puts "NETCONF v#{Netconf::VERSION}"
-
-login = { :target => 'vsrx', :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      
-}
-
-
-
+require 'net/netconf'
+
+puts "NETCONF v#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :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

@@ -1,22 +1,22 @@
-require 'net/netconf'
-require 'net/scp'
-
-login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
-
-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"
-}
-
+require 'net/netconf'
+require 'net/scp'
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+
+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

@@ -1,15 +1,25 @@
 
 require 'nokogiri'
 
+require 'net/netconf/version'
 require 'net/netconf/rpc'
 require 'net/netconf/exception'         
 require 'net/netconf/transport'
 require 'net/netconf/ssh'
 
 module Netconf  
-  VERSION = "0.2.5"   
   NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0"  
   DEFAULT_OS_TYPE = :Junos  
   DEFAULT_TIMEOUT = 10
   DEFAULT_WAITIO = 0
+  
+  @raise_on_warning = false          # rpc-error with <error-severity> = 'warning' will not raise RpcError excption
+  
+  def self.raise_on_warning=( bool )
+    @raise_on_warning = bool
+  end
+  def self.raise_on_warning
+    @raise_on_warning
+  end
+
 end

data/lib/net/netconf/exception.rb

@@ -1,38 +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
+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}\n#{rsp.to_xml}"
+    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/ioproc.rb

@@ -1,88 +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
+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