net-netconf 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b84dffc3bef4a7c78fa7c383945452a1319f186c
+  data.tar.gz: 850b49f0af7e175a8590f7ef447a3d712d81cc4b
+SHA512:
+  metadata.gz: ee2f9173a0d140b1a1120b52ada2ea4f4fcc880ee83d1320ff569c10c069a81f17e0c8157247756b58ba7452d7888165311042905d2eafbd9e82a4709d488cfc
+  data.tar.gz: 9b2605221513738aa169b05c828b5dbbecc4578d1590a0ae8a8abf4a22eb70832d27e342492aef141cabd7f562c2817733d17be505c29a4e0b0fd91b103f30b2

data/examples/confd/get-running.rb

@@ -0,0 +1,27 @@
+#
+# This code is used to retrieve the running configuration
+# from a Tail-F "confD" NETCONF server, and display the
+# configured user names
+#
+
+require 'net/netconf'
+
+puts "NETCONF v#{Netconf::VERSION}"
+
+login = { :target => 'jeap', :port => 2022,
+  :username => "admin", :password => "admin" }
+
+Netconf::SSH.new( login ){ |dev|  
+  
+  config = dev.rpc.get_config
+  
+  puts "Showing users on this device ..."
+    
+  config.xpath("//users/user").each{|user|
+    puts "Username: #{user.xpath('name').text}"
+  }
+  
+}
+
+
+

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

@@ -0,0 +1,55 @@
+require 'net/netconf/jnpr'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+  
+new_host_name = "vsrx"
+
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected!"
+  
+  location = []
+  location << 'set system location building "Main Campus, C"'
+  location << "set system location floor 15"
+  location << "set system location rack 1117"
+  
+  begin
+    
+    rsp = dev.rpc.lock_configuration
+
+    # --------------------------------------------------------------------    
+    # configuration as BLOCK
+    
+    rsp = dev.rpc.load_configuration( :format => 'set' ) {
+      "set system host-name #{new_host_name}"
+    }
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.load_configuration( location, :format => 'set' )
+    
+    rpc = dev.rpc.check_configuration
+    rpc = dev.rpc.commit_configuration
+    rpc = dev.rpc.unlock_configuration
+    
+  rescue Netconf::LockError => e
+    puts "Lock error"
+  rescue Netconf::EditError => e
+    puts "Edit error"    
+  rescue Netconf::ValidateError => e
+    puts "Validate error"
+  rescue Netconf::CommitError => e
+    puts "Commit error"
+  rescue Netconf::RpcError => e
+    puts "General RPC error"
+  else
+    puts "Configuration Committed."
+  end  
+}
+
+
+

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

@@ -0,0 +1,64 @@
+require 'net/netconf/jnpr'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+  
+new_host_name = "vsrx-gizmo"
+
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected!"
+  
+  location = <<EOCONF
+system {
+   location {
+      building "Main Campus, E"
+      floor 15
+      rack 1117
+   }
+}
+EOCONF
+  
+  begin
+    
+    rsp = dev.rpc.lock_configuration
+
+    # --------------------------------------------------------------------    
+    # configuration as BLOCK
+    
+    rsp = dev.rpc.load_configuration( :format => 'text' ) {
+      <<-EOCONF
+      system {
+        host-name #{new_host_name}
+      }
+EOCONF
+    }
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.load_configuration( location, :format => 'text' )
+    
+    rpc = dev.rpc.check_configuration
+    rpc = dev.rpc.commit_configuration
+    rpc = dev.rpc.unlock_configuration
+    
+  rescue Netconf::LockError => e
+    puts "Lock error"
+  rescue Netconf::EditError => e
+    puts "Edit error"    
+  rescue Netconf::ValidateError => e
+    puts "Validate error"
+  rescue Netconf::CommitError => e
+    puts "Commit error"
+  rescue Netconf::RpcError => e
+    puts "General RPC error"
+  else
+    puts "Configuration Committed."
+  end  
+}
+
+
+

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

@@ -0,0 +1,73 @@
+require 'net/netconf/jnpr'
+
+puts "NETCONF v#{Netconf::VERSION}"
+
+login = { :target => 'ex4', :username => "jeremy", :password => "jeremy1" }
+  
+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.configuration {
+      x.system {
+        x.location {
+          x.building "Main Campus, D"
+          x.floor 22
+          x.rack 38
+        }
+      }
+      x.system {
+        x.services {
+          x.ftp;
+        }
+      }
+    }
+  }
+  
+  begin
+    
+    rsp = dev.rpc.lock_configuration
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.load_configuration( location,  :action => 'replace' )
+    
+    # --------------------------------------------------------------------    
+    # configuration as BLOCK
+    
+    rsp = dev.rpc.load_configuration{ |x| 
+      x.system {
+        x.send(:'host-name', new_host_name )
+      }
+    }
+    
+    rpc = dev.rpc.check_configuration
+    rpc = dev.rpc.commit_configuration
+    rpc = dev.rpc.unlock_configuration
+    
+  rescue Netconf::LockError => e
+    puts "Lock error"
+  rescue Netconf::EditError => e
+    puts "Edit error"    
+  rescue Netconf::ValidateError => e
+    puts "Validate error"
+  rescue Netconf::CommitError => e
+    puts "Commit error"
+  rescue Netconf::RpcError => e
+    puts "General RPC error"
+  else
+    puts "Configuration Committed."
+  end  
+}
+
+
+

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

