junos-ez-stdlib 0.0.10

data/lib/junos-ez/system/st_routes.rb

@@ -0,0 +1,135 @@
+class Junos::Ez::StaticRoutes::Provider
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    @name = "0.0.0.0/0" if @name == :default
+    
+    Nokogiri::XML::Builder.new {|xml| xml.configuration {
+      xml.send('routing-options') {
+        xml.static { xml.route {
+          xml.name @name
+          return xml
+        }}
+      }
+    }}
+  end
+    
+  ### ---------------------------------------------------------------
+  ### XML property readers
+  ### ---------------------------------------------------------------  
+
+  def xml_get_has_xml( xml )  
+    xml.xpath('routing-options/static/route')[0]
+  end
+  
+  def xml_read_parser( as_xml, as_hash )    
+    set_has_status( as_xml, as_hash )
+    
+    ## :gateway
+    unless (next_hop = as_xml.xpath('next-hop')).empty?
+      if next_hop.count == 1
+        as_hash[:gateway] = next_hop.text    
+      else
+        as_hash[:gateway] = next_hop.collect{|i| i.text }
+      end
+    end
+    
+    unless (active = as_xml.xpath('active')).empty?
+      as_hash[:active] = true
+    end
+    
+    unless (action = as_xml.xpath( 'reject | discard | receive' )).empty?
+      as_hash[:action] = action[0].name.to_sym
+    end
+    
+    unless (metric = as_xml.xpath('metric')).empty?
+      as_hash[:metric] = metric.text.to_i
+    end
+    
+    xml_read_parse_noele( as_xml, 'retain', as_hash, :retain )
+    xml_read_parse_noele( as_xml, 'install', as_hash, :install )
+    xml_read_parse_noele( as_xml, 'resolve', as_hash, :resolve )
+    xml_read_parse_noele( as_xml, 'readvertise', as_hash, :readvertise )        
+  end
+  
+  
+  ### ---------------------------------------------------------------
+  ### XML property writers
+  ### ---------------------------------------------------------------  
+    
+  def xml_change_action( xml )
+    
+    if @should[:action].nil?
+      xml.send( @has[:action], Netconf::JunosConfig::DELETE )
+      return true
+    end
+    
+    xml.send( @should[:action] )
+  end
+  
+  def xml_change_active( xml )
+    xml_set_or_delete_element( xml, 'active', @should[:active] )
+  end
+  
+  def xml_change_gateway( xml )
+    # delete existing entries
+    ele_nh = :'next-hop'    
+    
+    # clear any existing values, and return unless there are any new ones ...
+    xml.send(ele_nh, Netconf::JunosConfig::DELETE) if @has[:gateway]    
+    return true unless @should[:gateway]      
+    
+    ## adding back the ones we want now ... 
+    if @should[:gateway].kind_of? String
+      xml.send( ele_nh, @should[:gateway] )
+    else       
+      @should[:gateway].each{ |gw| xml.send( ele_nh, gw ) }
+    end
+  end
+  
+  def xml_change_retain( xml )
+    xml_set_or_delete_noele( xml, 'retain' )
+  end
+  
+  def xml_change_install( xml )
+    xml_set_or_delete_noele( xml, 'install' )
+  end
+  
+  def xml_change_resolve( xml )
+    xml_set_or_delete_noele( xml, 'resolve' )
+  end
+  
+  def xml_change_readvertise( xml )
+    xml_set_or_delete_noele( xml, 'readvertise' )
+  end
+  
+  def xml_change_metric( xml )
+    xml_set_or_delete( xml, 'metric', @should[:metric] )
+  end
+  
+    
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::StaticRoutes::Provider
+  
+  def build_list
+    @ndev.rpc.get_configuration{|xml| xml.send(:'routing-options') {
+      xml.static { xml.route }
+    }}.xpath('//route/name').collect do |item|
+      item.text
+    end    
+  end
+  
+  def build_catalog
+    @catalog = {}
+    @catalog
+  end
+  
+end

data/lib/junos-ez/system/syscfg.rb

