cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/bgp_neighbor.rb

@@ -67,7 +67,7 @@ module Cisco
     end
 
     def create
-      Feature.bgp_enable
+      Feature.bgp_enable if platform == :nexus
       set_args_keys(state: '')
       config_set('bgp', 'create_destroy_neighbor', @set_args)
     end
@@ -113,7 +113,7 @@ module Cisco
 
     def connected_check
       result = config_get('bgp_neighbor', 'connected_check', @get_args)
-      result ? false : true
+      result ? false : default_connected_check
     end
 
     def default_connected_check
@@ -129,7 +129,7 @@ module Cisco
 
     def capability_negotiation
       result = config_get('bgp_neighbor', 'capability_negotiation', @get_args)
-      result ? false : true
+      result ? false : default_capability_negotiation
     end
 
     def default_capability_negotiation
@@ -142,8 +142,7 @@ module Cisco
     end
 
     def dynamic_capability
-      result = config_get('bgp_neighbor', 'dynamic_capability', @get_args)
-      result ? true : false
+      config_get('bgp_neighbor', 'dynamic_capability', @get_args)
     end
 
     def default_dynamic_capability
@@ -212,7 +211,7 @@ module Cisco
 
     def low_memory_exempt
       result = config_get('bgp_neighbor', 'low_memory_exempt', @get_args)
-      result ? true : false
+      result ? true : default_low_memory_exempt
     end
 
     def default_low_memory_exempt
@@ -242,8 +241,24 @@ module Cisco
                       type:   Encryption.symbol_to_cli(default_password_type),
                       passwd: val.to_s)
       else
+        cli_type = nil
+        if platform == :ios_xr
+          case type
+          when :cleartext
+            cli_type = 'clear'
+          when :md5
+            cli_type = 'encrypted'
+          else
+            fail Cisco::UnsupportedError.new(
+              'RouterBgpNeighbor', 'password',
+              nil, "type '#{type}'")
+          end
+        else
+          cli_type = Encryption.symbol_to_cli(type)
+        end
+
         set_args_keys(state:  '',
-                      type:   Encryption.symbol_to_cli(type),
+                      type:   cli_type,
                       passwd: val.to_s)
       end
       config_set('bgp_neighbor', 'password', @set_args)
@@ -259,7 +274,7 @@ module Cisco
 
     def password_type
       result = config_get('bgp_neighbor', 'password_type', @get_args)
-      Encryption.cli_to_symbol(result.to_i)
+      Encryption.cli_to_symbol(result.to_s)
     end
 
     def default_password_type
@@ -303,7 +318,7 @@ module Cisco
 
     def default_remove_private_as
       result = config_get_default('bgp_neighbor', 'remove_private_as')
-      result.to_sym
+      result.nil? ? nil : result.to_sym
     end
 
     def shutdown=(val)
@@ -375,18 +390,52 @@ module Cisco
       ["#{default_timers_keepalive}", "#{default_timers_holdtime}"]
     end
 
+    def transport_passive_mode=(val)
+      if platform == :nexus
+        if val == :active_only
+          fail Cisco::UnsupportedError.new(
+            'RouterBgpNeighbor', 'transport_passive_mode',
+            nil, "value '#{val}'")
+        else
+          set_args_keys(state: (val == :passive_only) ? '' : 'no')
+          config_set('bgp_neighbor', 'transport_passive_mode', @set_args)
+        end
+      else
+        set_args_keys(mode:  mode_symbol_to_cli(val),
+                      state: (val == :none) ? 'no' : '')
+        config_set('bgp_neighbor', 'transport_passive_mode', @set_args)
+      end
+    end
+
+    def transport_passive_mode
+      result = config_get('bgp_neighbor', 'transport_passive_mode', @get_args)
+      if platform == :nexus
+        result ? :passive_only : :none
+      else
+        mode_cli_to_symbol(result)
+      end
+    end
+
+    def default_transport_passive_mode
+      result = config_get_default('bgp_neighbor', 'transport_passive_mode')
+      if platform == :nexus
+        result ? :passive_only : :none
+      else
+        mode_cli_to_symbol(result)
+      end
+    end
+
     def transport_passive_only=(val)