@@ -0,0 +1,64 @@
+require 'net/netconf'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+  
+new_host_name = "vsrx-abc"
+
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected!"
+  
+  target = 'candidate'
+  
+  location = Nokogiri::XML::Builder.new{ |x| x.configuration {
+    x.system {
+      x.location {
+        x.building "Main Campus, A"
+        x.floor 5
+        x.rack 27
+      }
+    }
+  }}
+  
+  begin
+    
+    rsp = dev.rpc.lock target
+
+    # --------------------------------------------------------------------    
+    # configuration as BLOCK
+    
+    rsp = dev.rpc.edit_config{ |x| x.configuration {
+      x.system {
+        x.send(:'host-name', new_host_name )
+      }
+    }}
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.edit_config( location )
+    
+    rsp = dev.rpc.validate target
+    rpc = dev.rpc.commit
+    rpc = dev.rpc.unlock target
+    
+  rescue Netconf::LockError => e
+    puts "Lock error"
+  rescue Netconf::EditError => e
+    puts "Edit error"    
+  rescue Netconf::ValidateError => e
+    puts "Validate error"
+  rescue Netconf::CommitError => e
+    puts "Commit error"
+  rescue Netconf::RpcError => e
+    puts "General RPC error"
+  else
+    puts "Configuration Committed."
+  end  
+}
+
+
+

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

@@ -0,0 +1,68 @@
+require 'net/netconf'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+  
+new_host_name = "vsrx"
+
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected!"
+  
+  target = 'candidate'
+  
+  location = Nokogiri::XML::Builder.new{ |x| x.send(:'configuration-text', <<-EOCONF
+    system {
+      location {
+        building "Main Campus, ABC123"
+        floor 5
+        rack 27
+      }
+    }
+EOCONF
+  )}
+  
+  
+  begin
+    
+    rsp = dev.rpc.lock target
+
+    # --------------------------------------------------------------------    
+    # configuration as BLOCK
+    
+    rsp = dev.rpc.edit_config(:toplevel => 'config-text'){ 
+      |x| x.send(:'configuration-text', <<EOCONF
+      system {
+        host-name #{new_host_name};
+      }
+EOCONF
+    )}
+    
+    # --------------------------------------------------------------------
+    # configuration as PARAM
+    
+    rsp = dev.rpc.edit_config( location, :toplevel => 'config-text' )
+    
+    rsp = dev.rpc.validate target
+    rpc = dev.rpc.commit
+    rpc = dev.rpc.unlock target
+    
+  rescue Netconf::LockError => e
+    puts "Lock error"
+  rescue Netconf::EditError => e
+    puts "Edit error"    
+  rescue Netconf::ValidateError => e
+    puts "Validate error"
+  rescue Netconf::CommitError => e
+    puts "Commit error"
+  rescue Netconf::RpcError => e
+    puts "General RPC error"
+  else
+    puts "Configuration Committed."
+  end  
+}
+
+
+

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

@@ -0,0 +1,62 @@
+require 'net/netconf/jnpr'      # note: including Juniper specific extension
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'ex4', :username => "jeremy", :password => "jeremy1" }
+  
+puts "Connecting to device: #{login[:target]}" 
+
+Netconf::SSH.new( login ){ |dev|
+  puts "Connected."
+  
+  puts "Retrieving full config, please wait ... "
+  cfgall = dev.rpc.get_configuration                   # Junos specific RPC
+  puts "Showing 'system' hierarchy ..."
+  puts cfgall.xpath('system')                          # Root is <configuration>, so don't need to include it in XPath  
+
+  # ----------------------------------------------------------------------  
+  # specifying a filter as a block to get_configuration
+  # Junos extension does the proper toplevel wrapping
+
+  puts "Retrieved services from BLOCK, as XML:"
+  
+  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 }
+
+  puts "Retrieved services from BLOCK, as TEXT:"
+  
+  cfgsvc1_2 = dev.rpc.get_configuration( :format => 'text' ){ |x|
+    x.system { x.services }
+  }
+  
+  puts cfgsvc1_2.text
+  
+  # ----------------------------------------------------------------------
+  # 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| x.configuration {
+    x.system { x.services }
+    x.system { x.login }
+  }}
+
+  puts "Retrieved services by PARAM, as XML"  
+  
+  cfgsvc2 = dev.rpc.get_configuration( filter )
+  cfgsvc2.xpath('system/services/*').each{|s| puts s.name }
+
+  # ----------------------------------------------------------------------
+  # specifying a filter as a parameter to get_configuration,
+  # get response back in "text" format
+
+  puts "Retrieved services by PARAM, as TEXT:"    
+  cfgsvc3 = dev.rpc.get_configuration( filter, :format => 'text' )
+  puts cfgsvc3.text
+}
+
+
+

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

@@ -0,0 +1,20 @@
+require 'net/netconf/jnpr'
+
+puts "NETCONF v.#{Netconf::VERSION}"
+
+login = { :target => 'vsrx', :username => "jeremy", :password => "jeremy1" }
+
+Netconf::SSH.new( login ){ |dev|
+  
+  configs = dev.rpc.get_configuration{ |x|
+    x.interfaces( :matching => 'interface[name="ge-*"]' )
+  }
+  
+  ge_cfgs = configs.xpath('interfaces/interface')
+  
+  puts "There are #{ge_cfgs.count} GE interfaces:"
+  ge_cfgs.each{|ifd|     
+    units = ifd.xpath('unit').count    
+    puts "   " + ifd.xpath('name')[0].text  + " with #{units} unit" + ((units>1) ? "s" : '')    
+  }  
+}