cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/bridge_domain.rb

@@ -0,0 +1,178 @@
+# 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                      #
+    ########################################################
+
+    def bd_name
+      config_get('bridge_domain', 'bd_name', bd: @bd_ids)
+    end
+
+    def bd_name=(str)
+      state = str.empty? ? 'no' : ''
+      config_set('bridge_domain', 'bd_name', bd: @bd_ids, state: state,
+                   name: str)
+    end
+
+    # This default getter is a bit different them most.  When a brige-domain
+    # gets created it gets a default name assigned that follows the pattern
+    # 'Bridge-DomainX' where X is the bridge domain id (@bd_ids).
+    def default_bd_name
+      'Bridge-Domain' + @bd_ids
+    end
+
+    # This type property can be defined only for one bd
+    def fabric_control
+      match = config_get('bridge_domain', 'fabric_control', bd: @bd_ids)
+      match.to_s == @bd_ids ? true : false
+    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
+
+    def shutdown
+      match = config_get('bridge_domain', 'shutdown', bd: @bd_ids)
+      match == 'Noshutdown' ? false : true
+    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

data/lib/cisco_node_utils/bridge_domain_vni.rb

@@ -0,0 +1,206 @@
+# NXAPI implementation of BridgeDomainVNI 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_vni
+  class BridgeDomainVNI < NodeUtil
+    attr_reader :bd_ids, :bd_ids_list
+
+    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
+
+      @bd_ids_list = BridgeDomainVNI.string_to_array(@bd_ids)
+      create if instantiate
+    end
+
+    def to_s
+      "Bridge Domain #{bd_ids}"
+    end
+
+    def self.range_bds
+      hash = {}
+      bd_list = config_get('bridge_domain_vni', 'range_bds')
+      return hash if bd_list.nil?
+
+      bd_list.each do |id|
+        hash[id] = BridgeDomainVNI.new(id, false)
+      end
+      hash
+    end
+
+    # This will expand the string to a list of bds as integers
+    def self.string_to_array(string)
+      list = []
+      narray = 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
+
+    # Example clis;
+    # system bridge-domain 101-200
+    # bridge-domain 101-200
+    # bridge-domain 101-110,120,141-145,180
+    #   member vni 6001-6011,5041-5044,8000,9000
+    #
+    # config_get('bridge_domain_vni', 'member_vni')
+    # will get the current member vni in this case
+    # 6001-6011,5041-5044,8000,9000
+    #
+    # config_get('bridge_domain_vni', 'member_vni_bd')
+    # will get the current bd's mapped to member vni in this case
+    # 101-110,120,141-145,180
+    #
+    # The @bd_ids_list which is created when the BridgeDomainVNI object is
+    # initialized which could be 101-110 bd range.
+    # hash_map will have 101=>6001,102=>6002...120=>6011,141=>5041...180=>9000
+    # And the final_bd_vni hash will be based of the initialized list
+    # 101=>6001,102=>6002,103=>6003....110=>6010 only.
+    def curr_bd_vni_hash
+      final_bd_vni = {}
+      curr_vni = config_get('bridge_domain_vni', 'member_vni')
+      curr_bd_vni = config_get('bridge_domain_vni', 'member_vni_bd')
+      return final_bd_vni if curr_vni.empty? || curr_bd_vni.empty?
+
+      curr_vni_list = BridgeDomainVNI.string_to_array(curr_vni)
+      curr_bd_vni_list = BridgeDomainVNI.string_to_array(curr_bd_vni)
+
+      hash_map = Hash[curr_bd_vni_list.zip(curr_vni_list.map)]
+      @bd_ids_list.each do |bd|
+        final_bd_vni[bd.to_i] = hash_map[bd.to_i] if hash_map.key?(bd.to_i)
+      end
+      final_bd_vni
+    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 = BridgeDomainVNI.string_to_array(system_bridge_domain)
+      if (@bd_ids_list - sys_bds_array).any?
+        add_bds = Utils
+                  .array_to_str((@bd_ids_list - sys_bds_array), false)
+        config_set('bridge_domain_vni', 'system_bridge_domain', oper: 'add',
+                                                                bd:   add_bds)
+      end
+      config_set('bridge_domain_vni', 'create', bd: @bd_ids)
+    end
+
+    def destroy
+      bd_vni = curr_bd_vni_hash
+      bd_val = bd_vni.keys.join(',')
+      vni_val = bd_vni.values.join(',')
+      return '' if vni_val.empty?
+      config_set('bridge_domain_vni', 'member_vni', bd: bd_val,
+                 membstate: 'no', membvni: vni_val)
+      config_set('bridge_domain_vni', 'vni', state: 'no', vni: vni_val)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    # Bridge-Domain member vni assigning case
+    # Not all the bds created or initialized in this class context can have the
+    # member vni's mapped. So will get the vnis of the ones which are mapped to
+    # the bds.
+    # Eg: Suppose the bd mapping is as below on the switch
+    # bridge-domain 100,105,107-109,150
+    #   member vni 5000, 8000, 5007-5008, 7000, 5050
+    # If puppet layer tries to get values of 100,105,107 bds as defined in
+    # manifest then the final_bd_vni map which is returned will contain only
+    # these mappings as below;
+    # '5000,8000,5007'
+    # This is also to handle the idempotence case, and if any mismatch then set
+    # the member_vni
+    def member_vni
+      bd_vni_hash = curr_bd_vni_hash
+      ret_list = []
+      @bd_ids_list.each do |bd|
+        ret_list << bd_vni_hash[bd]
+      end
+      Utils.array_to_str(ret_list, false)
+    end
+
+    # This member_vni mapping will be executed only when the val is not empty
+    # else it will be treated as a 'no' cli and executed as required.
+    # If the mappings do not match in any fashion then cli normally returns a
+    # failure which will be handled.
+    # During set of member vni we first see if any bd is mapped to some other
+    # vni, if yes then remove that one and apply the new vni.
+    # Eg: bridge-domain 100-110
+    #       member vni 5100-5110
+    # Now the manifest is changed to 5100-5105,6106-6110, so hence first
+    # 5106-5110 mapping is removed and then 6106-6110 is applied.
+    def member_vni=(val)
+      val = val.to_s
+      Feature.vni_enable
+      bd_vni = curr_bd_vni_hash
+      if val.empty?
+        bd_val = bd_vni.keys.join(',')
+        vni_val = bd_vni.values.join(',')
+        return '' if vni_val.empty?
+        config_set('bridge_domain_vni', 'member_vni', bd: bd_val,
+                   membstate: 'no', membvni: vni_val)
+        config_set('bridge_domain_vni', 'vni', state: 'no', vni: vni_val)
+      else
+        unless bd_vni.empty?
+          inp_vni_list = BridgeDomainVNI.string_to_array(val.to_s)
+          inp_bd_vni_hash = Hash[@bd_ids_list.zip(inp_vni_list)]
+
+          temp_hash = bd_vni.to_a.keep_if { |k, _v| inp_bd_vni_hash.key? k }
+          rem_hash = (temp_hash.to_a - inp_bd_vni_hash.to_a).to_h
+
+          rm_bd = rem_hash.keys.join(',')
+          rm_vni = rem_hash.values.join(',')
+          config_set('bridge_domain_vni', 'member_vni', bd: rm_bd,
+                     membstate: 'no', membvni: rm_vni)
+          config_set('bridge_domain_vni', 'vni', state: 'no', vni: rm_vni)
+        end
+        config_set('bridge_domain_vni', 'vni', state: '', vni: val)
+        config_set('bridge_domain_vni', 'member_vni', bd: @bd_ids,
+                   membstate: '', membvni: val)
+      end
+    end
+
+    def default_member_vni
+      config_get_default('bridge_domain_vni', 'member_vni')
+    end
+
+    # getter for system bridge-domain
+    def system_bridge_domain
+      config_get('bridge_domain_vni', 'system_bridge_domain')
+    end
+  end  # Class
+end    # Module