cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/ntp_server.rb

@@ -0,0 +1,86 @@
+# NTP Server provider class
+#
+# Jonathan Tripathy et al., September 2015
+#
+# Copyright (c) 2014-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'
+require_relative 'interface'
+require 'resolv'
+
+module Cisco
+  # NtpServer - node utility class for NTP Server configuration management
+  class NtpServer < NodeUtil
+    attr_reader :key, :maxpoll, :minpoll, :prefer, :vrf
+
+    def initialize(opts, instantiate=true)
+      @ntpserver_id = opts['name']
+      @key = opts['key']
+      @minpoll = opts['minpoll']
+      @maxpoll = opts['maxpoll']
+      @prefer = opts['prefer'].nil? ? false : true
+      @vrf = opts['vrf'].nil? ? 'default' : opts['vrf']
+
+      hostname_regex = /^(?=.{1,255}$)[0-9A-Za-z]
+      (?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?
+      (?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$/x
+
+      unless @ntpserver_id =~ Resolv::AddressRegex ||
+             @ntpserver_id =~ hostname_regex
+        fail ArgumentError,
+             "Invalid value '#{@ntpserver_id}' \
+        (Must be valid IPv4/IPv6 address or hostname)"
+      end
+
+      create if instantiate
+    end
+
+    def self.ntpservers
+      keys = %w(name prefer vrf key minpoll maxpoll)
+      hash = {}
+      ntpservers_list = config_get('ntp_server', 'server')
+      return hash if ntpservers_list.empty?
+
+      ntpservers_list.each do |id|
+        hash[id[0]] = NtpServer.new(Hash[keys.zip(id)], false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      name == other.name && prefer == other.prefer
+    end
+
+    def create
+      config_set('ntp_server', 'server', state: '', ip: @ntpserver_id,
+                  prefer: (['true', true].include? @prefer) ? 'prefer' : '',
+                  vrf: @vrf ? "use-vrf #{@vrf}" : '',
+                  key: @key ? "key #{@key}" : '',
+                  minpoll: @minpoll ? "minpoll #{@minpoll}" : '',
+                  maxpoll: @maxpoll ? "maxpoll #{@maxpoll}" : '')
+    end
+
+    def destroy
+      config_set('ntp_server', 'server',
+                 state: 'no', ip: @ntpserver_id, prefer: '', vrf: '',
+                 key: '', minpoll: '', maxpoll: '')
+    end
+
+    def name
+      @ntpserver_id
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/object_group.rb

@@ -0,0 +1,75 @@
+#
+# May 2017, Sai Chintalapudi
+#
+# Copyright (c) 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 'acl'
+
+module Cisco
+  # node_utils class for object_group
+  class ObjectGroup < NodeUtil
+    attr_reader :afi, :type, :grp_name
+
+    def initialize(afi, type, name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless type[/address|port/]
+      @afi = Acl.afi_cli(afi)
+      @type = type
+      @grp_name = name
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { afi: @afi, type: @type, grp_name: @grp_name }
+      @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
+
+    def create
+      config_set('object_group', 'create', @set_args)
+    end
+
+    def destroy
+      config_set('object_group', 'destroy', @set_args)
+    end
+
+    def ==(other)
+      grp_name == other.grp_name && afi == other.afi && type == other.type
+    end
+
+    def self.object_groups
+      hash = {}
+      grps = config_get('object_group', 'all_object_groups')
+      return hash if grps.nil?
+      grps.each do |afi, type, name|
+        lafi = afi
+        lafi = 'ipv4' if afi == 'ip'
+        hash[lafi] ||= {}
+        hash[lafi][type] ||= {}
+        hash[lafi][type][name] = ObjectGroup.new(lafi, type, name, false)
+      end
+      hash
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/object_group_entry.rb

@@ -0,0 +1,143 @@
+#
+# May 2017, Sai Chintalapudi
+#
+# Copyright (c) 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 'acl'
+require_relative 'object_group'
+
+module Cisco
+  # node_utils class for object_group_entry
+  class ObjectGroupEntry < NodeUtil
+    attr_reader :afi, :type, :grp_name
+
+    def initialize(afi, type, name, seqno)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless type[/address|port/]
+      @afi = Acl.afi_cli(afi)
+      @type = type
+      @grp_name = name
+      @seqno = seqno
+      og = ObjectGroup.object_groups[afi.to_s][type.to_s][name.to_s]
+      fail "ObjectGroup #{afi} #{type} #{name} does not exist" if
+        og.nil?
+      set_args_keys_default
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { afi: @afi, type: @type, grp_name: @grp_name, seqno: @seqno }
+      @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
+
+    def destroy
+      config_set('object_group', 'entry_destroy', @set_args)
+    end
+
+    def self.object_group_entries
+      hash = {}
+      grps = config_get('object_group', 'all_object_groups')
+      return hash if grps.nil?
+      grps.each do |afi, type, name|
+        lafi = afi
+        lafi = 'ipv4' if afi == 'ip'
+        hash[lafi] ||= {}
+        hash[lafi][type] ||= {}
+        hash[lafi][type][name] ||= {}
+        entries = config_get('object_group', 'all_entries',
+                             afi:      Acl.afi_cli(lafi),
+                             type:     type,
+                             grp_name: name)
+        next if entries.nil?
+        entries.each do |seqno|
+          hash[lafi][type][name][seqno] =
+            ObjectGroupEntry.new(lafi, type, name, seqno)
+        end
+      end
+      hash
+    end
+
+    def entry_get
+      str = config_get('object_group', 'entry', @get_args)
+      return nil if str.nil?
+      str = str.strip
+
+      # rubocop:disable Metrics/LineLength
+      regexp = Regexp.new('(?<seqno>\d+)'\
+                          ' *(?<address>host \S+|[:\.0-9a-fA-F]+ [:\.0-9a-fA-F]+|[:\.0-9a-fA-F]+\/\d+)?'\
+                          ' *(?<port>range \S+ \S+|(lt|eq|gt|neq) \S+)?')
+      # rubocop:enable Metrics/LineLength
+      regexp.match(str)
+    end
+
+    def entry_set(attrs)
+      if attrs.empty?
+        attrs[:state] = 'no'
+      else
+        destroy if seqno
+        attrs[:state] = ''
+      end
+      set_args_keys_default
+      set_args_keys(attrs)
+      [:address,
+       :port,
+      ].each do |p|
+        attrs[p] = '' if attrs[p].nil?
+        send(p.to_s + '=', attrs[p])
+      end
+      @get_args = @set_args
+      config_set('object_group', 'entry', @set_args)
+    end
+
+    # PROPERTIES
+    # ----------
+    def seqno
+      match = entry_get
+      return nil if match.nil?
+      match.names.include?('seqno') ? match[:seqno] : nil
+    end
+
+    def address
+      match = entry_get
+      return nil if match.nil?
+      addr = match[:address]
+      return nil if addr.nil?
+      # Normalize addr. Some platforms zero_pad ipv6 addrs.
+      addr.gsub!(/^0*/, '').gsub!(/:0*/, ':')
+      addr
+    end
+
+    def address=(address)
+      @set_args[:address] = address
+    end
+
+    def port
+      match = entry_get
+      return nil if match.nil?
+      match.names.include?('port') ? match[:port] : nil
+    end
+
+    def port=(port)
+      @set_args[:port] = port
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/overlay_global.rb

@@ -0,0 +1,142 @@
+# VXLAN global provider class
+# Provides configuration of anycast gateways and duplicate host IP and
+# mac detection
+#
+# Alok Aggarwal, October 2015
+#
+# Copyright (c) 2014-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 'cisco_cmn_utils'
+require_relative 'feature'
+require_relative 'node_util'
+
+module Cisco
+  # node_utils class for overlay_global
+  class OverlayGlobal < NodeUtil
+    # ----------
+    # PROPERTIES
+    # ----------
+
+    # dup-host-ip-addr-detection
+    def dup_host_ip_addr_detection
+      match = config_get('overlay_global', 'dup_host_ip_addr_detection')
+      if match.nil?
+        default_dup_host_ip_addr_detection
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def dup_host_ip_addr_detection_host_moves
+      host_moves, _timeout = dup_host_ip_addr_detection
+      host_moves
+    end
+
+    def dup_host_ip_addr_detection_timeout
+      _host_moves, timeout = dup_host_ip_addr_detection
+      timeout
+    end
+
+    def dup_host_ip_addr_detection_set(host_moves, timeout)
+      Feature.fabric_forwarding_enable
+      Feature.nv_overlay_evpn_enable
+      if host_moves == default_dup_host_ip_addr_detection_host_moves &&
+         timeout == default_dup_host_ip_addr_detection_timeout
+        state = 'no'
+      else
+        state = ''
+      end
+      set_args = { state: state, host_moves: host_moves, timeout: timeout }
+      config_set('overlay_global', 'dup_host_ip_addr_detection', set_args)
+    end
+
+    def default_dup_host_ip_addr_detection
+      [default_dup_host_ip_addr_detection_host_moves,
+       default_dup_host_ip_addr_detection_timeout]
+    end
+
+    def default_dup_host_ip_addr_detection_host_moves
+      config_get_default('overlay_global',
+                         'dup_host_ip_addr_detection_host_moves')
+    end
+
+    def default_dup_host_ip_addr_detection_timeout
+      config_get_default('overlay_global', 'dup_host_ip_addr_detection_timeout')
+    end
+
+    # dup-host-mac-detection
+    def dup_host_mac_detection
+      match = config_get('overlay_global', 'dup_host_mac_detection')
+      if match.nil?
+        default_dup_host_mac_detection
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def dup_host_mac_detection_host_moves
+      host_moves, _timeout = dup_host_mac_detection
+      host_moves
+    end
+
+    def dup_host_mac_detection_timeout
+      _host_moves, timeout = dup_host_mac_detection
+      timeout
+    end
+
+    def dup_host_mac_detection_set(host_moves, timeout)
+      set_args = { host_moves: host_moves, timeout: timeout }
+      config_set('overlay_global', 'dup_host_mac_detection', set_args)
+    end
+
+    def default_dup_host_mac_detection
+      [default_dup_host_mac_detection_host_moves,
+       default_dup_host_mac_detection_timeout]
+    end
+
+    def default_dup_host_mac_detection_host_moves
+      config_get_default('overlay_global', 'dup_host_mac_detection_host_moves')
+    end
+
+    def default_dup_host_mac_detection_timeout
+      config_get_default('overlay_global', 'dup_host_mac_detection_timeout')
+    end
+
+    # anycast-gateway-mac
+    def anycast_gateway_mac
+      mac = config_get('overlay_global', 'anycast_gateway_mac')
+      mac.nil? || mac.empty? ? default_anycast_gateway_mac : mac.downcase
+    end
+
+    def anycast_gateway_mac=(mac_addr)
+      fail TypeError unless mac_addr.is_a?(String)
+
+      Feature.nv_overlay_evpn_enable
+      Feature.fabric_forwarding_enable
+      if mac_addr == default_anycast_gateway_mac
+        state = 'no'
+        mac_addr = ''
+      else
+        state = ''
+      end
+      config_set('overlay_global', 'anycast_gateway_mac',
+                 state: state, mac_addr: mac_addr)
+    end
+
+    def default_anycast_gateway_mac
+      config_get_default('overlay_global', 'anycast_gateway_mac')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/pim.rb

@@ -0,0 +1,131 @@
+#
+# NXAPI implementation of PIM class
+#
+# Smitha Gopalan, November 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'
+
+module Cisco
+  # node_utils class for Pim
+  class Pim < NodeUtil
+    attr_reader :vrf, :afi
+
+    # Constructor with vrf
+    # ---------------------
+    def initialize(afi, vrf, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @vrf = vrf
+      @afi = Pim.afi_cli(afi)
+      set_args_keys_default
+
+      Feature.pim_enable if instantiate
+    end
+
+    # self.pims returns a hash of all current pim objects.
+    # There will be one object for each vrf. This method has slightly different
+    # behavior than most of the other "get all objects" methods because the
+    # pim properties are standalone and do not reside in a "pim" container;
+    # therefore, this method simply returns a pim object for each vrf
+    # regardless of whether there are any specific pim properties currently
+    # defined for the context.
+    def self.pims
+      afis = %w(ipv4) # TBD: No support for ipv6 at this time
+      hash_final = {}
+      return hash_final unless Feature.pim_enabled?
+      afis.each do |afi|
+        hash_final[afi] = {}
+        default_vrf = 'default'
+        hash_final[afi][default_vrf] = Pim.new(afi, default_vrf, false)
+
+        # Now the vrf's
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.delete_if { |vrf_id| vrf_id == 'management' }
+        vrf_ids.each do |vrf|
+          hash_final[afi][vrf] = Pim.new(afi, vrf, false)
+        end
+      end
+      hash_final
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    def self.afi_cli(afi)
+      # Add ipv6 support later
+      fail ArgumentError, "Argument afi must be 'ipv4'" unless
+        afi[/(ipv4)/]
+      afi[/ipv4/] ? 'ip' : afi
+    end
+
+    def set_args_keys_default
+      keys = { afi: @afi }
+      keys[:vrf] = @vrf unless @vrf == '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
+
+    # This destroy method is different than most because pim does not have a
+    # "container" for properties, they simply exist in a given vrf context.
+    # For that reason destroy needs to explicitly set each property
+    # to its default state.
+    def destroy
+      return unless Feature.pim_enabled?
+      self.ssm_range = ''
+      self.bfd = false
+    end
+
+    #-----------
+    # Properties
+    #-----------
+    def ssm_range
+      config_get('pim', 'ssm_range', @get_args)
+    end
+
+    def ssm_range=(range)
+      if range.empty?
+        state = 'no'
+        range = ssm_range
+        return if range.nil?
+      else
+        state = ''
+      end
+      set_args_keys(state: state, ssm_range: range)
+      config_set('pim', 'ssm_range', @set_args)
+    end
+
+    def bfd
+      config_get('pim', 'bfd', @get_args)
+    end
+
+    def bfd=(val)
+      return if val == bfd
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      Feature.bfd_enable if val
+      config_set('pim', 'bfd', @set_args)
+    end
+
+    def default_bfd
+      config_get_default('pim', 'bfd')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/pim_group_list.rb

@@ -0,0 +1,109 @@
+# NXAPI implementation of the PimGroupList class
+#
+# Smitha Gopalan, November 2015
+#
+# Copyright (c) 2014-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 'pim'
+
+module Cisco
+  # node_utils class for pim grouplist
+  class PimGroupList < NodeUtil
+    attr_reader :afi, :rp_addr, :group, :vrf
+
+    # Constructor with grouplist and vrf
+    # ----------------------------------
+    def initialize(afi, vrf, rp_addr, group, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @afi = Pim.afi_cli(afi)
+      @rp_addr = rp_addr
+      @group = group
+      @vrf = vrf
+      set_args_keys_default
+
+      create if instantiate
+    end
+
+    # Create a hash of [afi][vrf][rp-addr,grouplist]
+    # --------------------------------------------------
+    def self.group_lists
+      afis = %w(ipv4) # TBD ipv6
+      hash = {}
+      return hash unless Feature.pim_enabled?
+      afis.each do |afi|
+        hash[afi] = {}
+        default_vrf = 'default'
+        get_args = { afi: Pim.afi_cli(afi) }
+        rp_addrs = config_get('pim', 'all_group_lists', get_args)
+        unless rp_addrs.nil?
+          rp_addrs.each do |addr_and_group|
+            addr, group = addr_and_group
+            hash[afi][default_vrf] ||= {}
+            hash[afi][default_vrf][addr_and_group] =
+              PimGroupList.new(afi, default_vrf, addr, group, false)
+          end
+        end
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.each do |vrf|
+          get_args = { vrf: vrf, afi: Pim.afi_cli(afi) }
+          rp_addrs = config_get('pim', 'all_group_lists', get_args)
+          next if rp_addrs.nil?
+          rp_addrs.each do |addr_and_group|
+            hash[afi][vrf] ||= {}
+            addr, group = addr_and_group
+            hash[afi][vrf][addr_and_group] =
+              PimGroupList.new(afi, vrf, addr, group, false)
+          end
+        end
+      end
+      hash
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    # set_args_keys_default
+    # ---------------------
+    def set_args_keys_default
+      keys = { afi: @afi, addr: @rp_addr, group: @group }
+      keys[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args = keys
+    end
+
+    # set_args_key
+    # -------------
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    # Create pim grouplist instance
+    # ---------------------------------
+    def create
+      Feature.pim_enable
+      set_args_keys(state: '')
+      config_set('pim', 'group_list', @set_args)
+    end
+
+    # Destroy pim grouplist instance
+    # ----------------------------------
+    def destroy
+      set_args_keys(state: 'no')
+      config_set('pim', 'group_list', @set_args)
+    end
+  end
+end