-      set_args_keys(state: (val) ? '' : 'no')
-      config_set('bgp_neighbor', 'transport_passive_only', @set_args)
+      # TODO: add "deprecated" warning?
+      self.transport_passive_mode = (val ? :passive_only : :none)
     end
 
     def transport_passive_only
-      result = config_get('bgp_neighbor', 'transport_passive_only', @get_args)
-      result ? true : false
+      transport_passive_mode == :passive_only
     end
 
     def default_transport_passive_only
-      config_get_default('bgp_neighbor', 'transport_passive_only')
+      default_transport_passive_mode == :passive_only
     end
 
     def update_source=(val)
@@ -406,5 +455,36 @@ module Cisco
     def default_update_source
       config_get_default('bgp_neighbor', 'update_source')
     end
+
+    def mode_symbol_to_cli(symbol)
+      symbol = symbol.downcase if symbol.is_a? String
+      case symbol
+      when :active_only
+        'active-only'
+      when :passive_only
+        'passive-only'
+      when :both
+        'both'
+      when :none
+        ''
+      else
+        fail KeyError
+      end
+    end
+
+    def mode_cli_to_symbol(cli)
+      case cli
+      when 'active-only'
+        :active_only
+      when 'passive-only'
+        :passive_only
+      when 'both'
+        :both
+      when ''
+        :none
+      else
+        fail KeyError
+      end
+    end
   end # class
 end # module

data/lib/cisco_node_utils/bgp_neighbor_af.rb

@@ -70,6 +70,13 @@ module Cisco
       fail ArgumentError, "'af' must be an array specifying afi and safi" unless
         af.is_a?(Array) || af.length == 2
 
+      # XR BGP does not support <address>/<mask>
+      if platform == :ios_xr && nbr['/'] == '/'
+        fail UnsupportedError.new(
+          'validate_args',
+          "IOS XR does not support 'slash' notation")
+      end
+
       nbr = Utils.process_network_mask(nbr)
       @asn = RouterBgp.validate_asnum(asn)
       @vrf = vrf
@@ -92,7 +99,7 @@ module Cisco
     # rubocop:enable Style/AccessorMethodNamefor
 
     def create
-      Feature.bgp_enable
+      Feature.bgp_enable if platform == :nexus
       set_args_keys(state: '')
       config_set('bgp_neighbor', 'af', @set_args)
     end
@@ -224,7 +231,8 @@ module Cisco
     end
 
     def default_additional_paths_receive
-      config_get_default('bgp_neighbor_af', 'additional_paths_receive').to_sym
+      ret = config_get_default('bgp_neighbor_af', 'additional_paths_receive')
+      ret.to_sym unless ret.nil?
     end
 
     # -----------------------
@@ -249,7 +257,8 @@ module Cisco
     end
 
     def default_additional_paths_send
-      config_get_default('bgp_neighbor_af', 'additional_paths_send').to_sym
+      ret = config_get_default('bgp_neighbor_af', 'additional_paths_send')
+      ret.to_sym unless ret.to_s == ''
     end
 
     # -----------------------
@@ -258,7 +267,7 @@ module Cisco
     def default_originate_get
       val = config_get('bgp_neighbor_af', 'default_originate', @get_args)
       return nil unless val
-      (val[/route-map/]) ? val.split.last : true
+      (val[/route-(map|policy)/]) ? val.split.last : true
     end
 
     def default_originate
@@ -272,7 +281,11 @@ module Cisco
     end
 
     def default_originate_set(state, map=nil)
-      map = "route-map #{map}" unless map.nil?
+      if platform == :ios_xr
+        map = "route-policy #{map}" unless map.nil?
+      else
+        map = "route-map #{map}" unless map.nil?
+      end
       set_args_keys(state: (state ? '' : 'no'), map: map)
       config_set('bgp_neighbor_af', 'default_originate', @set_args)
     end
@@ -545,23 +558,50 @@ module Cisco
     end
 
     # -----------------------
