junos-ez-stdlib 0.1.2 → 1.0.3

data/lib/junos-ez/lag_ports.rb

@@ -0,0 +1,268 @@
+require "junos-ez/provider"
+
+module Junos::Ez::LAGports
+
+  PROPERTIES = [ 
+    :links,               # Set of interface names  
+    :minimum_links,       # nil or Number > 0 # optional
+    :lacp,                # [ :active, :passive, :disabled ] # optional
+  ]  
+  
+  def self.Provider( ndev, varsym )            
+    newbie = Junos::Ez::LAGports::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
+    # common parenting goes here ... if we were to
+    # subclass the objects ... not doing that now
+  end
+  
+end
+
+class Junos::Ez::LAGports::Provider 
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  # LAG ports sit at the toplevel interface
+  
+  def xml_at_top
+    Nokogiri::XML::Builder.new {|xml| xml.configuration {
+      xml.interfaces { xml.interface {
+        xml.name @name
+        return xml
+      }}
+    }}
+  end
+  
+  ###-----------------------------------------------------------
+  ###-----------------------------------------------------------
+  ### utilities
+  ###-----------------------------------------------------------
+
+  def get_cookie_links( cfg )
+    cfg.xpath( "apply-macro[name = 'netdev_lag[:links]']/data/name" ).collect { |n| n.text }
+  end 
+
+  def set_cookie_links( cfg )
+    cfg.send(:'apply-macro', Netconf::JunosConfig::REPLACE ) {
+      cfg.name 'netdev_lag[:links]'
+      should[:links].each{ |ifd|
+        cfg.data { cfg.name ifd }
+      }
+    }
+  end  
+       
+  ### ---------------------------------------------------------------
+  ### XML property readers
+  ### ---------------------------------------------------------------  
+  
+  def xml_config_read!
+    database = {'database' => 'committed'}
+    @ndev.rpc.get_configuration(xml_at_top, database)
+  end
+ 
+  def xml_get_has_xml( xml )
+    if ndev.facts[:ifd_style] == "CLASSIC"
+      @ifd_ether_options = 'gigether-options'
+    else
+      @ifd_ether_options = 'ether-options' 
+    end 
+    xml.xpath('//interface')[0]    
+  end
+  
+  def xml_read_parser( as_xml, as_hash )    
+    set_has_status( as_xml, as_hash )          
+        
+    # property :links
+    ae_name = as_xml.xpath('name').text
+    as_hash[:links] = Set.new(get_cookie_links(as_xml))
+    
+    # property :lacp
+    ae_opts = as_xml.xpath('aggregated-ether-options')
+    if (lacp = ae_opts.xpath('lacp')[0])
+      as_hash[:lacp] = (lacp.xpath('active')[0]) ? :active : :passive
+    else
+      as_hash[:lacp] = :disabled
+    end      
+    
+    # property :minimum_links
+    as_hash[:minimum_links] = (min_links = ae_opts.xpath('minimum-links')[0]) ? min_links.text.to_i : 1
+  end
+    
+  ### ---------------------------------------------------------------
+  ### XML property writers
+  ### ---------------------------------------------------------------    
+  def update_ifd_should()
+    if @should[:links].empty?
+      raise Junos::Ez::NoProviderError, "\n *links* are compulsory for creating lag interface!!! \n"
+    else
+      ether_option = @should[:links][0].to_s
+      @ifd_ether_options = (ether_option.start_with? 'fe-') ? 'fastether-options' : 'gigether-options'
+    end
+  end
+ 
+  def update_ifd_has()
+    @has[:links] = @has[:links].to_a
+    if @has[:links].empty?
+     raise Junos::Ez::NoProviderError, "\n Either lag interface is not created or links associated with given lag interface is not supported \n"
+    else
+     ether_option = @has[:links][0].to_s
+     @ifd_ether_options = (ether_option.start_with? 'fe-') ? 'fastether-options' : 'gigether-options'
+    end  
+  end
+ 
+  def xml_change_links( xml )
+    update_ifd_should()  
+    @should[:links] = @should[:links].to_set if @should[:links].kind_of? Array
+    
+    has = @has[:links] || Set.new
+    should = @should[:links] || Set.new
+            
+    set_cookie_links( xml )
+
+    del = has - should
+    add = should - has
+    
+    par = xml.instance_variable_get(:@parent)
+    dot_ifd = par.at_xpath('ancestor::interfaces')
+
+    add.each{ |new_ifd| Nokogiri::XML::Builder.with( dot_ifd ) {|dot|
+      dot.interface { dot.name new_ifd
+        dot.send(@ifd_ether_options.to_sym) {
+          dot.send(:'ieee-802.3ad') {
+            dot.bundle @name
+          }
+        }
+    }}}
+
+    del.each{ |new_ifd| Nokogiri::XML::Builder.with( dot_ifd ) {|dot|
+      dot.interface { dot.name new_ifd
+        dot.send(@ifd_ether_options) {
+          dot.send( :'ieee-802.3ad', Netconf::JunosConfig::DELETE )
+        }
+    }}} 
+  end
+  
+  def xml_change_lacp( xml )
+    if @should[:lacp] == :disabled or @should[:lacp].nil?
+      xml.send(:'aggregated-ether-options') {
+        xml.lacp( Netconf::JunosConfig::DELETE )
+      }
+    else
+      xml.send(:'aggregated-ether-options') {
+        xml.lacp { xml.send @should[:lacp] }      # @@@ should validate :lacp value before doing this...
+      }
+    end
+  end
+  
+  def xml_change_minimum_links( xml )
+    if @should[:minimum_links] 
+      xml.send(:'aggregated-ether-options') {
+        xml.send( :'minimum-links', @should[:minimum_links] )
+      }
+    else
+      xml.send(:'aggregated-ether-options') {
+        xml.send(:'minimum-links', Netconf::JunosConfig::DELETE )
+      }
+    end
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML on-create
+  ### ---------------------------------------------------------------  
+  
+  def xml_on_create( xml )
+    # make sure there is a 'unit 0' on the AE port
+    par = xml.instance_variable_get(:@parent)
+    Nokogiri::XML::Builder.with(par) do |dot|
+      dot.unit {
+        dot.name '0'
+      }
+    end
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML on-delete
+  ### ---------------------------------------------------------------      
+  
+  def xml_on_delete( xml )
+    update_ifd_has()
+    par = xml.instance_variable_get(:@parent)
+    dot_ifd = par.at_xpath('ancestor::interfaces')
+   
+    # remove the bindings from each of the physical interfaces
+    #    
+    @has[:links].each do |new_ifd| Nokogiri::XML::Builder.with( dot_ifd ) do |dot|
+      dot.interface { dot.name new_ifd
+        dot.send(@ifd_ether_options) {
+          dot.send( :'ieee-802.3ad', Netconf::JunosConfig::DELETE )
+        }
+      }
+      end
+    end
+    
+    # now remove the LAG interface
+    #
+    Nokogiri::XML::Builder.with( dot_ifd ) do |dot|
+      dot.interface( Netconf::JunosConfig::DELETE ) {
+        dot.name @name
+      }
+    end        
+  end
+   
+end
+
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::LAGports::Provider
+  
+  def build_list    
+    @ndev.rpc.get_interface_information(
+      :terse => true,
+      :interface_name => 'ae*' 
+    ).xpath('physical-interface/name').collect{ |name| name.text.strip }
+  end
+  
+  def build_catalog
+    return @catalog if list!.empty?
+    
+    list.each do |ae_name|
+      @ndev.rpc.get_configuration{ |xml|
+        xml.interfaces {
+          xml.interface {
+            xml.name ae_name
+          }
+        }
+      }.xpath('interfaces/interface').each do |as_xml|
+        @catalog[ae_name] = {}
+        xml_read_parser( as_xml, @catalog[ae_name] )
+      end
+    end    
+    
+    @catalog
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### _PRIVATE methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::LAGports::Provider
+  def _get_port_list( name )
+    @ndev.rpc.get_interface_information(
+      :detail => true,
+      :interface_name => name + '.0'
+    ).xpath('//lag-link/name').collect{ |name| 
+      name.text.strip.split('.',2).first 
+    }
+  end
+end
+

