cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/acl.rb

@@ -0,0 +1,101 @@
+# 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'
+
+module Cisco
+  # Acl - node utility class for ACL configuration
+  class Acl < NodeUtil
+    attr_reader :acl_name, :afi
+
+    def initialize(afi, acl_name, instantiate=true)
+      @set_args = @get_args = { afi: Acl.afi_cli(afi), acl_name: acl_name.to_s }
+      create if instantiate
+    end
+
+    # Return all acls currently on the switch
+    def self.acls
+      afis = %w(ipv4 ipv6)
+      acl_hash = {}
+      afis.each do |afi|
+        acl_hash[afi] = {}
+        afi_cli = Acl.afi_cli(afi)
+        instances = config_get('acl', 'all_acls', afi: afi_cli)
+
+        next if instances.nil?
+        instances.each do |acl_name|
+          acl_hash[afi][acl_name] = Acl.new(afi, acl_name, false)
+        end
+      end
+      acl_hash
+    end
+
+    # Platform-specific afi cli string
+    def self.afi_cli(afi)
+      fail ArgumentError, "Argument afi must be 'ipv4' or 'ipv6'" unless
+        afi[/(ipv4|ipv6)/]
+      afi = 'ip' if platform == :nexus && afi[/ipv4/]
+      afi
+    end
+
+    def create
+      config_acl('')
+    end
+
+    def destroy
+      config_acl('no')
+    end
+
+    def config_acl(state)
+      @set_args[:state] = state
+      config_set('acl', 'acl', @set_args)
+    end
+
+    # ----------
+    # PROPERTIES
+    # ----------
+    def stats_per_entry
+      config_get('acl', 'stats_per_entry', @get_args)
+    end
+
+    def stats_per_entry=(state)
+      @set_args[:state] = (state ? '' : 'no')
+      config_set('acl', 'stats_per_entry', @set_args)
+    end
+
+    def default_stats_per_entry
+      config_get_default('acl', 'stats_per_entry')
+    end
+
+    def fragments
+      config_get('acl', 'fragments', @get_args)
+    end
+
+    def fragments=(action)
+      @set_args[:state] = (action ? '' : 'no')
+      action = fragments unless action
+      @set_args[:action] = action
+      config_set('acl', 'fragments', @set_args) if action
+    end
+
+    def default_fragments
+      config_get_default('acl', 'fragments')
+    end
+
+    # acl == overide func
+    def ==(other)
+      acl_name == other.acl_name && afi == other.afi
+    end
+  end
+end

data/lib/cisco_node_utils/banner.rb

@@ -0,0 +1,63 @@
+# Banner provider class
+#
+# Rick Sherman et al., August 2018
+#
+# Copyright (c) 2014-2018 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
+  # Banner - node utility class for Banner configuration management
+  class Banner < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError,
+           "This provider only accepts an id of 'default'" \
+           unless name.eql?('default')
+      @name = name
+    end
+
+    def self.banners
+      hash = {}
+      hash['default'] = Banner.new('default')
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def motd
+      config_get('banner', 'motd')
+    end
+
+    def motd=(val)
+      if val.nil? && (motd != default_motd)
+        config_set('banner', 'motd', state: 'no', motd: '')
+      elsif !val.nil?
+        config_set('banner',
+                   'motd',
+                   state: '',
+                   motd:  "^#{val.gsub(/\n/, '\\n')}^")
+      end
+    end
+
+    def default_motd
+      config_get_default('banner', 'motd')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/bfd_global.rb