-    # <state> send-community [ both | extended | standard ]
-    # NOTE: 'standard' is default but does not nvgen on some platforms
-    # Returns: none, both, extended, or standard
+    # Nexus and XR implementations of send community differ enough that it makes
+    # sense to split up the individual methods to support them
     def send_community
       val = config_get('bgp_neighbor_af', 'send_community', @get_args)
       return default_send_community if val.nil?
+      platform == :nexus ? send_community_nexus(val) : send_community_xr(val)
+    end
+
+    # Nexus: <state> send-community [ both | extended | standard ]
+    #  NOTE: 'standard' is default but does not nvgen on some platforms
+    #  Returns: none, both, extended, or standard
+    def send_community_nexus(val)
       val = val.split.last
       return 'standard' if val[/send-community/] # Workaround
       val
     end
 
+    # XR: 'send-community-ebgp' and 'send-extended-community-ebgp' are
+    #  the equivalents of the NXOS: standard | extended functionality
+    #  Returns: node, 'send-community-ebgp', 'send-extended-community-ebgp' or
+    #  'send-community-ebgp send-extended-community-ebgp' which is the 'both'
+    # keyword equivalent
+    def send_community_xr(val)
+      if val == ['send-community-ebgp', 'send-extended-community-ebgp']
+        val = 'both'
+      elsif val == ['send-community-ebgp']
+        val = 'standard'
+      else # val == ['send-extended-community-ebgp']
+        val = 'extended'
+      end
+      val
+    end
+
     def send_community=(val)
+      platform == :nexus ? send_comm_nexus_set(val) : send_comm_ios_xr_set(val)
+    end
+
+    def send_comm_nexus_set(val)
       if val[/none/]
         state = 'no'
         val = 'both'
       end
       if val[/extended|standard/]
+        # Case where already configured.
         case send_community
         when /both/
           state = 'no'
@@ -580,6 +620,33 @@ module Cisco
       config_set('bgp_neighbor_af', 'send_community', @set_args)
     end
 