data/lib/junos-ez/provider.rb

@@ -6,10 +6,6 @@
 ##### ---------------------------------------------------------------
 
 require 'set'
-
-module Junos; end
-module Junos::Ez; end
- 
 require 'junos-ez/version.rb'
 require 'junos-ez/exceptions.rb'  
   
@@ -208,7 +204,7 @@ class Junos::Ez::Provider::Parent
   ## can use 'create!' which does write to the device.
   ## ----------------------------------------------------------------
   
-  def create( name = nil, prop_hash = {}, &block )
+  def create( name = nil, prop_hash = {} )
         
     ## if this is an existing object, then we shouldn't 
     ## allow the caller to create something.
@@ -248,8 +244,8 @@ class Junos::Ez::Provider::Parent
   ## the config assuming create returns ok.
   ## ----------------------------------------------------------------
   
-  def create!( name = nil, prop_hash = {}, &block )
-    newbie = create( name, prop_hash, block )
+  def create!( *args )
+    newbie = create( *args )
     return nil unless newbie
     newbie.write!
     newbie
@@ -548,7 +544,7 @@ class Junos::Ez::Provider::Parent
       action = {'action' => 'replace' }
       result = @ndev.rpc.load_configuration( xml, action )
     rescue Netconf::RpcError => e      