@@ -0,0 +1,305 @@
+#
+# NXAPI implementation of BFD Global class
+#
+# May 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'
+
+module Cisco
+  # node_utils class for bfd_global
+  class BfdGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(instantiate=true)
+      set_args_keys_default
+
+      Feature.bfd_enable if instantiate
+    end
+
+    # Reset everything back to default
+    def destroy
+      return unless Feature.bfd_enabled?
+      [:interval,
+       :ipv4_interval,
+       :ipv6_interval,
+       :fabricpath_interval,
+       :echo_interface,
+       :echo_rx_interval,
+       :ipv4_echo_rx_interval,
+       :ipv6_echo_rx_interval,
+       :fabricpath_vlan,
+       :slow_timer,
+       :ipv4_slow_timer,
+       :ipv6_slow_timer,
+       :fabricpath_slow_timer,
+       :startup_timer,
+      ].each do |prop|
+        send("#{prop}=", send("default_#{prop}")) if
+          send prop
+      end
+      set_args_keys_default
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      keys = { state: '' }
+      @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
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def echo_interface
+      config_get('bfd_global', 'echo_interface', @get_args)
+    end
+
+    def echo_interface=(val)
+      set_args_keys(intf:  val ? val : echo_interface,
+                    state: val ? '' : 'no')
+      config_set('bfd_global', 'echo_interface', @set_args) if
+        @set_args[:intf]
+    end
+
+    def default_echo_interface
+      config_get_default('bfd_global', 'echo_interface')
+    end
+
+    def echo_rx_interval
+      config_get('bfd_global', 'echo_rx_interval', @get_args)
+    end
+
+    def echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'echo_rx_interval', @set_args)
+    end
+
+    def default_echo_rx_interval
+      config_get_default('bfd_global', 'echo_rx_interval')
+    end
+
+    def ipv4_echo_rx_interval
+      config_get('bfd_global', 'ipv4_echo_rx_interval', @get_args)
+    end
+
+    def ipv4_echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_ipv4_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv4_echo_rx_interval', @set_args)
+    end
+
+    def default_ipv4_echo_rx_interval
+      config_get_default('bfd_global', 'ipv4_echo_rx_interval')
+    end
+
+    def ipv6_echo_rx_interval
+      config_get('bfd_global', 'ipv6_echo_rx_interval', @get_args)
+    end
+
+    def ipv6_echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_ipv6_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv6_echo_rx_interval', @set_args)
+    end
+
+    def default_ipv6_echo_rx_interval
+      config_get_default('bfd_global', 'ipv6_echo_rx_interval')
+    end
+
+    def slow_timer
+      config_get('bfd_global', 'slow_timer', @get_args)
+    end
+
+    def slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'slow_timer', @set_args)
+    end
+
+    def default_slow_timer
+      config_get_default('bfd_global', 'slow_timer')
+    end
+
+    def ipv4_slow_timer
+      config_get('bfd_global', 'ipv4_slow_timer', @get_args)
+    end
+
+    def ipv4_slow_timer=(val)
+      # Only set the value if it's not already configured and default
+      return if val == default_ipv4_slow_timer && val == ipv4_slow_timer
+      set_args_keys(timer: val,
+                    state: val == default_ipv4_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'ipv4_slow_timer', @set_args)
+    end
+
+    def default_ipv4_slow_timer
+      config_get_default('bfd_global', 'ipv4_slow_timer')
+    end
+
+    def ipv6_slow_timer
+      config_get('bfd_global', 'ipv6_slow_timer', @get_args)
+    end
+
+    def ipv6_slow_timer=(val)
+      # Only set the value if it's not already configured and default
+      return if val == default_ipv6_slow_timer && val == ipv6_slow_timer
+      set_args_keys(timer: val,
+                    state: val == default_ipv6_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'ipv6_slow_timer', @set_args)
+    end
+
+    def default_ipv6_slow_timer
+      config_get_default('bfd_global', 'ipv6_slow_timer')
+    end
+
+    def fabricpath_slow_timer
+      config_get('bfd_global', 'fabricpath_slow_timer', @get_args)
+    end
+
+    def fabricpath_slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_fabricpath_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_slow_timer', @set_args)
+    end
+
+    def default_fabricpath_slow_timer
+      config_get_default('bfd_global', 'fabricpath_slow_timer')
+    end
+
+    def startup_timer
+      config_get('bfd_global', 'startup_timer', @get_args)
+    end
+
+    def startup_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_startup_timer ? 'no' : '')
+      config_set('bfd_global', 'startup_timer', @set_args)
+    end
+
+    def default_startup_timer
+      config_get_default('bfd_global', 'startup_timer')
+    end
+
+    def fabricpath_vlan
+      config_get('bfd_global', 'fabricpath_vlan', @get_args)
+    end
+
+    def fabricpath_vlan=(val)
+      set_args_keys(vlan:  val,
+                    state: val == default_fabricpath_vlan ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_vlan', @set_args)
+    end
+
+    def default_fabricpath_vlan
+      config_get_default('bfd_global', 'fabricpath_vlan')
+    end
+
+    def default_interval
+      config_get_default('bfd_global', 'interval')
+    end
+
+    def default_ipv4_interval
+      config_get_default('bfd_global', 'ipv4_interval')
+    end
+
+    def default_ipv6_interval
+      config_get_default('bfd_global', 'ipv6_interval')
+    end
+
+    def default_fabricpath_interval
+      config_get_default('bfd_global', 'fabricpath_interval')
+    end
+
+    # interval is an array of interval, min_rx and multiplier
+    # CLI: bfd interval 100 min_rx 100 multiplier 25
+    def interval
+      config_get('bfd_global', 'interval', @get_args)
+    end
+
+    # ipv4_interval is an array of ipv4_interval, ipv4_min_rx and
+    # ipv4_multiplier
+    # CLI: bfd ipv4 interval 100 min_rx 100 multiplier 25
+    def ipv4_interval
+      config_get('bfd_global', 'ipv4_interval', @get_args)
+    end
+
+    # ipv6_interval is an array of ipv6_interval, ipv6_min_rx and
+    # ipv6_multiplier
+    # CLI: bfd ipv6 interval 100 min_rx 100 multiplier 25
+    def ipv6_interval
+      config_get('bfd_global', 'ipv6_interval', @get_args)
+    end
+
+    # fabricpath_interval is an array of fabricpath_interval,
+    # fabricpath_min_rx and fabricpath_multiplier
+    # CLI: bfd fabricpath interval 100 min_rx 100 multiplier 25
+    def fabricpath_interval
+      config_get('bfd_global', 'fabricpath_interval', @get_args)
+    end
+
+    # interval is an array of interval, min_rx and multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd interval 100 min_rx 100 multiplier 25
+    def interval=(arr)
+      return if arr == interval
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_interval ? 'no' : '')
+      config_set('bfd_global', 'interval', @set_args)
+    end
+
+    # ipv4_interval is an array of ipv4_interval, ipv4_min_rx and
+    # ipv4_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd ipv4 interval 100 min_rx 100 multiplier 25
+    def ipv4_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_ipv4_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv4_interval', @set_args)
+    end
+
+    # ipv6_interval is an array of ipv6_interval, ipv6_min_rx and
+    # ipv6_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd ipv6 interval 100 min_rx 100 multiplier 25
+    def ipv6_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_ipv6_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv6_interval', @set_args)
+    end
+
+    # fabricpath_interval is an array of fabricpath_interval,
+    # fabricpath_min_rx and fabricpath_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd fabricpath interval 100 min_rx 100 multiplier 25
+    def fabricpath_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_fabricpath_interval ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_interval', @set_args)
+    end
+  end # class
+end # module