shopify-junos-ez-stdlib 1.0.0

data/docs/Utils/SCP.md

@@ -0,0 +1,24 @@
+# `Net::SCP`
+
+The NETCONF object already provides a mechanism to use secure-copy (SCP), so technically this is _not_ part of the `Junos::EZ` framework.  That being said, this is some quick documentation and URLs so you can copy files to and from Junos devices.
+
+# DOCS
+
+For documentation on `Net::SCP`, please refer to this website: http://net-ssh.github.io/scp/v1/api/index.html
+
+# USAGE
+
+The NETCONF object includes an instance variable `scp` that is class `Net::SCP`.
+
+To copy a file from the server to the Junos target, you use the `upload` or `upload!` method.  The bang(!) version is blocking, meaning the code execution will resume only after the file has been completely transfered.
+
+```ruby
+file_on_server = "/cygwin/junos/junos-ex4200-image.tgz"
+location_on_junos = "/var/tmp"
+
+ndev.scp.upload!( from_on_server, location_on_junos )
+```
+
+To copy a file from the Junos target to the server, you use the `download` or `download!` method.
+
+Both upload and download methods can take a Ruby block which is used to provide progress updates on the transfer.  There is a complete "software upgrade" example that illustrates this technique in the _examples_ directory.

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/lag_port.rb

@@ -0,0 +1,27 @@
+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 )
+$stdout.print "Connecting to device #{login[:target]} ... "
+ndev.open
+$stdout.puts "OK!"
+
+Junos::Ez::Provider( ndev )
+Junos::Ez::Config::Utils( ndev, :cu )
+Junos::Ez::LAGports::Provider( ndev, :lags )
+Junos::Ez::Vlans::Provider( ndev, :vlans )
+Junos::Ez::L2ports::Provider( ndev, :l2_ports )
+
+binding.pry
+
+ndev.close

data/examples/re_upgrade.rb

@@ -0,0 +1,99 @@
+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 )       # routing-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
+  backitup = 8.chr * 4
+  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
+      printf "%4s", cur_i.to_s + "%"
+      print backitup
+    end    
+  end
+end
+
+print "Copying file to Junos ... "
+copy_file_to_junos( ndev, file_on_server, file_on_junos )
+puts "OK!    "
+
+###
+### check the MD5 checksum values
+###
+
+print "Validating MD5 checksum ... "
+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 "OK!"
+
+print "Validating image ... please wait ... "
+
+unless ndev.re.software_validate?( file_on_junos )
+  puts "The softare does not validate!"
+  ndev.close
+  exit 1
+end
+
+puts "OK!"
+
+print "Installing image ... please wait ... "
+rc = ndev.re.software_install!( :package => file_on_junos, :no_validate => true )
+if rc != true
+  puts rc
+end
+
+puts "OK!"
+
+### use pry if you want to 'look around'
+## -> binding.pry
+
+if ARGV[1] == 'reboot'
+  puts "Rebooting!"
+  ndev.re.reboot!
+end
+
+ndev.close