-      errs = e.rsp.xpath('//rpc-error[error-severity = "error"]')
+      errs = e.rsp.xpath('//rpc-error')
       raise e unless errs.empty?
       e.rsp
     else

data/lib/junos-ez/stdlib.rb

@@ -6,6 +6,8 @@ require 'junos-ez/l1_ports'             # physical ports
 require 'junos-ez/vlans'                # vlans
 require 'junos-ez/l2_ports'             # switch ports
 require 'junos-ez/ip_ports'             # ip ports (v4)
+require 'junos-ez/lag_ports'            # Link Aggregation Groups
+require 'junos-ez/group'
 
 # -------------------------------------------------------------------
 # utility libraries, not providers

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

@@ -66,12 +66,12 @@ class Junos::Ez::Users::Provider
   
     # READ-ONLY capture the keys
     unless (keys = as_xml.xpath('authentication/ssh-rsa')).empty?
-      @has[:ssh_keys] ||= {}
-      @has[:ssh_keys]['ssh-rsa'] = keys.collect{|key| key.text.strip}
+      as_hash[:ssh_keys] ||= {}
+      as_hash[:ssh_keys]['ssh-rsa'] = keys.collect{|key| key.text.strip}
     end
     unless (keys = as_xml.xpath('authentication/ssh-dsa')).empty?
-      @has[:ssh_keys] ||= {}      
-      @has[:ssh_keys]['ssh-dsa'] = keys.collect{|key| key.text.strip}
+      as_hash[:ssh_keys] ||= {}      
+      as_hash[:ssh_keys]['ssh-dsa'] = keys.collect{|key| key.text.strip}
     end
   end  
 
@@ -127,9 +127,7 @@ class Junos::Ez::Users::Provider
   def build_catalog
     @catalog = {}
     @ndev.rpc.get_configuration{ |x| x.system {
-      x.login {
-        x.user
-      }
+      x.login
     }}
     .xpath('//user').each do |user|
       name = user.xpath('name').text

data/lib/junos-ez/version.rb

@@ -1,3 +1,6 @@
+module Junos; end
+module Junos::Ez; end
+
 module Junos::Ez
-  VERSION = "0.1.2"
+  VERSION = '1.0.3'.freeze
 end

data/lib/junos-ez/vlans.rb

@@ -11,8 +11,10 @@ module Junos::Ez::Vlans
 
   def self.Provider( ndev, varsym )        
     newbie = case ndev.fact :switch_style