+    def send_comm_ios_xr_set(val)
+      case val.to_s
+      when 'none'
+        set_args_keys(state: 'no', attr: 'send-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+        set_args_keys(state: 'no', attr: 'send-extended-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+      when 'standard'
+        set_args_keys(state: '', attr: 'send-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+        set_args_keys(state: 'no', attr: 'send-extended-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+      when 'extended'
+        set_args_keys(state: 'no', attr: 'send-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+        set_args_keys(state: '', attr: 'send-extended-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+      when 'both'
+        set_args_keys(state: '', attr: 'send-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+        set_args_keys(state: '', attr: 'send-extended-community-ebgp')
+        config_set('bgp_neighbor_af', 'send_community', @set_args)
+      else
+        fail ArgumentError, "Invalid value '#{val}'"
+      end
+    end
+
     def default_send_community
       config_get_default('bgp_neighbor_af', 'send_community')
     end

data/lib/cisco_node_utils/bridge_domain.rb

@@ -0,0 +1,183 @@
+# NXAPI implementation of BridgeDomain class
+#
+# February 2016, Rohan Gandhi Korlepara
+#
+# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'node_util'
+require_relative 'feature'
+
+module Cisco
+  # node_utils class for bridge_domain
+  class BridgeDomain < NodeUtil
+    attr_reader :bd_ids
+
+    def initialize(bds, instantiate=true)
+      # Spaces are removed as bridge-domain cli doesn't accept value with
+      # space
+      @bd_ids = bds.to_s.gsub(/\s+/, '')
+      fail 'bridge-domain value is empty' if @bd_ids.empty? # no empty strings
+
+      create if instantiate
+    end
+
+    def to_s
+      "Bridge Domain #{bd_ids}"
+    end
+
+    # This will expand the string to a list of bds as integers
+    def self.bd_ids_to_array(bdid_string)
+      list = []
+      narray = bdid_string.split(',')
+      narray.each do |elem|
+        if elem.include?('-')
+          es = elem.gsub('-', '..')
+          ea = es.split('..').map { |d| Integer(d) }
+          er = ea[0]..ea[1]
+          list << er.to_a
+        else
+          list << elem.to_i
+        end
+      end
+      list.flatten
+    end
+
+    # This method will generate a batched string if a list is passed as
+    # argument
+    # Input would be as [1,2,3,4,5,10,11,12,7,30,100,31,32]
+    # output will be 1-5,10-12,7,30,100,31-32
+    def self.bd_list_to_string(bd_list)
+      farray = bd_list.compact
+      lranges = []
+      unless farray.empty?
+        left = bd_list.first
+        right = nil
+        farray.each do |aelem|
+          if right && aelem != right.succ
+            if left == right
+              lranges << left
+            else
+              lranges << Range.new(left, right)
+            end
+            left = aelem
+          end
+          right = aelem
+        end
+        if left == right
+          lranges << left
+        else
+          lranges << Range.new(left, right)
+        end
+      end
+      lranges.to_s.gsub('..', '-').delete('[').delete(']').delete(' ')
+    end
+
+    def self.bds
+      hash = {}
+      bd_list = config_get('bridge_domain', 'all_bds')
+      return hash if bd_list.nil?
+
+      final_bd_list =
+          bd_list.map { |elem| BridgeDomain.bd_ids_to_array(elem) }
+          .flatten.uniq.sort
+      final_bd_list.each do |id|
+        hash[id.to_s] = BridgeDomain.new(id, false)
+      end
+      hash
+    end
+
+    # This function will first add bds to the system bridge-domain and then
+    # create the bds. If bds already existing then just create. Else add the
+    # non added bds to system range first then create all. This is to avoid the
+    # idempotency issue as system add command throws error if a bd is already
+    # present in the system range.
+    def create
+      sys_bds_array = BridgeDomain.bd_ids_to_array(system_bridge_domain)
+      inp_bds_array = BridgeDomain.bd_ids_to_array(@bd_ids)
+      if (inp_bds_array - sys_bds_array).any?
+        add_bds = BridgeDomain.bd_list_to_string(inp_bds_array - sys_bds_array)
+        config_set('bridge_domain', 'system_bridge_domain', oper: 'add',
+                                                            bd:   add_bds)
+      end
+      config_set('bridge_domain', 'create', bd: @bd_ids)
+    end
+
+    def destroy
+      config_set('bridge_domain', 'destroy', bd: @bd_ids)
+      config_set('bridge_domain', 'system_bridge_domain', oper: 'remove',
+                                                          bd:   @bd_ids)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    # Bridge-Domain name assigning case
+    # bridge-domain 100
+    #   name bd100
+    def bd_name
+      config_get('bridge_domain', 'bd_name', bd: @bd_ids)
+    end
+
+    def bd_name=(str)
+      str = str.to_s
+      state = str.empty? ? 'no' : ''
+      config_set('bridge_domain', 'bd_name', bd: @bd_ids, state: state,
+                   name: str)
+    end
+
+    def default_bd_name
+      config_get_default('bridge_domain', 'bd_name')
+    end
+
+    # Bridge-Domain type change to fabric-control
+    # bridge-domain 100
+    #   fabric-control
+    # This type property can be defined only for one bd
+    def fabric_control
+      config_get('bridge_domain', 'fabric_control', bd: @bd_ids)
+    end
+
+    def fabric_control=(val)
+      state = (val) ? '' : 'no'
+      config_set('bridge_domain', 'fabric_control', bd: @bd_ids, state: state)
+    end
+
+    def default_fabric_control
+      config_get_default('bridge_domain', 'fabric_control')
+    end
+
+    # Bridge-Domain Shutdown case
+    # bridge-domain 100
+    #   shutdown
+    def shutdown
+      config_get('bridge_domain', 'shutdown', bd: @bd_ids)
+    end
+
+    def shutdown=(val)
+      state = (val) ? '' : 'no'
+      config_set('bridge_domain', 'shutdown', bd: @bd_ids, state: state)
+    end
+
+    def default_shutdown
+      config_get_default('bridge_domain', 'shutdown')
+    end
+
+    # getter for system bridge-domain
+    def system_bridge_domain
+      config_get('bridge_domain', 'system_bridge_domain')
+    end
+  end  # Class
+end    # Module