@@ -0,0 +1,103 @@
+class Junos::Ez::SysConfig::Provider 
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    xml = Nokogiri::XML::Builder.new {|xml| xml.configuration {
+      xml.system {
+        return xml
+      }
+    }}
+  end
+  
+  def xml_config_read!    
+    xml = xml_at_top
+    xml.send(:'host-name')
+    xml.send(:'domain-name')
+    xml.send(:'domain-search')
+    xml.send(:'time-zone')
+    xml.location
+    xml.send(:'name-server')
+    xml.ntp
+    @ndev.rpc.get_configuration( xml )
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML property readers
+  ### ---------------------------------------------------------------  
+
+  def xml_get_has_xml( xml )  
+    xml.xpath('system')[0]
+  end
+  
+  def xml_read_parser( as_xml, as_hash )    
+    set_has_status( as_xml, as_hash )      
+    as_hash[:host_name] = as_xml.xpath('host-name').text
+    unless (data = as_xml.xpath('domain-name')).empty?
+      as_hash[:domain_name] = data.text
+    end
+    unless (data = as_xml.xpath('domain-search')).empty?
+      as_hash[:domain_search] = data.collect{|i| i.text}
+    end
+    unless (data = as_xml.xpath('time-zone')).empty?
+      as_hash[:timezone] = data.text
+    end
+    unless (data = as_xml.xpath('name-server/name')).empty?
+      as_hash[:dns_servers] = data.collect{|i| i.text}
+    end
+    unless (data = as_xml.xpath('ntp/server/name')).empty?
+      as_hash[:ntp_servers] = data.collect{|i| i.text}
+    end
+    unless (location = as_xml.xpath('location')).empty?
+      as_hash[:location] = {}  
+      unless (data = location.xpath('building')).empty?
+        as_hash[:location][:building] = data.text
+      end
+      unless (data = location.xpath('country-code')).empty?
+        as_hash[:location][:countrycode] = data.text
+      end
+      unless (data = location.xpath('floor')).empty?
+        as_hash[:location][:floor] = data.text
+      end
+      unless (data = location.xpath('rack')).empty?
+        as_hash[:location][:rack] = data.text
+      end
+    end
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML property writers
+  ### ---------------------------------------------------------------    
+  
+  def xml_change_host_name( xml )
+    xml.send(:'host-name', @should[:host_name] )
+  end
+
+  def xml_change_domain_name( xml )
+    xml.send(:'domain-name', @should[:domain_name] )
+  end
+
+  def xml_change_domain_search( xml )
+  end
+  
+  def xml_change_timezone( xml )
+    xml.send(:'time-zone', @should[:timezone])
+  end
+  
+  def xml_change_dns_servers( xml )
+  end
+  
+  def xml_change_ntp_servers( xml )
+  end
+  
+  def xml_change_date( xml )
+  end
+  
+  def xml_change_location( xml )
+  end
+    
+end
+
+

data/lib/junos-ez/system.rb

@@ -0,0 +1,98 @@
+
+require "junos-ez/provider"
+
+### -----------------------------------------------------------------
+### manage static host entries, kinda like "/etc/hosts"
+### -----------------------------------------------------------------
+
+module Junos::Ez::StaticHosts
+  
+  PROPERTIES = [
+    :ip,                    # ipv4 address :String
+    :ip6,                   # ipv6 address :String
+  ]
+  
+  def self.Provider( ndev, varsym )            
+    newbie = Junos::Ez::StaticHosts::Provider.new( ndev )      
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )    
+  end  
+  
+  class Provider < Junos::Ez::Provider::Parent
+  end
+  
+end
+
+require 'junos-ez/system/st_hosts'
+
+### -----------------------------------------------------------------
+### manage static route entries
+### -----------------------------------------------------------------
+
+module Junos::Ez::StaticRoutes
+  
+    PROPERTIES = [
+      :gateway,             # next-hop gateway, could be single or Array
+      :metric,              # number or nil
+      :action,              # one-of [ :reject, :discard, :receive ]
+      :active,              # flag [ true, nil | false ]
+      :retain,              # no-flag [ nil, true, false ]
+      :install,             # no-flag [ nil, true, false ]
+      :readvertise,         # no-flag [ nil, true, false ]
+      :resolve,             # no-flag [ nil, true, false ]
+    ]
+    
+  def self.Provider( ndev, varsym )            
+    newbie = Junos::Ez::StaticRoutes::Provider.new( ndev )      
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )    
+  end  
+  
+  class Provider < Junos::Ez::Provider::Parent
+  end
+    
+end
+
+require 'junos-ez/system/st_routes'
+
+### -----------------------------------------------------------------
+### the 'syscfg' is a work in progress, do not use ...
+### -----------------------------------------------------------------
+
+module Junos::Ez::SysConfig
+  
+  PROPERTIES = [
+    :host_name,             # String, host-name
+    :domain_name,           # domain name, string or array
+    :domain_search,         # array of dns name suffix values
+    :dns_servers,           # array of ip-addrs
+    :ntp_servers,           # array NTP servers HASH of
+                            #   :version
+                            #   :key
+    :timezone,              # String time-zone
+    :date,                  # String format: YYYYMMDDhhmm.ss
+    :location,              # location HASH with properties
+                            #   :countrycode
+                            #   :building,
+                            #   :floor,
+                            #   :rack
+  ]
+  
+  def self.Provider( ndev, varsym )            
+    raise ArgumentError "work-in-progress ..."
+    
+    newbie = Junos::Ez::SysConfig::Provider.new( ndev )      
+    newbie.properties = Junos::Ez::Provider::PROPERTIES + PROPERTIES
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )    
+  end  
+  
+  class Provider < Junos::Ez::Provider::Parent
+  end
+    
+end
+
+require 'junos-ez/system/syscfg'
+
+
+
+

