net-netconf 0.4.0

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

@@ -0,0 +1,49 @@
+require 'net/netconf'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+  
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected."
+
+  # ----------------------------------------------------------------------  
+  # retrieve the full config.  Default source is 'running'
+  # Alternatively you can pass the source name as a string parameter 
+  # to #get_config
+  
+  puts "Retrieving full config, please wait ... "
+  cfgall = dev.rpc.get_config                   
+  puts "Showing 'system' hierarchy ..."
+  puts cfgall.xpath('configuration/system')     # JUNOS toplevel config element is <configuration> 
+
+  # ----------------------------------------------------------------------  
+  # specifying a filter as a block to get_config
+  
+  cfgsvc1 = dev.rpc.get_config{ |x|
+    x.configuration { x.system { x.services }}
+  }
+  
+  puts "Retrieved services as BLOCK:"
+  cfgsvc1.xpath('//services/*').each{|s| puts s.name }
+  
+  # ----------------------------------------------------------------------
+  # specifying a filter as a parameter to get_config
+  
+  filter = Nokogiri::XML::Builder.new{ |x|
+    x.configuration { x.system { x.services }}
+  }
+  
+  cfgsvc2 = dev.rpc.get_config( filter )
+  puts "Retrieved services as PARAM:"  
+  cfgsvc2.xpath('//services/*').each{|s| puts s.name }
+  
+  cfgsvc3 = dev.rpc.get_config( filter )
+  puts "Retrieved services as PARAM, re-used filter"  
+  cfgsvc3.xpath('//services/*').each{|s| puts s.name }        
+}
+
+
+

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

@@ -0,0 +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
+
+

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

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

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

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

data/examples/jnpr/get-inventory.rb

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

data/examples/jnpr/scp.rb

@@ -0,0 +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"
+}
+

data/lib/net/netconf.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+
+require 'net/netconf/version'
+require 'net/netconf/rpc'
+require 'net/netconf/exception'
+require 'net/netconf/transport'
+require 'net/netconf/ssh'
+
+module Netconf
+  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

@@ -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}\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

@@ -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

@@ -0,0 +1,9 @@
+require 'net/netconf'
+require 'net/netconf/jnpr/rpc'
+require 'net/netconf/jnpr/junos_config'
+
+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
+