cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/interface_ospf.rb

@@ -0,0 +1,378 @@
+# March 2015, Alex Hunsberger
+#
+# Copyright (c) 2015-2017 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 'ipaddr'
+require_relative 'node_util'
+require_relative 'interface'
+# Interestingly enough, interface OSPF configuration can exist completely
+# independent of router OSPF configuration... so we don't need RouterOspf here.
+
+module Cisco
+  # InterfaceOspf - node utility class for per-interface OSPF config management
+  class InterfaceOspf < NodeUtil
+    attr_reader :intf_name, :ospf_name, :area, :show_name
+
+    def initialize(intf_name, ospf_name, area, create=true, show_name=nil)
+      fail TypeError unless intf_name.is_a? String
+      fail TypeError unless ospf_name.is_a? String
+      fail TypeError unless area.is_a? String
+      fail ArgumentError unless intf_name.length > 0
+      fail ArgumentError unless ospf_name.length > 0
+      fail ArgumentError unless area.length > 0
+
+      # normalize
+      @intf_name = intf_name.downcase
+      @show_name = show_name.nil? ? '' : Utils.normalize_intf_pattern(show_name)
+      fail "interface #{@intf_name} does not exist" if
+        Interface.interfaces(nil, @intf_name)[@intf_name].nil?
+      @ospf_name = ospf_name
+      @area = area
+      @get_args = { name: intf_name, show_name: @show_name }
+      set_args_keys_default
+
+      return unless create
+      Feature.ospf_enable
+      self.area = area
+    end
+
+    def set_args_keys_default
+      @set_args = { name: @intf_name, ospf_name: @ospf_name, area: @area }
+    end
+
+    # can't re-use Interface.interfaces because we need to filter based on
+    # "ip router ospf <name>", which Interface doesn't retrieve
+    def self.interfaces(ospf_name=nil, show_name=nil)
+      fail TypeError unless ospf_name.is_a?(String) || ospf_name.nil?
+      ints = {}
+      show_name = Utils.normalize_intf_pattern(show_name)
+      begin
+        intf_list = config_get('interface_ospf', 'all_interfaces',
+                               show_name: show_name)
+      rescue CliError => e
+        raise unless show_name
+        # ignore logical interfaces that do not exist
+        debug 'InterfaceOspf.interfaces ignoring CliError => ' + e.to_s
+      end
+      return ints if intf_list.nil?
+      intf_list.each do |name|
+        # Find interfaces with 'ip router ospf <name> area <area>'
+        match = config_get('interface_ospf', 'area',
+                           name: name, show_name: show_name)
+        next if match.nil?
+        ospf = match[0]
+        area = match[1]
+        next unless ospf_name.nil? || ospf == ospf_name
+        int = name.downcase
+        ints[int] = InterfaceOspf.new(int, ospf, area, false, show_name)
+      end
+      ints
+    end
+
+    def area
+      match = config_get('interface_ospf', 'area', @get_args)
+      return nil if match.nil?
+      val = match[1]
+      # Coerce numeric area to the expected dot-decimal format.
+      val = IPAddr.new(val.to_i, Socket::AF_INET).to_s unless val.match(/\./)
+      val
+    end
+
+    def area=(a)
+      config_set('interface_ospf', 'area',
+                 @set_args.merge!(state: '', area: a))
+      set_args_keys_default
+    end
+
+    def destroy
+      config_set('interface_ospf', 'area', @set_args.merge!(state: 'no'))
+      set_args_keys_default
+      # Reset everything else back to default as well:
+      self.message_digest = default_message_digest
+      message_digest_key_set(default_message_digest_key_id, '', '', '')
+      self.cost = default_cost
+      destroy_interval('hello_interval')
+      destroy_interval('dead_interval')
+      self.bfd = default_bfd
+      self.mtu_ignore = default_mtu_ignore
+      self.priority = default_priority
+      self.network_type = default_network_type
+      self.passive_interface = default_passive_interface if passive_interface
+      self.shutdown = default_shutdown
+      self.transmit_delay = default_transmit_delay
+    end
+
+    def default_message_digest
+      config_get_default('interface_ospf', 'message_digest')
+    end
+
+    def message_digest
+      config_get('interface_ospf', 'message_digest', @get_args)
+    end
+
+    def message_digest=(enable)
+      return if enable == message_digest
+      @set_args[:state] = (enable ? '' : 'no')
+      config_set('interface_ospf', 'message_digest', @set_args)
+      set_args_keys_default
+    end
+
+    def default_message_digest_key_id
+      config_get_default('interface_ospf', 'message_digest_key_id')
+    end
+
+    def message_digest_key_id
+      config_get('interface_ospf', 'message_digest_key_id', @get_args)
+    end
+
+    def default_message_digest_algorithm_type
+      config_get_default('interface_ospf',
+                         'message_digest_alg_type').to_sym
+    end
+
+    def message_digest_algorithm_type
+      match = config_get('interface_ospf', 'message_digest_alg_type',
+                         @get_args)
+      match.to_sym
+    end
+
+    def default_message_digest_encryption_type
+      Encryption.cli_to_symbol(
+        config_get_default('interface_ospf', 'message_digest_enc_type'))
+    end
+
+    def message_digest_encryption_type
+      match = config_get('interface_ospf', 'message_digest_enc_type',
+                         @get_args)
+      Encryption.cli_to_symbol(match)
+    end
+
+    def message_digest_password
+      config_get('interface_ospf', 'message_digest_password', @get_args)
+    end
+
+    def default_message_digest_password
+      config_get_default('interface_ospf', 'message_digest_password')
+    end
+
+    def message_digest_key_set(keyid, algtype, enctype, password)
+      current_keyid = message_digest_key_id
+      if keyid == default_message_digest_key_id && current_keyid != keyid
+        @set_args.merge!(state:    'no',
+                         keyid:    current_keyid,
+                         algtype:  '',
+                         enctype:  '',
+                         password: '')
+        config_set('interface_ospf', 'message_digest_key_set', @set_args)
+      elsif keyid != default_message_digest_key_id
+        fail TypeError unless password.is_a?(String)
+        fail ArgumentError unless password.length > 0
+        enctype = Encryption.symbol_to_cli(enctype)
+        @set_args.merge!(state:    '',
+                         keyid:    keyid,
+                         algtype:  algtype,
+                         enctype:  enctype,
+                         password: password)
+        config_set('interface_ospf', 'message_digest_key_set', @set_args)
+      end
+      set_args_keys_default
+    end
+
+    def cost
+      config_get('interface_ospf', 'cost', @get_args)
+    end
+
+    def default_cost
+      config_get_default('interface_ospf', 'cost')
+    end
+
+    def cost=(c)
+      if c == default_cost
+        @set_args.merge!(state: 'no', cost: '')
+      else
+        @set_args.merge!(state: '', cost: c)
+      end
+      config_set('interface_ospf', 'cost', @set_args)
+      set_args_keys_default
+    end
+
+    def hello_interval
+      config_get('interface_ospf', 'hello_interval', @get_args)
+    end
+
+    def default_hello_interval
+      config_get_default('interface_ospf', 'hello_interval')
+    end
+
+    def hello_interval=(interval)
+      # Previous behavior always sets interval and ignores 'no' cmd
+      @set_args.merge!(state: '', interval: interval.to_i)
+      config_set('interface_ospf', 'hello_interval', @set_args)
+      set_args_keys_default
+    end
+
+    def destroy_interval(prop)
+      # Helper to remove cli completely
+      @set_args.merge!(state: 'no', interval: '')
+      config_set('interface_ospf', prop, @set_args)
+      set_args_keys_default
+    end
+
+    def dead_interval
+      config_get('interface_ospf', 'dead_interval', @get_args)
+    end
+
+    def default_dead_interval
+      config_get_default('interface_ospf', 'dead_interval')
+    end
+
+    def dead_interval=(interval)
+      # Previous behavior always sets interval and ignores 'no' cmd
+      @set_args.merge!(state: '', interval: interval.to_i)
+      config_set('interface_ospf', 'dead_interval', @set_args)
+      set_args_keys_default
+    end
+
+    # CLI can be either of the following or none
+    # ip ospf bfd
+    # ip ospf bfd disable
+    def bfd
+      val = config_get('interface_ospf', 'bfd', @get_args)
+      return if val.nil?
+      val.include?('disable') ? false : true
+    end
+
+    def bfd=(val)
+      return if val == bfd
+      Feature.bfd_enable
+      state = (val == default_bfd) ? 'no' : ''
+      disable = val ? '' : 'disable'
+      config_set('interface_ospf', 'bfd',
+                 @set_args.merge!(state: state, disable: disable))
+      set_args_keys_default
+    end
+
+    def default_bfd
+      config_get_default('interface_ospf', 'bfd')
+    end
+
+    def default_network_type
+      case @intf_name
+      when /loopback/i
+        lookup = 'network_type_loopback_default'
+      else
+        lookup = 'network_type_default'
+      end
+      config_get_default('interface_ospf', lookup)
+    end
+
+    def mtu_ignore
+      config_get('interface_ospf', 'mtu_ignore', @get_args)
+    end
+
+    def mtu_ignore=(enable)
+      @set_args[:state] = enable ? '' : 'no'
+      config_set('interface_ospf', 'mtu_ignore', @set_args)
+      set_args_keys_default
+    end
+
+    def default_mtu_ignore
+      config_get_default('interface_ospf', 'mtu_ignore')
+    end
+
+    def network_type
+      type = config_get('interface_ospf', 'network_type', @get_args)
+      return 'p2p' if type == 'point-to-point'
+      return default_network_type if type.nil?
+      type
+    end
+
+    def network_type=(type)
+      if type == default_network_type
+        @set_args.merge!(state: 'no', network_type: '')
+      else
+        network = 'point-to-point' if type.to_s == 'p2p'
+        @set_args.merge!(state: '', network_type: network)
+      end
+      config_set('interface_ospf', 'network_type', @set_args)
+      set_args_keys_default
+    end
+
+    def default_passive_interface
+      config_get_default('interface_ospf', 'passive_interface')
+    end
+
+    def passive_interface
+      config_get('interface_ospf', 'passive_interface', @get_args)
+    end
+
+    def passive_interface=(enable)
+      fail TypeError unless enable == true || enable == false
+      @set_args[:state] = enable ? '' : 'no'
+      config_set('interface_ospf', 'passive_interface', @set_args)
+      set_args_keys_default
+    end
+
+    def priority
+      config_get('interface_ospf', 'priority', @get_args)
+    end
+
+    def priority=(val)
+      if val == default_priority
+        @set_args.merge!(state: 'no', priority: '')
+      else
+        @set_args.merge!(state: '', priority: val)
+      end
+      config_set('interface_ospf', 'priority', @set_args)
+      set_args_keys_default
+    end
+
+    def default_priority
+      config_get_default('interface_ospf', 'priority')
+    end
+
+    def shutdown
+      config_get('interface_ospf', 'shutdown', @get_args)
+    end
+
+    def shutdown=(enable)
+      @set_args[:state] = enable ? '' : 'no'
+      config_set('interface_ospf', 'shutdown', @set_args)
+      set_args_keys_default
+    end
+
+    def default_shutdown
+      config_get_default('interface_ospf', 'shutdown')
+    end
+
+    def transmit_delay
+      config_get('interface_ospf', 'transmit_delay', @get_args)
+    end
+
+    def transmit_delay=(val)
+      if val == default_transmit_delay
+        @set_args.merge!(state: 'no', delay: '')
+      else
+        @set_args.merge!(state: '', delay: val)
+      end
+      config_set('interface_ospf', 'transmit_delay', @set_args)
+      set_args_keys_default
+    end
+
+    def default_transmit_delay
+      config_get_default('interface_ospf', 'transmit_delay')
+    end
+  end
+end