-    when :VLAN, :VLAN_NG
+    when :VLAN
       Junos::Ez::Vlans::Provider::VLAN.new( ndev )
+    when :VLAN_L2NG
+      Junos::Ez::Vlans::Provider::VLAN_L2NG.new( ndev )      
     when :BRIDGE_DOMAIN
       Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN.new( ndev )     
     else
@@ -30,6 +32,7 @@ module Junos::Ez::Vlans
 end
 
 require 'junos-ez/vlans/vlan'
+require 'junos-ez/vlans/vlan_l2ng'
 require 'junos-ez/vlans/bridge_domain'
 
 

data/lib/junos-ez/vlans/bridge_domain.rb

@@ -21,12 +21,16 @@ class Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN < Junos::Ez::Vlans::Provider
     return nil unless (@has_xml = cfg_xml.xpath('//domain')[0])      
     xml_read_parser( @has_xml, @has )    
   end
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//domain')[0]    
+  end
   
   def xml_read_parser( as_xml, as_hash )
-    status_from_junos( as_xml, as_hash )        
+    set_has_status( as_xml, as_hash )        
     as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
     as_hash[:description] = as_xml.xpath('description').text
-    as_hash[:no_mac_learning] = as_xml.xpath('bridge-options/no-mac-learning').empty? ? false : true    
+    as_hash[:no_mac_learning] = as_xml.xpath('bridge-options/no-mac-learning').empty? ? :disable : :enable    
     return true    
   end
   
@@ -42,7 +46,7 @@ class Junos::Ez::Vlans::Provider::BRIDGE_DOMAIN < Junos::Ez::Vlans::Provider
     no_ml = @should[:no_mac_learning]     
     return unless ( exists? and no_ml )    
     xml.send(:'bridge-options') {
-      xml.send(:'no-mac-learning', no_ml ? nil : Netconf::JunosConfig::DELETE )
+      xml.send(:'no-mac-learning', (no_ml == :enable) ? nil : Netconf::JunosConfig::DELETE )
     }    
   end
   

data/lib/junos-ez/vlans/vlan.rb

@@ -22,9 +22,10 @@ class Junos::Ez::Vlans::Provider::VLAN < Junos::Ez::Vlans::Provider
         
   def xml_read_parser( as_xml, as_hash )
     set_has_status( as_xml, as_hash )    
+    
     as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
-    xml_when_item(as_xml.xpath('description')){ |i| as_hash[:description] = i.text }
-    xml_when_item(as_xml.xpath('no-mac-learning')){ as_hash[:no_mac_learning] = true }
+    xml_when_item(as_xml.xpath('description')){ |i| as_hash[:description] = i.text }    
+    xml_when_item(as_xml.xpath('no-mac-learning')){ as_hash[:no_mac_learning] = :enable }
     
     # get a brief list of the interfaces on this vlan
     got = @ndev.rpc.get_vlan_information( :vlan_name => @name || as_xml.xpath('name').text )
@@ -40,7 +41,7 @@ class Junos::Ez::Vlans::Provider::VLAN < Junos::Ez::Vlans::Provider
   
   def xml_change_no_mac_learning( xml )
     no_ml = @should[:no_mac_learning]     
-    return unless exists? and no_ml    
+    return unless exists? and no_ml
     xml.send(:'no-mac-learning', no_ml ? nil : Netconf::JunosConfig::DELETE )
   end
   

data/lib/junos-ez/vlans/vlan_l2ng.rb

