cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/stp_global.rb

@@ -0,0 +1,676 @@
+# January 2016, Sai Chintalapudi
+#
+# Copyright (c) 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 'interface'
+require_relative 'vlan'
+
+module Cisco
+  # node_utils class for stp_global
+  class StpGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name == 'default'
+      @name = name.downcase
+      @bdr = config_get('stp_global', 'bd_range')
+      @mr = config_get('stp_global', 'mst_range')
+      @mir = config_get('stp_global', 'mst_inst_range')
+      @vr = config_get('stp_global', 'vlan_range')
+    end
+
+    def self.globals
+      { 'default' => StpGlobal.new('default') }
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    # Getter: Builds an array of bd designated priority
+    # commands currently on the device.
+    # cli: bridge-domain 2-42 designated priority 40960
+    #      bridge-domain 83-92,1000-2300 designated priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def bd_designated_priority
+      config_get('stp_global', 'bd_designated_priority')
+    end
+
+    def bd_designated_priority=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_designated_priority',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_designated_priority')
+    end
+
+    def default_bd_designated_priority
+      config_get_default('stp_global', 'bd_designated_priority')
+    end
+
+    # Getter: Builds an array of bd forward time
+    # commands currently on the device.
+    # cli: spanning-tree bridge-domain 2-42 forward-time 4
+    #      spanning-tree bridge-domain 83-92,1000-2300 forward-time 30
+    # array: [['2-42', '4'], ['83-92,1000-2300', '30']]
+    #
+    def bd_forward_time
+      config_get('stp_global', 'bd_forward_time')
+    end
+
+    def bd_forward_time=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_forward_time',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_forward_time')
+    end
+
+    def default_bd_forward_time
+      config_get_default('stp_global', 'bd_forward_time')
+    end
+
+    # Getter: Builds an array of bd hello time
+    # commands currently on the device.
+    # cli: spanning-tree bridge-domain 2-42 hello-time 6
+    #      spanning-tree bridge-domain 83-92,1000-2300 hello-time 9
+    # array: [['2-42', '6'], ['83-92,1000-2300', '9']]
+    #
+    def bd_hello_time
+      config_get('stp_global', 'bd_hello_time')
+    end
+
+    def bd_hello_time=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_hello_time',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_hello_time')
+    end
+
+    def default_bd_hello_time
+      config_get_default('stp_global', 'bd_hello_time')
+    end
+
+    # Getter: Builds an array of bd max age
+    # commands currently on the device.
+    # cli: spanning-tree bridge-domain 2-42 max-age 10
+    #      spanning-tree bridge-domain 83-92,1000-2300 max-age 40
+    # array: [['2-42', '10'], ['83-92,1000-2300', '40']]
+    #
+    def bd_max_age
+      config_get('stp_global', 'bd_max_age')
+    end
+
+    def bd_max_age=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_max_age',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_max_age')
+    end
+
+    def default_bd_max_age
+      config_get_default('stp_global', 'bd_max_age')
+    end
+
+    # Getter: Builds an array of bd priority
+    # commands currently on the device.
+    # cli: spanning-tree bridge-domain 2-42 priority 40960
+    #      spanning-tree bridge-domain 83-92,1000-2300 priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def bd_priority
+      config_get('stp_global', 'bd_priority')
+    end
+
+    def bd_priority=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_priority',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_priority')
+    end
+
+    def default_bd_priority
+      config_get_default('stp_global', 'bd_priority')
+    end
+
+    # Getter: Builds an array of bd root priority
+    # commands currently on the device.
+    # cli: bridge-domain 2-42 root priority 40960
+    #      bridge-domain 83-92,1000-2300 root priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def bd_root_priority
+      config_get('stp_global', 'bd_root_priority')
+    end
+
+    def bd_root_priority=(list)
+      vlans = bd_total_range_with_vlans
+      config_set('stp_global', 'bd_root_priority',
+                 state: 'no',
+                 range: Utils.get_reset_range(@bdr, vlans),
+                 val:   '') if list.empty?
+      set_range_based_params(list, 'bd_root_priority')
+    end
+
+    def default_bd_root_priority
+      config_get_default('stp_global', 'bd_root_priority')
+    end
+
+    def bpdufilter
+      config_get('stp_global', 'bpdufilter')
+    end
+
+    def bpdufilter=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('stp_global', 'bpdufilter', state: no_cmd)
+    end
+
+    def default_bpdufilter
+      config_get_default('stp_global', 'bpdufilter')
+    end
+
+    def bpduguard
+      config_get('stp_global', 'bpduguard')
+    end
+
+    def bpduguard=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('stp_global', 'bpduguard', state: no_cmd)
+    end
+
+    def default_bpduguard
+      config_get_default('stp_global', 'bpduguard')
+    end
+
+    def bridge_assurance
+      config_get('stp_global', 'bridge_assurance')
+    end
+
+    def bridge_assurance=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('stp_global', 'bridge_assurance', state: no_cmd)
+    end
+
+    def default_bridge_assurance
+      config_get_default('stp_global', 'bridge_assurance')
+    end
+
+    def domain
+      config_get('stp_global', 'domain')
+    end
+
+    def domain=(val)
+      if val
+        state = ''
+      else
+        state = 'no'
+        val = '1' # dummy val to satisfy the CLI
+      end
+      config_set('stp_global',
+                 'domain', state: state, domain: val)
+    end
+
+    def default_domain
+      config_get_default('stp_global', 'domain')
+    end
+
+    def fcoe
+      config_get('stp_global', 'fcoe')
+    end
+
+    def fcoe=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('stp_global', 'fcoe', state: no_cmd)
+    end
+
+    def default_fcoe
+      config_get_default('stp_global', 'fcoe')
+    end
+
+    def loopguard
+      config_get('stp_global', 'loopguard')
+    end
+
+    def loopguard=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('stp_global', 'loopguard', state: no_cmd)
+    end
+
+    def default_loopguard
+      config_get_default('stp_global', 'loopguard')
+    end
+
+    def mode
+      config_get('stp_global', 'mode')
+    end
+
+    def mode=(val)
+      if val == default_mode
+        config_set('stp_global', 'mode', state: 'no', mode: '')
+      else
+        config_set('stp_global', 'mode', state: '', mode: val)
+      end
+    end
+
+    def default_mode
+      config_get_default('stp_global', 'mode')
+    end
+
+    # Getter: Builds an array of mst designated priority
+    # commands currently on the device.
+    # cli: spanning-tree mst 2-42 designated priority 40960
+    #      spanning-tree mst 83-92,1000-2300 designated priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def mst_designated_priority
+      config_get('stp_global', 'mst_designated_priority')
+    end
+
+    def mst_designated_priority=(list)
+      check_stp_mode_mst
+      config_set('stp_global', 'mst_designated_priority',
+                 state: 'no', range: @mr, val: '') if list.empty?
+      set_range_based_params(list, 'mst_designated_priority')
+    end
+
+    def default_mst_designated_priority
+      config_get_default('stp_global', 'mst_designated_priority')
+    end
+
+    def mst_forward_time
+      config_get('stp_global', 'mst_forward_time')
+    end
+
+    def mst_forward_time=(val)
+      check_stp_mode_mst
+      if val == default_mst_forward_time
+        state = 'no'
+        val = ''
+      else
+        state = ''
+      end
+      config_set('stp_global',
+                 'mst_forward_time', state: state, ft: val)
+    end
+
+    def default_mst_forward_time
+      config_get_default('stp_global', 'mst_forward_time')
+    end
+
+    def mst_hello_time
+      config_get('stp_global', 'mst_hello_time')
+    end
+
+    def mst_hello_time=(val)
+      check_stp_mode_mst
+      if val == default_mst_hello_time
+        state = 'no'
+        val = ''
+      else
+        state = ''
+      end
+      config_set('stp_global',
+                 'mst_hello_time', state: state, ht: val)
+    end
+
+    def default_mst_hello_time
+      config_get_default('stp_global', 'mst_hello_time')
+    end
+
+    # Getter: Builds an array of mst instance to vlan range
+    # commands currently on the device.
+    # cli: instance 2 vlan 6-47
+    #      instance 3000 vlan 1000-3200
+    # array: [['2', '6-47'], ['3000', '1000-3200']]
+    #
+    def mst_inst_vlan_map
+      config_get('stp_global', 'mst_inst_vlan_map')
+    end
+
+    def mst_inst_vlan_map=(list)
+      check_stp_mode_mst
+      config_set('stp_global', 'mst_inst_vlan_map', state: '',
+                 instance: '0', vlan: 'vlan', range: @mir) if list.empty?
+      list.each do |inst, range|
+        # if a particular range is set to default, use 'no' cmd
+        if range == 'default'
+          config_set('stp_global', 'mst_inst_vlan_map', state: 'no',
+                     instance: inst, vlan: '', range: '')
+        else
+          config_set('stp_global', 'mst_inst_vlan_map', state: '',
+                     instance: inst, vlan: 'vlan', range: range)
+        end
+      end
+    end
+
+    def default_mst_inst_vlan_map
+      config_get_default('stp_global', 'mst_inst_vlan_map')
+    end
+
+    def mst_max_age
+      config_get('stp_global', 'mst_max_age')
+    end
+
+    def mst_max_age=(val)
+      check_stp_mode_mst
+      if val == default_mst_max_age
+        state = 'no'
+        val = ''
+      else
+        state = ''
+      end
+      config_set('stp_global',
+                 'mst_max_age', state: state, ma: val)
+    end
+
+    def default_mst_max_age
+      config_get_default('stp_global', 'mst_max_age')
+    end
+
+    def mst_max_hops
+      config_get('stp_global', 'mst_max_hops')
+    end
+
+    def mst_max_hops=(val)
+      check_stp_mode_mst
+      if val == default_mst_max_hops
+        state = 'no'
+        val = ''
+      else
+        state = ''
+      end
+      config_set('stp_global',
+                 'mst_max_hops', state: state, mh: val)
+    end
+
+    def default_mst_max_hops
+      config_get_default('stp_global', 'mst_max_hops')
+    end
+
+    def mst_name
+      config_get('stp_global', 'mst_name')
+    end
+
+    def mst_name=(val)
+      check_stp_mode_mst
+      if val
+        state = ''
+      else
+        state = 'no'
+        val = ''
+      end
+      config_set('stp_global',
+                 'mst_name', state: state, name: val)
+    end
+
+    def default_mst_name
+      config_get_default('stp_global', 'mst_name')
+    end
+
+    # Getter: Builds an array of mst priority
+    # commands currently on the device.
+    # cli: spanning-tree mst 2-42 priority 40960
+    #      spanning-tree mst 83-92,1000-2300 priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def mst_priority
+      config_get('stp_global', 'mst_priority')
+    end
+
+    def mst_priority=(list)
+      check_stp_mode_mst
+      config_set('stp_global', 'mst_priority',
+                 state: 'no', range: @mr, val: '') if list.empty?
+      set_range_based_params(list, 'mst_priority')
+    end
+
+    def default_mst_priority
+      config_get_default('stp_global', 'mst_priority')
+    end
+
+    def mst_revision
+      config_get('stp_global', 'mst_revision')
+    end
+
+    def mst_revision=(val)
+      check_stp_mode_mst
+      if val.zero?
+        state = 'no'
+        val = ''
+      else
+        state = ''
+      end
+      config_set('stp_global',
+                 'mst_revision', state: state, rev: val)
+    end
+
+    def default_mst_revision
+      config_get_default('stp_global', 'mst_revision')
+    end
+
+    # Getter: Builds an array of mst root priority
+    # commands currently on the device.
+    # cli: spanning-tree mst 2-42 root priority 40960
+    #      spanning-tree mst 83-92,1000-2300 root priority 53248
+    # array: [['2-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def mst_root_priority
+      config_get('stp_global', 'mst_root_priority')
+    end
+
+    def mst_root_priority=(list)
+      check_stp_mode_mst
+      config_set('stp_global', 'mst_root_priority',
+                 state: 'no', range: @mr, val: '') if list.empty?
+      set_range_based_params(list, 'mst_root_priority')
+    end
+
+    def default_mst_root_priority
+      config_get_default('stp_global', 'mst_root_priority')
+    end
+
+    def pathcost
+      config_get('stp_global', 'pathcost')
+    end
+
+    def pathcost=(val)
+      if val == default_pathcost
+        config_set('stp_global', 'pathcost', state: 'no', method: '')
+      else
+        config_set('stp_global', 'pathcost', state: '', method: val)
+      end
+    end
+
+    def default_pathcost
+      config_get_default('stp_global', 'pathcost')
+    end
+
+    # Getter: Builds an array of vlan designated priority
+    # commands currently on the device.
+    # cli: vlan 1-42 designated priority 40960
+    #      vlan 83-92,1000-2300 designated priority 53248
+    # array: [['1-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def vlan_designated_priority
+      config_get('stp_global', 'vlan_designated_priority')
+    end
+
+    def vlan_designated_priority=(list)
+      config_set('stp_global', 'vlan_designated_priority',
+                 state: 'no', range: @vr, val: '') if list.empty?
+      set_range_based_params(list, 'vlan_designated_priority')
+    end
+
+    def default_vlan_designated_priority
+      config_get_default('stp_global', 'vlan_designated_priority')
+    end
+
+    # Getter: Builds an array of vlan forward time
+    # commands currently on the device.
+    # cli: spanning-tree vlan 1-42 forward-time 19
+    #      spanning-tree vlan 3000-3700 forward-time 13
+    # array: [['1-42', '19'], ['3000-3700', '13']]
+    #
+    def vlan_forward_time
+      config_get('stp_global', 'vlan_forward_time')
+    end
+
+    def vlan_forward_time=(list)
+      config_set('stp_global', 'vlan_forward_time',
+                 state: 'no', range: @vr, val: '') if list.empty?
+      set_range_based_params(list, 'vlan_forward_time')
+    end
+
+    def default_vlan_forward_time
+      config_get_default('stp_global', 'vlan_forward_time')
+    end
+
+    # Getter: Builds an array of vlan hello time
+    # commands currently on the device.
+    # cli: spanning-tree vlan 1-42 hello-time 10
+    #      spanning-tree vlan 3000-3700 hello-time 6
+    # array: [['1-42', '10'], ['3000-3700', '6']]
+    #
+    def vlan_hello_time
+      config_get('stp_global', 'vlan_hello_time')
+    end
+
+    def vlan_hello_time=(list)
+      config_set('stp_global', 'vlan_hello_time',
+                 state: '', range: @vr, val: '2') if list.empty?
+      list.each do |range, property_value|
+        if property_value == 'default'
+          config_set('stp_global', 'vlan_hello_time',
+                     state: '', range: range, val: '2')
+        else
+          config_set('stp_global', 'vlan_hello_time',
+                     state: '', range: range, val: property_value)
+        end
+      end
+    end
+
+    def default_vlan_hello_time
+      config_get_default('stp_global', 'vlan_hello_time')
+    end
+
+    # Getter: Builds an array of vlan max-age
+    # commands currently on the device.
+    # cli: spanning-tree vlan 1-42 max-age 21
+    #      spanning-tree vlan 3000-3700 max-age 13
+    # array: [['1-42', '21'], ['3000-3700', '13']]
+    #
+    def vlan_max_age
+      config_get('stp_global', 'vlan_max_age')
+    end
+
+    def vlan_max_age=(list)
+      config_set('stp_global', 'vlan_max_age',
+                 state: 'no', range: @vr, val: '') if list.empty?
+      set_range_based_params(list, 'vlan_max_age')
+    end
+
+    def default_vlan_max_age
+      config_get_default('stp_global', 'vlan_max_age')
+    end
+
+    # Getter: Builds an array of vlan priority
+    # commands currently on the device.
+    # cli: spanning-tree vlan 1-42 priority 40960
+    #      spanning-tree vlan 83-92,1000-2300 priority 53248
+    # array: [['1-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def vlan_priority
+      config_get('stp_global', 'vlan_priority')
+    end
+
+    def vlan_priority=(list)
+      config_set('stp_global', 'vlan_priority',
+                 state: 'no', range: @vr, val: '') if list.empty?
+      set_range_based_params(list, 'vlan_priority')
+    end
+
+    def default_vlan_priority
+      config_get_default('stp_global', 'vlan_priority')
+    end
+
+    # Getter: Builds an array of vlan root priority
+    # commands currently on the device.
+    # cli: vlan 1-42 root priority 40960
+    #      vlan 83-92,1000-2300 root priority 53248
+    # array: [['1-42', '40960'], ['83-92,1000-2300', '53248']]
+    #
+    def vlan_root_priority
+      config_get('stp_global', 'vlan_root_priority')
+    end
+
+    def vlan_root_priority=(list)
+      config_set('stp_global', 'vlan_root_priority',
+                 state: 'no', range: @vr, val: '') if list.empty?
+      set_range_based_params(list, 'vlan_root_priority')
+    end
+
+    def default_vlan_root_priority
+      config_get_default('stp_global', 'vlan_root_priority')
+    end
+
+    def check_stp_mode_mst
+      fail "#{caller[0][/`.*'/][1..-2]} cannot be set unless spanning-tree" \
+        ' mode is mst' unless mode == 'mst'
+    end
+
+    # bridge-domain and vlans are mutually exclusive
+    # so when there are vlans, we need to remove them
+    # from the bd range while restting
+    def bd_total_range_with_vlans
+      hash = Vlan.vlans
+      arr = []
+      hash.keys.each do |id|
+        arr << id.to_i
+      end
+      Utils.array_to_str(arr)
+      ret_arr = []
+      ret_arr << Utils.array_to_str(arr)
+    end
+
+    def set_range_based_params(list, param_name)
+      list.each do |range, property_value|
+        # if a particular range is set to default, use 'no' cmd
+        if property_value == 'default'
+          config_set('stp_global', param_name,
+                     state: 'no', range: range, val: '')
+        else
+          config_set('stp_global', param_name,
+                     state: '', range: range, val: property_value)
+        end
+      end
+    end
+  end # class
+end # module