data/lib/cisco_node_utils/interface_portchannel.rb

@@ -0,0 +1,180 @@
+# December 2015, Sai Chintalapudi
+#
+# Copyright (c) 2015-2017 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'
+
+# Add some interface-specific constants to the Cisco namespace
+module Cisco
+  # InterfacePortChannel - node utility class for port channel config management
+  class InterfacePortChannel < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name.length > 0
+      @name = name.downcase
+      fail ArgumentError unless @name.start_with?('port-channel')
+
+      create if instantiate
+    end
+
+    def to_s
+      "interface_port_channel #{name}"
+    end
+
+    def self.interfaces
+      hash = {}
+      intf_list = config_get('interface_portchannel', 'all_interfaces')
+      return hash if intf_list.nil?
+
+      intf_list.each do |id|
+        id = id.downcase
+        next unless id.start_with?('port-channel')
+        hash[id] = InterfacePortChannel.new(id, false)
+      end
+      hash
+    end
+
+    def create
+      config_set('interface_portchannel', 'create', @name)
+    end
+
+    def destroy
+      config_set('interface_portchannel', 'destroy', @name)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def bfd_per_link
+      config_get('interface_portchannel', 'bfd_per_link', @name)
+    end
+
+    def bfd_per_link=(state)
+      return if state == bfd_per_link
+      no_cmd = (state ? '' : 'no')
+      Feature.bfd_enable
+      config_set('interface_portchannel',
+                 'bfd_per_link', @name, no_cmd)
+    end
+
+    def default_bfd_per_link
+      config_get_default('interface_portchannel', 'bfd_per_link')
+    end
+
+    def lacp_graceful_convergence
+      config_get('interface_portchannel', 'lacp_graceful_convergence', @name)
+    end
+
+    def lacp_graceful_convergence=(state)
+      no_cmd = (state ? '' : 'no')
+      config_set('interface_portchannel',
+                 'lacp_graceful_convergence', @name, no_cmd)
+    end
+
+    def default_lacp_graceful_convergence
+      config_get_default('interface_portchannel', 'lacp_graceful_convergence')
+    end
+
+    def lacp_max_bundle
+      config_get('interface_portchannel', 'lacp_max_bundle', @name)
+    end
+
+    def lacp_max_bundle=(val)
+      config_set('interface_portchannel', 'lacp_max_bundle', @name, val)
+    end
+
+    def default_lacp_max_bundle
+      config_get_default('interface_portchannel', 'lacp_max_bundle')
+    end
+
+    def lacp_min_links
+      config_get('interface_portchannel', 'lacp_min_links', @name)
+    end
+
+    def lacp_min_links=(val)
+      config_set('interface_portchannel', 'lacp_min_links', @name, val)
+    end
+
+    def default_lacp_min_links
+      config_get_default('interface_portchannel', 'lacp_min_links')
+    end
+
+    def lacp_suspend_shut_needed?
+      config_get('interface_portchannel', 'lacp_suspend_shut_needed')
+    end
+
+    def lacp_suspend_individual
+      config_get('interface_portchannel', 'lacp_suspend_individual', @name)
+    end
+
+    def lacp_suspend_individual=(state)
+      no_cmd = (state ? '' : 'no')
+      # This property can only be set if the port-channel is shutdown on
+      # some platforms.
+      # This setter will:
+      # 1) Query the current state of the port-channel interface.
+      # 2) Shutdown the port-channel interface if needed.
+      # 3) Set the lacp_suspend_individual property.
+      # 4) Restore the original state of the port-channel interface if needed.
+      int = Interface.new(@name, false)
+      current_state = int.shutdown
+      int.shutdown = true if lacp_suspend_shut_needed? && !current_state
+      config_set('interface_portchannel',
+                 'lacp_suspend_individual', @name, no_cmd)
+      int.shutdown = current_state unless current_state == int.shutdown
+    end
+
+    def default_lacp_suspend_individual
+      config_get_default('interface_portchannel', 'lacp_suspend_individual')
+    end
+
+    def port_hash_distribution
+      config_get('interface_portchannel', 'port_hash_distribution', @name)
+    end
+
+    def port_hash_distribution=(val)
+      if val
+        state = ''
+      else
+        state = 'no'
+        val = ''
+      end
+      config_set('interface_portchannel',
+                 'port_hash_distribution', @name, state, val)
+    end
+
+    def default_port_hash_distribution
+      config_get_default('interface_portchannel', 'port_hash_distribution')
+    end
+
+    def port_load_defer
+      config_get('interface_portchannel', 'port_load_defer', @name)
+    end
+
+    def port_load_defer=(state)
+      no_cmd = (state ? '' : 'no')
+      config_set('interface_portchannel',
+                 'port_load_defer', @name, no_cmd)
+    end
+
+    def default_port_load_defer
+      config_get_default('interface_portchannel', 'port_load_defer')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/interface_service_vni.rb

