junos-ez-stdlib 0.0.10

data/examples/config/config_file.rb

@@ -0,0 +1,72 @@
+=begin
+
+  This exmaple illustrates the use of the Junos::Ez::Config::Utils library.  The code will load the contents
+  of a configuration file and save the diff output to the file "diffs.txt".  Error checking/exception
+  handling is also demonstrated.  If there are any errors, the "pretty-print" (pp) function will dump the
+  contents of the result structure to stderr so you can see what it looks like.
+  
+=end
+
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+
+login = { :target => 'vsrx', :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+# attach the junos-ez objects to the ndev object ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cfg )
+
+# begin a block to trap any raised expections ...
+begin     
+  
+  # lock the candidate config 
+  ndev.cfg.lock!
+
+  # load the contents of the 'load_sample.conf' file
+  # into the device.
+  
+  $stdout.puts "Loading changes ..."
+  ndev.cfg.load! :filename => 'load_sample.conf'
+  
+  # check to see if commit-check passes.  if it doesn't
+  # it will return a structure of errors
+  
+  unless (errs = ndev.cfg.commit?) == true
+    $stderr.puts "Commit check failed"
+    pp errs
+    ndev.close      # will auto-rollback changes
+    exit 1
+  end
+
+  # save the cnfig diff to a file ...
+  File.open( "diffs.txt", "w") {|f| f.write ndev.cfg.diff? }
+  
+  # commit the changes and unlock the config
+  
+  $stdout.puts "Commiting changes ..."
+  ndev.cfg.commit!
+  ndev.cfg.unlock!
+  
+  $stdout.puts "Done!"
+  
+rescue Netconf::LockError
+  $stderr.puts "Unable to lock config"
+rescue Netconf::EditError => e
+  $stderr.puts "Unable to load configuration"
+  pp Junos::Ez::rpc_errors( e.rsp )
+rescue Netconf::CommitError => e
+  $stderr.puts "Unable to commit configuration"
+  pp Junos::Ez::rpc_errors( e.rpc )
+end
+
+ndev.close

data/examples/config/config_template_object.rb

@@ -0,0 +1,81 @@
+=begin
+
+  This exmaple illustrates the use of the Junos::Ez::Config::Utils library.  The code will load the contents
+  of a template (ERB) file and use an object to contain the variables used in scope (binding).
+  
+  Error checking/exception handling is also demonstrated.  If there are any errors, the "pretty-print" 
+  (pp) function will dump the contents of the result structure to stderr so you can see what it looks like.
+  
+=end
+
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+
+login = { :target => 'vsrx', :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+# attach the junos-ez objects to the ndev object ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cfg )
+
+# begin a block to trap any raised expections ...
+begin     
+  
+  # lock the candidate config 
+  ndev.cfg.lock!
+
+  # load the template (ERB) file and use an object to contains the variables
+  # in scope durning the ERB result evaluation, so declare that now just for demo purposes ...
+  
+  class MyClass
+    def initialize
+      @interfaces = ['ge-0/0/1','ge-0/0/2','ge-0/0/3']
+    end
+  end
+  
+  myobj = MyClass.new
+  
+  $stdout.puts "Loading changes ..."
+  ndev.cfg.load! :filename => 'load_template_object.conf', :binding => myobj
+      
+  # check to see if commit-check passes.  if it doesn't
+  # it will return a structure of errors
+  
+  unless (errs = ndev.cfg.commit?) == true
+    $stderr.puts "Commit check failed"
+    pp errs
+    ndev.close      # will auto-rollback changes
+    exit 1
+  end
+
+  # save the cnfig diff to a file ...
+  File.open( "diffs.txt", "w") {|f| f.write ndev.cfg.diff? }
+  
+  # commit the changes and unlock the config
+  
+  $stdout.puts "Commiting changes ..."
+  ndev.cfg.commit!
+  ndev.cfg.unlock!
+  
+  $stdout.puts "Done!"
+  
+rescue Netconf::LockError
+  $stderr.puts "Unable to lock config"
+rescue Netconf::EditError => e
+  $stderr.puts "Unable to load configuration"
+  pp Junos::Ez::rpc_errors( e.rsp )
+rescue Netconf::CommitError => e
+  $stderr.puts "Unable to commit configuration"
+  pp Junos::Ez::rpc_errors( e.rpc )
+end
+
+ndev.close

data/examples/config/config_template_simple.rb

@@ -0,0 +1,76 @@
+=begin
+
+  This exmaple illustrates the use of the Junos::Ez::Config::Utils library.  The code will load the contents
+  of a template (ERB) file and use the current variables in the main scope (binding) to fill in the details.
+  
+  Error checking/exception handling is also demonstrated.  If there are any errors, the "pretty-print" 
+  (pp) function will dump the contents of the result structure to stderr so you can see what it looks like.
+  
+=end
+
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+
+login = { :target => 'vsrx', :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+# attach the junos-ez objects to the ndev object ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cfg )
+
+# begin a block to trap any raised expections ...
+begin     
+  
+  # lock the candidate config 
+  ndev.cfg.lock!
+
+  # load the template (ERB) file and use the current variables in scope (binding)
+  # when evaluating the results of the template.  The template references a
+  # veriable called 'interfaces', so declare that now ...
+  
+  interfaces = ['ge-0/0/1','ge-0/0/2','ge-0/0/3']
+  
+  $stdout.puts "Loading changes ..."
+  ndev.cfg.load! :filename => 'load_template_main.conf', :binding => binding
+    
+  # check to see if commit-check passes.  if it doesn't
+  # it will return a structure of errors
+  
+  unless (errs = ndev.cfg.commit?) == true
+    $stderr.puts "Commit check failed"
+    pp errs
+    ndev.close      # will auto-rollback changes
+    exit 1
+  end
+
+  # save the cnfig diff to a file ...
+  File.open( "diffs.txt", "w") {|f| f.write ndev.cfg.diff? }
+  
+  # commit the changes and unlock the config
+  
+  $stdout.puts "Commiting changes ..."
+  ndev.cfg.commit!
+  ndev.cfg.unlock!
+  
+  $stdout.puts "Done!"
+  
+rescue Netconf::LockError
+  $stderr.puts "Unable to lock config"
+rescue Netconf::EditError => e
+  $stderr.puts "Unable to load configuration"
+  pp Junos::Ez::rpc_errors( e.rsp )
+rescue Netconf::CommitError => e
+  $stderr.puts "Unable to commit configuration"
+  pp Junos::Ez::rpc_errors( e.rpc )
+end
+
+ndev.close

data/examples/config/multi_config.rb

@@ -0,0 +1,60 @@
+require 'pry'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+# list of targets to make the change.  Hardcoding these as array
+# but you could load them from a file, etc.
+
+targets = [ 'vsrx', 'ex-10', 'ex-20', 'ex-33' ]
+
+# let's assume that all targets use the same login/password ...
+
+login = { :username => 'jeremy',  :password => 'jeremy1',  }
+
+
+# -------------------------------------------------------------------
+# define a function to do the configuration actions
+# -------------------------------------------------------------------
+
+def load_stuff( login )
+
+  ## create a NETCONF object to manage the device and open the connection ...
+  ndev = Netconf::SSH.new( login )
+  $stdout.print "Connecting to device #{login[:target]} ... "
+  ndev.open
+  $stdout.puts "OK!"
+  
+  Junos::Ez::Provider( ndev )
+  Junos::Ez::Config::Utils( ndev, :cfg )
+  
+  # lock the candidate config 
+  #    ndev.cfg.lock!
+  
+  # examples of loading ...
+  #    ndev.cfg.load! :filename => 'load_sample.conf'
+  #    ndev.cfg.load! :content => File.read( 'load_sample.conf' ), :format => :text
+  #    ndev.cfg.load! :filename => 'load_sample.set'
+  
+  binding.pry
+  
+  # check to see if the config is OK to commit
+  #   ndev.cfg.commit?  
+  
+  # perform the commit
+  #   ndev.cfg.commit!
+  
+  # unlock the config
+  #   ndev.cfg.unlock!
+  
+  ndev.close
+end
+
+### -----------------------------------------------------------------
+### run through each of the target names and load configs ..
+### -----------------------------------------------------------------
+
+targets.each do |target| 
+  login[:target] = target
+  load_stuff( login )
+end
+

data/examples/fs_utils.rb

@@ -0,0 +1,31 @@
+require 'pry'
+require 'pp'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+
+login = { :target => 'vsrx', :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+## Now bind providers to the device object.
+## the 'Junos::Ez::Provider' must be first before all others
+## this provider will setup the device 'facts'.  The other providers
+## allow you to define the instance variables; so this example
+## is using 'l1_ports' and 'ip_ports', but you could name them
+## what you like, yo!
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Fs::Utils( ndev, :fs )
+
+
+binding.pry
+
+ndev.close

data/examples/re_upgrade.rb

@@ -0,0 +1,90 @@
+require 'pry'
+require 'pp'
+require 'net/scp'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+# login information for NETCONF session 
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+print "Connecting to device #{login[:target]} ... "
+ndev.open
+puts "OK!"
+
+## attach our private & utils that we need ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::RE::Utils( ndev, :re )       # routine-engine utils
+Junos::Ez::FS::Utils( ndev, :fs )       # filesystem utils
+
+## upload the software image to the target device
+## http://net-ssh.github.io/net-scp/
+
+file_name = 'junos-vsrx-domestic.tgz'
+file_on_server = '/home/jschulman/junos-images/vsrx/' + file_name
+file_on_junos = '/var/tmp/' + file_name
+
+## simple function to use the Netconf::SSH SCP functionality to
+## upload a file to the device and watch the percetage tick by ...
+
+def copy_file_to_junos( ndev, file_on_server, file_on_junos )  
+  mgr_i = cur_i = 0
+  ndev.scp.upload!( file_on_server, file_on_junos ) do |ch, name, sent, total|  
+    pct = (sent.to_f / total.to_f) * 100
+    mgr_i = pct.to_i
+    if mgr_i != cur_i
+      cur_i = mgr_i
+      puts cur_i.to_s + "%"
+    end    
+  end
+end
+
+puts "Copying file to Junos ..."
+copy_file_to_junos( ndev, file_on_server, file_on_junos )
+
+###
+### check the MD5 checksum values
+###
+
+md5_on_s = Digest::MD5.file( file_on_server ).to_s
+md5_on_j = ndev.fs.checksum( :md5, file_on_junos )
+
+if md5_on_s != md5_on_j
+  puts "The MD5 checksum values do not match!"
+  ndev.close
+  exit 1
+end
+
+puts "MD5 checksum matches ... proceeding ..."
+puts "Validating image ... please wait ..."
+
+unless ndev.re.validate_software?( file_on_junos )
+  puts "The softare does not validate!"
+  ndev.close
+  exit 1
+end
+
+puts "Installing image ... place wait ..."
+rc = ndev.re.install_software!( :package => file_on_junos, :no_validate => true )
+if rc != true
+  puts rc
+end
+
+### use pry if you want to 'look around'
+## -> binding.pry
+
+### if you wanted to reboot the system now, you coud
+### do the following ...
+
+## -> ndev.re.reboot!
+
+ndev.close

data/examples/re_utils.rb

@@ -0,0 +1,30 @@
+require 'pry'
+require 'pp'
+require 'net/scp'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+     
+# login information for NETCONF session 
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+print "Connecting to device #{login[:target]} ... "
+ndev.open
+puts "OK!"
+
+## attach our private & utils that we need ...
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::RE::Utils( ndev, :re )
+Junos::Ez::FS::Utils( ndev, :fs )
+
+binding.pry
+
+ndev.close

data/examples/simple.rb

@@ -0,0 +1,47 @@
+require 'pry'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+require 'junos-ez/srx'
+
+unless ARGV[0]
+  puts "You must specify a target"
+  exit 1
+end
+
+# login information for NETCONF session 
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+## Now bind providers to the device object.
+## the 'Junos::Ez::Provider' must be first before all others
+## this provider will setup the device 'facts'.  The other providers
+## allow you to define the instance variables; so this example
+## is using 'l1_ports' and 'ip_ports', but you could name them
+## what you like, yo!
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::L1ports::Provider( ndev, :l1_ports )
+Junos::Ez::IPports::Provider( ndev, :ip_ports )
+
+## drop into interactive mode to play around ... let's look
+## at what the device has for facts ...
+
+#->  ndev.facts.list
+#->  ndev.facts.catalog
+#->  ndev.fact :version
+
+## now look at specific providers like the physical (l1) ports ...
+
+#-> ndev.l1_ports.list
+#-> ndev.l1_ports.catalog
+
+binding.pry
+
+ndev.close

data/examples/st_hosts.rb

@@ -0,0 +1,33 @@
+require 'pry'
+require 'pp'
+require 'yaml'
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+# login information for NETCONF session 
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+## Now bind providers to the device object.
+## the 'Junos::Ez::Provider' must be first before all others
+## this provider will setup the device 'facts'.  The other providers
+## allow you to define the instance variables; so this example
+## is using 'l1_ports' and 'ip_ports', but you could name them
+## what you like, yo!
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::StaticHosts::Provider( ndev, :hosts )
+
+pp ndev.hosts.list
+pp ndev.hosts.catalog
+
+binding.pry
+
+ndev.close

data/examples/vlans.rb

@@ -0,0 +1,25 @@
+require 'net/netconf/jnpr'
+require 'junos-ez/stdlib'
+
+# login information for NETCONF session 
+
+login = { :target => ARGV[0], :username => 'jeremy',  :password => 'jeremy1',  }
+
+## create a NETCONF object to manage the device and open the connection ...
+
+ndev = Netconf::SSH.new( login )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cu )
+Junos::Ez::Vlans::Provider( ndev, :vlans )
+Junos::Ez::L2ports::Provider( ndev, :l2_ports )
+
+pp ndev.vlans.list
+pp ndev.vlans.catalog
+
+binding.pry
+
+ndev.close

data/junos-ez-stdlib.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift 'lib'
+require 'rake'
+require 'junos-ez/provider'
+
+Gem::Specification.new do |s|
+  s.name = 'junos-ez-stdlib'
+  s.version = Junos::Ez::VERSION
+  s.summary = "Junos EZ Framework - Standard Libraries"
+  s.description = "Automation Framework for Junos/NETCONF:  Facts, Providers, and Utils"
+  s.homepage = 'https://github.com/jeremyschulman/ruby-junos-ez-stdlib'
+  s.authors = ["Jeremy Schulman"]
+  s.email = 'jschulman@juniper.net'
+  s.files = FileList[ '*', 'lib/**/*.rb', 'examples/**/*.rb', 'docs/**/*.md' ]
+  s.add_dependency('netconf')
+end

data/lib/junos-ez/facts/chassis.rb

@@ -0,0 +1,45 @@
+Junos::Ez::Facts::Keeper.define( :chassis ) do |ndev, facts|
+  
+  inv_info = ndev.rpc.get_chassis_inventory
+  chassis = inv_info.xpath('chassis')
+  
+  facts[:hardwaremodel] = chassis.xpath('description').text
+  facts[:serialnumber] = chassis.xpath('serial-number').text           
+  
+  cfg = ndev.rpc.get_configuration{|xml|
+    xml.system {
+      xml.send(:'host-name')
+      xml.send(:'domain-name')
+    }
+  }
+  
+  facts[:hostname] = cfg.xpath('//host-name').text
+  facts[:domain] = cfg.xpath('//domain-name').text
+  facts[:fqdn] = facts[:hostname]
+  facts[:fqdn] += ".#{facts[:domain]}" unless facts[:domain].empty?
+  
+end
+
+Junos::Ez::Facts::Keeper.define( :master ) do |ndev, facts|
+  uses :routingengines
+end
+
+Junos::Ez::Facts::Keeper.define( :routingengines ) do |ndev, facts|
+
+  re_facts = ['mastership-state','status','model','up-time','last-reboot-reason']
+  re_info = ndev.rpc.get_route_engine_information
+  re_info.xpath('//route-engine').each do |re|
+    slot_id = re.xpath('slot').text || "0"
+    slot = ("RE" + slot_id).to_sym
+    facts[slot] = Hash[ re_facts.collect{ |ele| [ ele.tr('-','_').to_sym, re.xpath(ele).text ] } ]
+    if facts[slot][:mastership_state].empty?
+      facts[slot].delete :mastership_state
+    else 
+      facts[:master] = slot_id if facts[slot][:mastership_state] == 'master'
+    end
+  end
+  
+end
+
+        
+

data/lib/junos-ez/facts/ifd_style.rb

@@ -0,0 +1,14 @@
+
+Junos::Ez::Facts::Keeper.define( :ifd_style ) do  |ndev, facts|
+  persona = uses :personality
+  
+  facts[:ifd_style] = case persona
+  when :SWITCH
+    :SWITCH
+  else
+    :CLASSIC
+  end      
+  
+end
+
+

data/lib/junos-ez/facts/personality.rb

@@ -0,0 +1,22 @@
+Junos::Ez::Facts::Keeper.define( :personality ) do |ndev, facts|
+  
+  model = uses :hardwaremodel  
+      
+  facts[:personality] = case model   
+  when /^(EX)|(QFX)/
+    :SWITCH
+  when /^MX/
+    :MX
+  when /^vMX/
+    facts[:virtual] = true
+    :MX
+  when /SRX(\d){3}/
+    :SRX_BRANCH
+  when /junosv-firefly/i
+    facts[:virtual] = true
+    :SRX_BRANCH
+  when /SRX(\d){4}/
+    :SRX_HIGHEND
+  end
+  
+end

data/lib/junos-ez/facts/switch_style.rb

@@ -0,0 +1,22 @@
+Junos::Ez::Facts::Keeper.define( :switch_style ) do |ndev, facts|
+  f_persona = uses :personality
+    
+  facts[:switch_style] = case f_persona
+  when :SWITCH, :SRX_BRANCH
+    case facts[:hardwaremodel]
+    when /junosv-firefly/i
+      :NONE
+    when /^(ex9)|(ex43)/i
+      :VLAN_L2NG
+    else
+      :VLAN
+    end        
+  when :MX, :SRX_HIGHEND
+    :BRIDGE_DOMAIN
+  else
+    :NONE
+  end
+
+end
+    
+