@@ -0,0 +1,126 @@
+class Junos::Ez::Vlans::Provider::VLAN_L2NG < Junos::Ez::Vlans::Provider
+  
+  ### ---------------------------------------------------------------
+  ### XML top placement
+  ### ---------------------------------------------------------------
+  
+  def xml_at_top
+    Nokogiri::XML::Builder.new{|x| x.configuration{ 
+      x.vlans { x.vlan { x.name @name
+        return x
+      }}
+    }}
+  end
+
+  ### ---------------------------------------------------------------
+  ### XML readers
+  ### ---------------------------------------------------------------
+
+  def xml_get_has_xml( xml )
+    xml.xpath('//vlan')[0]    
+  end
+        
+  def xml_read_parser( as_xml, as_hash )
+    set_has_status( as_xml, as_hash )    
+    
+    as_hash[:vlan_id] = as_xml.xpath('vlan-id').text.to_i
+    xml_when_item(as_xml.xpath('description')){ |i| as_hash[:description] = i.text }
+        
+    xml_when_item(as_xml.xpath('switch-options/no-mac-learning')) {
+      as_hash[:no_mac_learning] = :enable
+    }
+    
+    # get a brief list of the interfaces on this vlan
+    got = @ndev.rpc.get_vlan_information( :vlan_name => @name || as_xml.xpath('name').text )
+    as_hash[:interfaces] = got.xpath('//l2ng-l2rtb-vlan-member-interface').collect{|ifs| ifs.text.strip }
+    as_hash[:interfaces] = nil if as_hash[:interfaces][0] == "None"
+    
+    return true
+  end
+  
+  ### ---------------------------------------------------------------
+  ### XML writers
+  ### ---------------------------------------------------------------
+  
+  def xml_change_no_mac_learning( xml )
+    no_ml = @should[:no_mac_learning]     
+    return unless exists? and no_ml    
+    xml.send(:'switch-options') {
+      xml.send(:'no-mac-learning', no_ml == :enable ? nil : Netconf::JunosConfig::DELETE )
+    }
+  end
+  
+  def xml_change_vlan_id( xml )
+    xml.send(:'vlan-id', @should[:vlan_id] )
+  end
+  
+  def xml_change_description( xml )
+    value = @should[:description]
+    xml.description value ? value : Netconf::JunosConfig::DELETE
+  end
+
+end
+
+##### ---------------------------------------------------------------
+##### Provider collection methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN_L2NG
+  
+  def build_list    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      vlan.xpath('name').text
+    end    
+  end
+  
+  def build_catalog
+    @catalog = {}    
+    xml_cfgs = @ndev.rpc.get_configuration{ |x| x.send :'vlans' }    
+    xml_cfgs.xpath('vlans/vlan').collect do |vlan|
+      name = vlan.xpath('name').text
+      @catalog[name] = {}
+      xml_read_parser( vlan, @catalog[name] )
+    end          
+    return @catalog
+  end
+  
+end
+
+##### ---------------------------------------------------------------
+##### Provider operational methods
+##### ---------------------------------------------------------------
+
+class Junos::Ez::Vlans::Provider::VLAN_L2NG
+
+  ### ---------------------------------------------------------------
+  ### interfaces - returns a Hash of each interface in the VLAN
+  ###    each interface (key) will identify:
+  ###    :mode = [ :access | :trunk ]
+  ###    :native = true if (:mode == :trunk) and this VLAN is the 
+  ###       native vlan-id (untagged packets)
+  ### ---------------------------------------------------------------
+  
+  def interfaces( opts = {} )
+    raise ArgumentError, "not a resource" if is_provider?
+    
+    args = {}
+    args[:vlan_name] = @name 
+    args[:extensive] = true    
+    got = @ndev.rpc.get_vlan_information( args )
+    
+    member_pfx = 'l2ng-l2rtb-vlan-member'
+    members = got.xpath("//#{member_pfx}-interface")
+    ifs_h = {}
+    members.each do |port|
+      port_name = port.text.split('.')[0]
+      port_h = {}
+      port_h[:mode] = port.xpath("following-sibling::#{member_pfx}-interface-mode[1]").text.to_sym
+      tgd = port.xpath("following-sibling::#{member_pfx}-tagness[1]").text
+      native = (tgd == 'untagged')
+      port_h[:native] = true if( native and port_h[:mode] == :trunk)
+      ifs_h[port_name] = port_h
+    end
+    ifs_h    
+  end
+end