netconf 0.2.5 → 0.3.0

data/lib/net/netconf/jnpr.rb

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

@@ -1,14 +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
+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/rpc.rb

@@ -1,140 +1,162 @@
-## -----------------------------------------------------------------------
-## 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
-          # 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 )
-      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.merge! 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
-          if attrs[:format] == 'xml'
-            # 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            
-            c_node = Nokogiri::XML::Node.new( toplevel, rpc )            
-            c_node.content = config
-            ld_cfg << c_node            
-          end
-        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 # load_configuration
-      
-      def command( cmd_str, attrs = nil )
-        rpc = Nokogiri::XML("<rpc><command>#{cmd_str}</command></rpc>").root
-        Netconf::RPC.add_attributes( rpc.at('command'), attrs ) if attrs           
-        @trans.rpc_exec( rpc )
-      end
-            
-    end # module: JUNOS    
-  end # module: RPC
-end # module: Netconf
+## -----------------------------------------------------------------------
+## 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
+          # 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 )
+      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.merge! 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
+          if attrs[:format] == 'xml'
+            # 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            
+            c_node = Nokogiri::XML::Node.new( toplevel, rpc )            
+            c_node.content = config
+            ld_cfg << c_node            
+          end
+        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 # load_configuration
+      
+      def command( cmd_str, attrs = nil )
+        rpc = Nokogiri::XML("<rpc><command>#{cmd_str}</command></rpc>").root
+        Netconf::RPC.add_attributes( rpc.at('command'), attrs ) if attrs           
+        @trans.rpc_exec( rpc )
+      end
+      
+      ## contributed by 'dgjnpr'
+      def request_pfe_execute( params = nil )
+        raise ArgumentError, 'Manditorary argument :target missing' unless params[:target]
+        raise ArgumentError, 'Manditorary argument :command missing' unless params[:command]
+
+        rpc_nx = Nokogiri::XML::Builder.new { |xml|
+          xml.rpc {
+            xml.send( 'request-pfe-execute' ) {
+              xml.send( 'target', params[:target] )
+              if params[:command].class.to_s =~ /^Array/
+                params[:command].each { |cmd|
+                  xml.send( 'command', cmd )
+                }
+              elsif params[:command].class.to_s =~ /^String/
+                xml.send( 'command', params[:command] )
+              end
+            }
+          }
+        }
+        @trans.rpc_exec( rpc_nx )
+      end
+            
+    end # module: JUNOS    
+  end # module: RPC
+end # module: Netconf

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

@@ -1,15 +1,15 @@
-require 'net/netconf'
-require 'net/netconf/serial'
-require 'net/netconf/jnpr'
-
-module Netconf
-  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
-        puts netconf_cmd
-      end      
-    end      
-  end
-end
+require 'net/netconf'
+require 'net/netconf/serial'
+require 'net/netconf/jnpr'
+
+module Netconf
+  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
+        puts netconf_cmd
+      end      
+    end      
+  end
+end

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

@@ -1,23 +1,23 @@
-require 'net/netconf'
-require 'net/netconf/telnet'
-require 'net/netconf/jnpr'
-
-module Netconf
-  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
-      end
-      
-      def trans_start_netconf
-        @trans.puts @exec_netconf
-      end
-      
-    end
-  end  
-end    
-
+require 'net/netconf'
+require 'net/netconf/telnet'
+require 'net/netconf/jnpr'
+
+module Netconf
+  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
+      end
+      
+      def trans_start_netconf
+        @trans.puts @exec_netconf
+      end
+      
+    end
+  end  
+end    
+

data/lib/net/netconf/rpc.rb

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