@@ -0,0 +1,132 @@
+# December 2015, Chris Van Heuveln
+#
+# 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
+  # InterfaceServiceVni - node utility class for Service VNI Instance commands
+  class InterfaceServiceVni < NodeUtil
+    attr_reader :name
+
+    def initialize(intf, sid, instantiate=true)
+      @name = intf.to_s.downcase
+      @sid = sid.to_s
+      fail ArgumentError if @name.empty? || @sid.empty?
+      set_args_keys_default
+      create if instantiate
+    end
+
+    def to_s
+      "interface_service_vni #{name} #{@sid}"
+    end
+
+    def self.svc_vni_ids
+      hash = {}
+      intf_list = config_get('interface_service_vni', 'all_interfaces')
+      return hash if intf_list.nil?
+
+      intf_list.each do |intf|
+        intf.downcase!
+        svc_ids = config_get('interface_service_vni', 'all_service_vni_ids',
+                             name: intf)
+        next if svc_ids.nil?
+        hash[intf] = {}
+        svc_ids.each do |sid|
+          hash[intf][sid] = InterfaceServiceVni.new(intf, sid, false)
+        end
+      end
+      hash
+    end
+
+    def create
+      Feature.vni_enable
+      @set_args[:state] = ''
+      config_set('interface_service_vni', 'create_destroy', @set_args)
+    end
+
+    def destroy
+      @set_args[:state] = 'no'
+      config_set('interface_service_vni', 'create_destroy', @set_args)
+    end
+
+    def set_args_keys_default
+      keys = { name: @name, sid: @sid }
+      @get_args = @set_args = keys
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+    # rubocop:enable Style/AccessorMethodNamefor
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    #
+    # encapsulation_profile_vni
+    #
+    #   cli: service instance 1 vni
+    #          encapsulation profile vni_500_5000 default
+    #  type: 'vni_500_5000'
+    def encapsulation_profile_vni
+      config_get('interface_service_vni', 'encapsulation_profile_vni',
+                 @get_args)
+    end
+
+    def encapsulation_profile_vni=(profile)
+      Feature.vni_enable
+      state = profile.empty? ? 'no' : ''
+      current = encapsulation_profile_vni
+
+      if state[/no/]
+        config_set('interface_service_vni', 'encapsulation_profile_vni',
+                   set_args_keys(state: state, profile: current)) unless
+          current.empty?
+      else
+        # Remove current profile before adding a new one
+        config_set('interface_service_vni', 'encapsulation_profile_vni',
+                   set_args_keys(state: 'no', profile: current)) unless
+          current.empty?
+        config_set('interface_service_vni', 'encapsulation_profile_vni',
+                   set_args_keys(state: state, profile: profile))
+      end
+    end
+
+    def default_encapsulation_profile_vni
+      config_get_default('interface_service_vni', 'encapsulation_profile_vni')
+    end
+
+    #
+    # shutdown
+    #
+    def shutdown
+      config_get('interface_service_vni', 'shutdown', @get_args)
+    end
+
+    def shutdown=(state)
+      config_set('interface_service_vni', 'shutdown',
+                 set_args_keys(state: state ? '' : 'no'))
+    end
+
+    def default_shutdown
+      config_get_default('interface_service_vni', 'shutdown')
+    end
+  end  # Class
+end    # Module