cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/router_ospf_area_vlink.rb

@@ -0,0 +1,313 @@
+#
+# NXAPI implementation of Router OSPF Area Virtual-link class
+#
+# June 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 'router_ospf_vrf'
+
+module Cisco
+  # node_utils class for ospf_area_vlink
+  class RouterOspfAreaVirtualLink < NodeUtil
+    attr_reader :router, :vrf, :area_id, :vl
+
+    def initialize(ospf_router, vrf_name, area_id, virtual_link,
+                   instantiate=true)
+      fail TypeError unless ospf_router.is_a?(String)
+      fail TypeError unless vrf_name.is_a?(String)
+      fail ArgumentError unless ospf_router.length > 0
+      fail ArgumentError unless vrf_name.length > 0
+      @area_id = area_id.to_s
+      fail ArgumentError if @area_id.empty?
+      fail ArgumentError unless virtual_link.length > 0
+
+      # Convert to dot-notation
+      @router = ospf_router
+      @vrf = vrf_name
+      @area_id = IPAddr.new(area_id.to_i, Socket::AF_INET) unless @area_id[/\./]
+      @vl = virtual_link
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    def self.virtual_links
+      hash = {}
+      RouterOspf.routers.each do |name, _obj|
+        # get all virtual_links under default vrf
+        links = config_get('ospf_area_vlink', 'virtual_links', name: name)
+        unless links.nil?
+          hash[name] = {}
+          hash[name]['default'] = {}
+          links.each do |area, vl|
+            hash[name]['default'][area] ||= {}
+            hash[name]['default'][area][vl] =
+              RouterOspfAreaVirtualLink.new(name, 'default', area, vl, false)
+          end
+        end
+        vrf_ids = config_get('ospf', 'vrf', name: name)
+        next if vrf_ids.nil?
+        vrf_ids.each do |vrf|
+          # get all virtual_links under each vrf
+          links = config_get('ospf_area_vlink', 'virtual_links',
+                             name: name, vrf: vrf)
+          next if links.nil?
+          hash[name] ||= {}
+          hash[name][vrf] = {}
+          links.each do |area, vl|
+            hash[name][vrf][area] ||= {}
+            hash[name][vrf][area][vl] =
+              RouterOspfAreaVirtualLink.new(name, vrf, area, vl, false)
+          end
+        end
+      end
+      hash
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { name: @router, area: @area_id, vl: @vl }
+      @set_args[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    # Create one router ospf area virtual-link instance
+    def create
+      RouterOspfVrf.new(@router, @vrf)
+      set_args_keys(state: '')
+      config_set('ospf_area_vlink', 'virtual_links', @set_args)
+    end
+
+    def destroy
+      return unless Feature.ospf_enabled?
+      set_args_keys(state: 'no')
+      config_set('ospf_area_vlink', 'virtual_links', @set_args)
+    end
+
+    def ==(other)
+      (ospf_router == other.ospf_router) &&
+        (vrf_name == other.vrf_name) && (area_id == other.area_id) &&
+        (vl == other.vl)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    # CLI can be either of the following or none
+    # authentication
+    # authentication message-digest
+    # authentication null
+    def authentication
+      auth = config_get('ospf_area_vlink', 'authentication', @get_args)
+      return default_authentication unless auth
+      if auth.include?('message-digest')
+        return 'md5'
+      elsif auth.include?('null')
+        return 'null'
+      else
+        return 'cleartext'
+      end
+    end
+
+    def authentication=(val)
+      state = val ? '' : 'no'
+      if val.to_s == 'md5'
+        auth = 'message-digest'
+      elsif val.to_s == 'null'
+        auth = 'null'
+      else
+        auth = ''
+      end
+      set_args_keys(state: state, auth: auth)
+      config_set('ospf_area_vlink', 'authentication', @set_args)
+    end
+
+    def default_authentication
+      config_get_default('ospf_area_vlink', 'authentication')
+    end
+
+    def auth_key_chain
+      config_get('ospf_area_vlink', 'auth_key_chain', @get_args)
+    end
+
+    def auth_key_chain=(val)
+      state = val ? '' : 'no'
+      id = val ? val : ''
+      set_args_keys(state: state, key_id: id)
+      config_set('ospf_area_vlink', 'auth_key_chain', @set_args)
+    end
+
+    def default_auth_key_chain
+      config_get_default('ospf_area_vlink', 'auth_key_chain')
+    end
+
+    def authentication_key_encryption_type
+      Encryption.cli_to_symbol(
+        config_get('ospf_area_vlink', 'authentication_key_enc_type', @get_args))
+    end
+
+    def default_authentication_key_encryption_type
+      Encryption.cli_to_symbol(
+        config_get_default('ospf_area_vlink', 'authentication_key_enc_type'))
+    end
+
+    def authentication_key_password
+      config_get('ospf_area_vlink', 'authentication_key_password', @get_args)
+    end
+
+    def default_authentication_key_password
+      config_get_default('ospf_area_vlink', 'authentication_key_password')
+    end
+
+    # example CLI:
+    # authentication-key 3 3109a60f51374a0d
+    # To remove the authentication-key altogether,
+    # set the password to empty string
+    def authentication_key_set(enctype, pw)
+      state = pw.empty? ? 'no' : ''
+      enctype = pw.empty? ? '' : Encryption.symbol_to_cli(enctype)
+      set_args_keys(state: state, enctype: enctype, password: pw)
+      config_set('ospf_area_vlink', 'authentication_key_set', @set_args)
+    end
+
+    def message_digest_algorithm_type
+      config_get('ospf_area_vlink', 'message_digest_key_alg_type',
+                 @get_args).to_sym
+    end
+
+    def default_message_digest_algorithm_type
+      config_get_default('ospf_area_vlink',
+                         'message_digest_key_alg_type').to_sym
+    end
+
+    def message_digest_encryption_type
+      Encryption.cli_to_symbol(
+        config_get('ospf_area_vlink', 'message_digest_key_enc_type', @get_args))
+    end
+
+    def default_message_digest_encryption_type
+      Encryption.cli_to_symbol(
+        config_get_default('ospf_area_vlink', 'message_digest_key_enc_type'))
+    end
+
+    def message_digest_key_id
+      config_get('ospf_area_vlink', 'message_digest_key_id', @get_args)
+    end
+
+    def default_message_digest_key_id
+      config_get_default('ospf_area_vlink', 'message_digest_key_id')
+    end
+
+    def message_digest_password
+      config_get('ospf_area_vlink', 'message_digest_key_password', @get_args)
+    end
+
+    def default_message_digest_password
+      config_get_default('ospf_area_vlink', 'message_digest_key_password')
+    end
+
+    # example CLI:
+    # message-digest-key 39 md5 7 046E1803362E595C260E0B240619050A2D
+    # To remove the message-digest-key altogether,
+    # set the password to empty string
+    def message_digest_key_set(keyid, algtype, enctype, pw)
+      return if pw.empty? && message_digest_password.empty?
+      # To remove the configuration, the entire previous
+      # configuration must be given with 'no' cmd
+      state = pw.empty? ? 'no' : ''
+      algtype = pw.empty? ? message_digest_algorithm_type : algtype.to_s
+      if pw.empty?
+        enctype = Encryption.symbol_to_cli(
+          message_digest_encryption_type.to_sym)
+      else
+        enctype = Encryption.symbol_to_cli(enctype)
+      end
+      keyid = pw.empty? ? message_digest_key_id : keyid
+      pw = pw.empty? ? message_digest_password : pw
+      set_args_keys(state: state, keyid: keyid, algtype: algtype,
+                    enctype: enctype, password: pw)
+      config_set('ospf_area_vlink', 'message_digest_key_set', @set_args)
+    end
+
+    def dead_interval
+      config_get('ospf_area_vlink', 'dead_interval', @get_args)
+    end
+
+    def dead_interval=(val)
+      state = val == default_dead_interval ? 'no' : ''
+      interval = val == default_dead_interval ? '' : val
+      set_args_keys(state: state, interval: interval)
+      config_set('ospf_area_vlink', 'dead_interval', @set_args)
+    end
+
+    def default_dead_interval
+      config_get_default('ospf_area_vlink', 'dead_interval')
+    end
+
+    def hello_interval
+      config_get('ospf_area_vlink', 'hello_interval', @get_args)
+    end
+
+    def hello_interval=(val)
+      state = val == default_hello_interval ? 'no' : ''
+      interval = val == default_hello_interval ? '' : val
+      set_args_keys(state: state, interval: interval)
+      config_set('ospf_area_vlink', 'hello_interval', @set_args)
+    end
+
+    def default_hello_interval
+      config_get_default('ospf_area_vlink', 'hello_interval')
+    end
+
+    def retransmit_interval
+      config_get('ospf_area_vlink', 'retransmit_interval', @get_args)
+    end
+
+    def retransmit_interval=(val)
+      state = val == default_retransmit_interval ? 'no' : ''
+      interval = val == default_retransmit_interval ? '' : val
+      set_args_keys(state: state, interval: interval)
+      config_set('ospf_area_vlink', 'retransmit_interval', @set_args)
+    end
+
+    def default_retransmit_interval
+      config_get_default('ospf_area_vlink', 'retransmit_interval')
+    end
+
+    def transmit_delay
+      config_get('ospf_area_vlink', 'transmit_delay', @get_args)
+    end
+
+    def transmit_delay=(val)
+      state = val == default_transmit_delay ? 'no' : ''
+      delay = val == default_transmit_delay ? '' : val
+      set_args_keys(state: state, delay: delay)
+      config_set('ospf_area_vlink', 'transmit_delay', @set_args)
+    end
+
+    def default_transmit_delay
+      config_get_default('ospf_area_vlink', 'transmit_delay')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/router_ospf_vrf.rb

@@ -0,0 +1,342 @@
+# Mike Wiebe, March 2015
+#
+# 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 'router_ospf'
+
+module Cisco
+  # RouterOspfVrf - node utility class for per-VRF OSPF config management
+  class RouterOspfVrf < NodeUtil
+    attr_reader :name, :parent
+
+    OSPF_AUTO_COST = {
+      mbps: 'Mbps',
+      gbps: 'Gbps',
+    }
+
+    OSPF_LOG_ADJACENCY = {
+      none:   'none',
+      log:    '',
+      detail: 'detail',
+    }
+
+    def initialize(router, name, instantiate=true)
+      fail TypeError if router.nil?
+      fail TypeError if name.nil?
+      fail ArgumentError unless router.length > 0
+      fail ArgumentError unless name.length > 0
+      @router = router
+      @name = name
+      @parent = {}
+      set_args_keys_default
+
+      create if instantiate
+    end
+
+    # Create a hash of all router ospf vrf instances
+    def self.vrfs
+      hash_final = {}
+      RouterOspf.routers.each do |instance|
+        name = instance[0]
+        vrf_ids = config_get('ospf', 'vrf', name: name)
+        hash_tmp = {
+          name => { 'default' => RouterOspfVrf.new(name, 'default', false) }
+        }
+        unless vrf_ids.nil?
+          vrf_ids.each do |vrf|
+            hash_tmp[name][vrf] = RouterOspfVrf.new(name, vrf, false)
+          end
+        end
+        hash_final.merge!(hash_tmp)
+      end
+      hash_final
+    end
+
+    # Create one router ospf vrf instance
+    def create
+      @parent = RouterOspf.new(@router)
+      config_set('ospf', 'vrf',
+                 name: @router, state: '', vrf: @name) if @name != 'default'
+    end
+
+    # Destroy one router ospf vrf instance
+    def destroy
+      fail RuntimeError if @name == 'default'
+      config_set('ospf', 'vrf', name: @router, state: 'no', vrf: @name)
+    end
+
+    # Helper method to delete @set_args hash keys
+    def delete_set_args_keys(list)
+      list.each { |key| @set_args.delete(key) }
+    end
+
+    #
+    # Helper methods to delete @set_args hash keys
+    #
+    def set_args_keys_default
+      keys = { name: @router }
+      keys[:vrf] = @name unless @name == 'default'
+      @get_args = @set_args = keys
+    end
+
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def auto_cost
+      match = config_get('ospf', 'auto_cost', @get_args)
+      return default_auto_cost if match.nil?
+      if match.last.nil?
+        [match.first.to_i, OSPF_AUTO_COST[:mbps]]
+      else
+        [match.first.to_i, match.last]
+      end
+    end
+
+    def auto_cost_set(cost, type)
+      @set_args[:cost] = cost
+      @set_args[:type] = OSPF_AUTO_COST[type]
+      config_set('ospf', 'auto_cost', @set_args)
+      delete_set_args_keys([:cost, :type])
+    end
+
+    def default_auto_cost
+      config_get_default('ospf', 'auto_cost')
+    end
+
+    def bfd
+      config_get('ospf', 'bfd', @get_args)
+    end
+
+    def bfd=(state)
+      return if state == bfd
+      no_cmd = (state ? '' : 'no')
+      @set_args[:state] = no_cmd
+      Feature.bfd_enable
+      config_set('ospf', 'bfd', @set_args)
+      delete_set_args_keys([:state])
+    end
+
+    def default_bfd
+      config_get_default('ospf', 'bfd')
+    end
+
+    def default_metric
+      config_get('ospf', 'default_metric', @get_args)
+    end
+
+    def default_metric=(metric)
+      if metric == default_default_metric
+        @set_args[:state] = 'no'
+        @set_args[:metric] = ''
+      else
+        @set_args[:state] = ''
+        @set_args[:metric] = metric
+      end
+      config_set('ospf', 'default_metric', @set_args)
+      delete_set_args_keys([:state, :metric])
+    end
+
+    def default_default_metric
+      config_get_default('ospf', 'default_metric')
+    end
+
+    def log_adjacency
+      match = config_get('ospf', 'log_adjacency', @get_args)
+      return default_log_adjacency if match.nil?
+      match.flatten.last.nil? ? :log : :detail
+    end
+
+    def log_adjacency=(type)
+      case type
+      when :none
+        @set_args[:state] = 'no'
+        @set_args[:type] = ''
+      when :log, :detail
+        @set_args[:state] = ''
+        @set_args[:type] = OSPF_LOG_ADJACENCY[type]
+      end
+      config_set('ospf', 'log_adjacency', @set_args)
+      delete_set_args_keys([:state, :type])
+    end
+
+    def default_log_adjacency
+      config_get_default('ospf', 'log_adjacency')
+    end
+
+    #
+    # Redistribute
+    #
+
+    # Build an array of all redistribute commands currently on the device
+    def redistribute
+      c = config_get('ospf', 'redistribute', @get_args)
+      c.nil? ? nil : c.each(&:compact!).sort
+    end
+
+    # redistribute setter.
+    # Process a hash of redistribute commands from delta_add_remove().
+    def redistribute=(should)
+      delta_hash = Utils.delta_add_remove(should, redistribute)
+      return if delta_hash.values.flatten.empty?
+      [:add, :remove].each do |action|
+        Cisco::Logger.debug("redistribute delta #{@get_args}\n #{action}: " \
+                            "#{delta_hash[action]}")
+        delta_hash[action].each do |protocol, route_map|
+          state = (action == :add) ? '' : 'no'
+          set_args_keys(state: state, protocol: protocol, route_map: route_map)
+          config_set('ospf', 'redistribute', @set_args)
+        end
+      end
+    end
+
+    def default_redistribute
+      config_get_default('ospf', 'redistribute')
+    end
+
+    def router_id
+      config_get('ospf', 'router_id', @get_args)
+    end
+
+    def router_id=(rid)
+      if rid == default_router_id
+        @set_args[:state] = 'no'
+        @set_args[:router_id] = router_id
+      else
+        @set_args[:state] = ''
+        @set_args[:router_id] = rid
+      end
+
+      config_set('ospf', 'router_id', @set_args)
+      delete_set_args_keys([:state, :router_id])
+    end
+
+    def default_router_id
+      config_get_default('ospf', 'router_id')
+    end
+
+    def timer_throttle_lsa
+      match = config_get('ospf', 'timer_throttle_lsa', @get_args)
+      if match.nil?
+        default_timer_throttle_lsa
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def timer_throttle_lsa_start
+      start, _hold, _max = timer_throttle_lsa
+      return default_timer_throttle_lsa_start if start.nil?
+      start
+    end
+
+    def timer_throttle_lsa_hold
+      _start, hold, _max = timer_throttle_lsa
+      return default_timer_throttle_lsa_hold if hold.nil?
+      hold
+    end
+
+    def timer_throttle_lsa_max
+      _start, _hold, max = timer_throttle_lsa
+      return default_timer_throttle_lsa_max if max.nil?
+      max
+    end
+
+    def timer_throttle_lsa_set(start, hold, max)
+      @set_args[:start] = start
+      @set_args[:hold] = hold
+      @set_args[:max] = max
+      config_set('ospf', 'timer_throttle_lsa', @set_args)
+      delete_set_args_keys([:start, :hold, :max])
+    end
+
+    def default_timer_throttle_lsa
+      [default_timer_throttle_lsa_start,
+       default_timer_throttle_lsa_hold,
+       default_timer_throttle_lsa_max]
+    end
+
+    def default_timer_throttle_lsa_start
+      config_get_default('ospf', 'timer_throttle_lsa_start')
+    end
+
+    def default_timer_throttle_lsa_hold
+      config_get_default('ospf', 'timer_throttle_lsa_hold')
+    end
+
+    def default_timer_throttle_lsa_max
+      config_get_default('ospf', 'timer_throttle_lsa_max')
+    end
+
+    def timer_throttle_spf
+      match = config_get('ospf', 'timer_throttle_spf', @get_args)
+      if match.nil?
+        default_timer_throttle_spf
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def timer_throttle_spf_start
+      start, _hold, _max = timer_throttle_spf
+      return default_timer_throttle_spf_start if start.nil?
+      start
+    end
+
+    def timer_throttle_spf_hold
+      _start, hold, _max = timer_throttle_spf
+      return default_timer_throttle_spf_hold if hold.nil?
+      hold
+    end
+
+    def timer_throttle_spf_max
+      _start, _hold, max = timer_throttle_spf
+      return default_timer_throttle_spf_max if max.nil?
+      max
+    end
+
+    def timer_throttle_spf_set(start, hold, max)
+      @set_args[:start] = start
+      @set_args[:hold] = hold
+      @set_args[:max] = max
+      config_set('ospf', 'timer_throttle_spf', @set_args)
+      delete_set_args_keys([:start, :hold, :max])
+    end
+
+    def default_timer_throttle_spf
+      [default_timer_throttle_spf_start,
+       default_timer_throttle_spf_hold,
+       default_timer_throttle_spf_max]
+    end
+
+    def default_timer_throttle_spf_start
+      config_get_default('ospf', 'timer_throttle_spf_start')
+    end
+
+    def default_timer_throttle_spf_hold
+      config_get_default('ospf', 'timer_throttle_spf_hold')
+    end
+
+    def default_timer_throttle_spf_max
+      config_get_default('ospf', 'timer_throttle_spf_max')
+    end
+  end
+end