data/lib/junos-ez/utils/config.rb

@@ -0,0 +1,205 @@
+=begin
+---------------------------------------------------------------------
+Config::Utils is a collection of methods used for loading 
+configuration files/templates and software images
+
+   commit! - commit configuration
+   commit? - see if a candidate config is OK (commit-check)
+   diff? - shows the diff of the candidate config w/current | rolback
+   load! - load configuration onto device
+   lock! - take exclusive lock on config
+   unlock! - release exclusive lock on config
+   rollback! - perform a config rollback
+   
+---------------------------------------------------------------------
+=end
+
+module Junos::Ez::Config  
+  def self.Utils( ndev, varsym )            
+    newbie = Junos::Ez::Config::Provider.new( ndev )      
+    Junos::Ez::Provider.attach_instance_variable( ndev, varsym, newbie )    
+  end          
+end
+
+### -----------------------------------------------------------------
+###                        PUBLIC METHODS
+### -----------------------------------------------------------------
+### -----------------------------------------------------------------
+
+class Junos::Ez::Config::Provider < Junos::Ez::Provider::Parent
+  
+  ### ---------------------------------------------------------------
+  ### load! - used to load configuration files / templates.  This
+  ###    does not perform a 'commit', just the equivalent of the
+  ###    load-configuration RPC
+  ###
+  ### --- options ---
+  ###
+  ### :filename => path - indcates the filename of content
+  ###    note: filename extension will also define format
+  ###    .{conf,text,txt} <==> :text
+  ###    .xml  <==> :xml
+  ###    .set  <==> :set
+  ###
+  ### :content => String - string content of data (vs. :filename)
+  ###  
+  ### :format =>  [:text, :set, :xml], default :text (curly-brace)
+  ###    this will override any auto-format from the :filename
+  ###
+  ### :binding  - indicates file/content is an ERB
+  ###    => <object> - will grab the binding from this object
+  ###                  using a bit of meta-programming magic
+  ###    => <binding> - will use this binding
+  ###
+  ### :replace! => true - enables the 'replace' option
+  ### :overwrite! => true - enables the 'overwrite' optoin
+  ###
+  ### --- returns ---
+  ###   true if the configuration is loaded OK
+  ###   raise Netconf::EditError otherwise
+  ### ---------------------------------------------------------------
+  
+  def load!( opts = {} )
+    raise ArgumentError unless opts[:content] || opts[:filename]
+    
+    content = opts[:content] || File.read( opts[:filename] )    
+    
+    attrs = {}
+    attrs[:action] = 'replace' if opts[:replace!]      
+    attrs[:action] = 'override' if opts[:override!]       
+    
+    if opts[:format] 
+      attrs[:format] = opts[:format].to_s
+    elsif opts[:filename]
+      case f_ext = File.extname( opts[:filename] )
+      when '.conf','.text','.txt'; attrs[:format] = 'text'
+      when '.set'; attrs[:format] = 'set'
+      when '.xml'; # default is XML
+      else
+        raise ArgumentError, "unknown format from extension: #{f_ext}"
+      end
+    else
+      raise ArgumentError "unspecified format"
+    end   
+        
+    if opts[:binding]
+      erb = ERB.new( content, nil, '>' )
+      case opts[:binding]
+      when Binding
+        # binding was provided to use
+        content = erb.result( opts[:binding] )
+      when Object
+        obj = opts[:binding]
+        def obj.junos_ez_binding; binding end
+        content = erb.result( obj.junos_ez_binding )
+        class << obj; remove_method :junos_ez_binding end
+      end
+    end
+    
+    @ndev.rpc.load_configuration( content, attrs ) 
+    true # everthing OK!    
+  end
+  
+  ### ---------------------------------------------------------------
+  ### commit! - commits the configuration to the device
+  ### 
+  ### --- options ---
+  ###
+  ### :confirm => true | timeout 
+  ### :comment => commit log comment
+  ###
+  ### --- returns ---
+  ###    true if commit completed
+  ###    raises Netconf::CommitError otherwise
+  ### ---------------------------------------------------------------
+  
+  def commit!( opts = {} )
+    
+    args = {}
+    args[:log] = opts[:comment] if opts[:comment]
+    if opts[:confirm] 
+      args[:confirmed] = true
+      if opts[:confirm] != true
+        timeout = Integer( opts[:confirm] ) rescue false
+        raise ArgumentError "invalid timeout #{opts[:confirm]}" unless timeout
+        args[:confirm_timeout] = timeout
+      end
+    end
+    
+    @ndev.rpc.commit_configuration( args )
+    true          
+  end
+
+  ### ---------------------------------------------------------------
+  ### commit? - perform commit configuration check
+  ###
+  ### --- returns ---
+  ###    true if candidate config is OK to commit
+  ###    Array of rpc-error data otherwise
+  ### ---------------------------------------------------------------
+
+  def commit?        
+    begin
+      @ndev.rpc.commit_configuration( :check => true ) 
+    rescue => e
+      return Junos::Ez::rpc_errors( e.rsp )
+    end
+    true     # commit check OK!
+  end
+  
+  ### ---------------------------------------------------------------
+  ### rollback! - used to rollback the configuration
+  ### ---------------------------------------------------------------
+  
+  def rollback!( rollback_id = 0 )    
+    raise ArgumentError, "invalid rollback #{rollback_id}" unless ( rollback_id >= 0 and rollback_id <= 50 )    
+    @ndev.rpc.load_configuration( :compare=>'rollback', :rollback=> rollback_id.to_s )
+    true   # rollback OK!
+  end
+
+  ### ---------------------------------------------------------------
+  ### diff? - displays diff (patch format) between
+  ### current candidate configuration loaded and the rollback_id
+  ###
+  ### --- returns ---
+  ###    false if no diff
+  ###    String of diff output otherwise
+  ### ---------------------------------------------------------------
+  
+  def diff?( rollback_id = 0 )
+    raise ArgumentError, "invalid rollback #{rollback_id}" unless ( rollback_id >= 0 and rollback_id <= 50 )    
+    got = ndev.rpc.get_configuration( :compare=>'rollback', :rollback=> rollback_id.to_s )
+    diff = got.xpath('configuration-output').text
+    return false if diff == "\n"
+    diff
+  end
+  
+  ### ---------------------------------------------------------------
+  ### lock! - takes an exclusive lock on the candidate config
+  ###
+  ### --- returns ---
+  ###    true if lock acquired
+  ###    raise Netconf::LockError otherwise
+  ### ---------------------------------------------------------------
+  
+  def lock!
+    @ndev.rpc.lock_configuration
+    true
+  end
+
+  ### ---------------------------------------------------------------
+  ### unlock! - releases exclusive lock on candidate config
+  ###
+  ### --- returns ---
+  ###    true if lock release
+  ###    raise Netconf::RpcError otherwise
+  ### ---------------------------------------------------------------
+  
+  def unlock!
+    @ndev.rpc.unlock_configuration
+    true
+  end
+  
+end # class Provider    
+
+