cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/configparser_lib.rb

@@ -0,0 +1,195 @@
+# Shared Library to compare configurations.
+#
+# Copyright (c) 2013-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.
+#
+# Current      | Target       | Configuration Case
+#  no  command |  no  command | to Match Existing
+# ------------------------------------------
+#  -      -    |  -      a    |        (no match or trans match)
+#  -      -    |  y      a    | no match nor base match
+#  -      a    |  -      a    | match
+#  -      a    |  y      a    |        (base match)
+#  y      a    |  -      a    |        (base match)
+#  y      a    |  y      a    | match
+#  -      b    |  -      a    | trans match
+#  -      b    |  y      a    |        (base match)
+#  y      b    |  -      a    |        (base match)
+#  y      b    |  y      a    | trans match)
+
+module Cisco
+  module ConfigParser
+    # Configuration class - helper for dealing with config CLI
+    class Configuration
+      attr_accessor :configuration
+
+      # Constructor for Configuration
+      #
+      # @raise [ArgumentError] if config_str is not a String
+      # @param config_str [String] to parse
+      def initialize(config_str)
+        unless config_str.kind_of? String
+          fail ArgumentError, 'Argument is not a String.'
+        end
+
+        @configuration = {}
+        @ordered_keys = []
+        @indent = ''
+        parse(config_str)
+      end # initialize
+
+      # build_min_config_hash
+      #
+      # Build a config hash of the minimum keys that would be needed to update
+      # current config to all of the changes in the "must" config. Each hash key
+      # is a configuration command; some keys have subconfigs which must be
+      # checked before dismissing top-level keys as present. This method is
+      # used primarily by the free-form command_config providers.
+      #
+      # @param current     [Hash] superset of running-config & must config
+      # @param must        [Hash] pending config from recipe, manifest, etc
+      # @param min_config  [Hash] in-progress recursion-built minimum config
+      # @return min_config [Hash] in-progress recursion-built minimum config
+      #
+      def self.build_min_config_hash(current, must, min_config={})
+        return {} if must.empty? # base case
+        must.each do |k, v| # check each must{k} is present in current{}
+          if current.key?(k) # if cmd is in current then compare subconfig
+            min_config[k] = Configuration.new('')
+            min_config[k].configuration =
+              build_min_config_hash(current[k].configuration,
+                                    v.configuration, {})
+            if min_config[k].configuration.empty?
+              # no differing subconfigs, so empty hash is returned
+              min_config.delete(k)
+            end
+          else # command NOT in current, apply it + all subcommands
+            min_config[k] = v
+          end
+        end
+        min_config
+      end # build_min_config_hash
+
+      def self.config_hash_to_str(cmd_hash, str='')
+        return '' if cmd_hash.empty?
+        cmd_hash.each do |k, v|
+          str += k + "\n"
+          str += config_hash_to_str(v.configuration, '')
+        end
+        str
+      end # config_hash_to_str
+
+      # Get base command and prefix
+      #
+      # @param command [String]
+      # @return [String, String] containing prefix (if any) and
+      #         base command.
+      def base_commands(command)
+        prefix, base = command.match(/^(no )?(.*)$/).captures
+        prefix = '' if prefix.nil?
+        [prefix, base]
+      end # base_commands
+
+      # Compare ConfigParser::Configuration objects
+      #
+      # @param config [ConfigParser::Configuration] obj to search
+      #        for match.
+      # @return [String] containing match, empty if no match found.
+      def compare_with(config)
+        return nil if config.nil?
+        existing = ''
+        @ordered_keys.each do |config_line|
+          command = config_line.strip
+          submode = @configuration[command]
+          fail StopIteration, 'Could not find submode.' if submode.nil?
+
+          if special_command?(command)
+            # match special exit/end command
+            existing << config_line
+            break
+          elsif config.include_command?(command)
+            # match whole command
+            existing << config_line
+            config_submode = config.submode_config(command)
+            existing << submode.compare_with(config_submode)
+            next
+          end # if
+        end
+        existing
+      end # compare_with
+
+      # @return [Array] containing command with leading/trailing
+      #                 whitespace removed.
+      def mode_configuration
+        @ordered_keys.collect(&:strip)
+      end # mode_configuration
+
+      # Check command [Array] for test command
+      #
+      # @param command [String] test command
+      # @return [Boolean] true if command found, else false
+      def include_command?(command)
+        commands = mode_configuration
+        commands.include?(command)
+      end # include_command?
+
+      # Parse each config command line and create a
+      # hash of ConfigParser::Configuration objects
+      #
+      # @param config_str [String] Config command
+      def parse(config_str)
+        config_str += "\n"
+        config_str.gsub!(/^\s*$\n/, '')
+        # ignore leading ! or # (comments)
+        config_str.gsub!(/^\s*[!#].*$\n/, '')
+        if config_str.match(/^ *\t/)
+          highlight_str = config_str.gsub(/\t/, '[TAB]')
+          fail "Tab character detected in indentation area:\n" + highlight_str
+        end
+        indent_level = config_str.match(/^\s*/)
+        @indent = indent_level.to_s # capture indentation of level
+        escaped_indent = Regexp.escape(@indent)
+        # Find current configuration mode lines
+        @ordered_keys = config_str.scan(/^#{escaped_indent}\S.*\n/)
+        @ordered_keys.each do |config_line|
+          command = config_line.strip
+          escaped_cmd = Regexp.escape(config_line)
+          submode_string = config_str.match(
+            /^(?:#{escaped_cmd})((?:#{escaped_indent}\s.+\n)*)/).captures.join
+          @configuration[command] = Configuration.new(submode_string)
+        end
+      end # parse
+
+      # Process 'exit' and 'end' commands
+      #
+      # @param command [String] Configuration command.
+      # @return [Boolean] true when command is
+      #         'exit' or 'end', else false
+      def special_command?(command)
+        command =~ /^(?:exit|end)/
+      end # special_command?
+
+      # Fetch ConfigParser::Configuration object containing config_line
+      #
+      # @param config_line [String]
+      # @return [ConfigParser::Configuration] containing config_line
+      def submode_config(config_line)
+        command = config_line.strip
+        @configuration[command]
+      end # submode_config
+
+      private :base_commands, :parse, :special_command?
+    end # Configuration
+  end # ConfigParser
+end # Cisco

data/lib/cisco_node_utils/constants.rb

@@ -0,0 +1,40 @@
+# January 2016, Glenn F. Matthews
+#
+# 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.
+
+# Shared constants for the Cisco module
+module Cisco
+  PLATFORMS = [
+    # Cisco IOS XR
+    :ios_xr,
+    # Cisco NX-OS (Nexus switches)
+    :nexus,
+  ]
+
+  DATA_FORMATS = [
+    # Cisco CLI. Indentation is significant.
+    :cli,
+    # Structured data format specific to NX-API
+    :nxapi_structured,
+    # YANG JSON
+    :yang_json,
+  ]
+
+  YANG_SET_MODE = [
+    :merge_config,
+    :replace_config,
+    :delete_config,
+  ]
+end

data/lib/cisco_node_utils/dhcp_relay_global.rb

@@ -0,0 +1,302 @@
+# September 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 dhcp_relay_global
+  class DhcpRelayGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(instantiate=true)
+      Feature.dhcp_enable if instantiate
+      set_args_keys_default
+    end
+
+    def self.globals
+      hash = {}
+      hash['default'] = DhcpRelayGlobal.new(false) if Feature.dhcp_enabled?
+      hash
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = {}
+      @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
+      return unless Feature.dhcp_enabled?
+      [:ipv4_information_option,
+       :ipv4_information_option_trust,
+       :ipv4_information_option_vpn,
+       :ipv4_information_trust_all,
+       :ipv4_relay,
+       :ipv4_smart_relay,
+       :ipv4_src_addr_hsrp,
+       :ipv4_src_intf,
+       :ipv4_sub_option_circuit_id_custom,
+       :ipv4_sub_option_circuit_id_string,
+       :ipv4_sub_option_cisco,
+       :ipv6_option_cisco,
+       :ipv6_option_vpn,
+       :ipv6_relay,
+       :ipv6_src_intf,
+      ].each do |prop|
+        send("#{prop}=", send("default_#{prop}")) if send prop
+      end
+      set_args_keys_default
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def ipv4_information_option
+      config_get('dhcp_relay_global', 'ipv4_information_option')
+    end
+
+    def ipv4_information_option=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option', @set_args)
+    end
+
+    def default_ipv4_information_option
+      config_get_default('dhcp_relay_global', 'ipv4_information_option')
+    end
+
+    def ipv4_information_option_trust
+      config_get('dhcp_relay_global', 'ipv4_information_option_trust')
+    end
+
+    def ipv4_information_option_trust=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option_trust',
+                 @set_args)
+    end
+
+    def default_ipv4_information_option_trust
+      config_get_default('dhcp_relay_global', 'ipv4_information_option_trust')
+    end
+
+    def ipv4_information_option_vpn
+      config_get('dhcp_relay_global', 'ipv4_information_option_vpn')
+    end
+
+    def ipv4_information_option_vpn=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option_vpn', @set_args)
+    end
+
+    def default_ipv4_information_option_vpn
+      config_get_default('dhcp_relay_global', 'ipv4_information_option_vpn')
+    end
+
+    def ipv4_information_trust_all
+      config_get('dhcp_relay_global', 'ipv4_information_trust_all')
+    end
+
+    def ipv4_information_trust_all=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_trust_all', @set_args)
+    end
+
+    def default_ipv4_information_trust_all
+      config_get_default('dhcp_relay_global', 'ipv4_information_trust_all')
+    end
+
+    def ipv4_relay
+      config_get('dhcp_relay_global', 'ipv4_relay')
+    end
+
+    def ipv4_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_relay', @set_args)
+    end
+
+    def default_ipv4_relay
+      config_get_default('dhcp_relay_global', 'ipv4_relay')
+    end
+
+    def ipv4_smart_relay
+      config_get('dhcp_relay_global', 'ipv4_smart_relay')
+    end
+
+    def ipv4_smart_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_smart_relay', @set_args)
+    end
+
+    def default_ipv4_smart_relay
+      config_get_default('dhcp_relay_global', 'ipv4_smart_relay')
+    end
+
+    def ipv4_src_addr_hsrp
+      config_get('dhcp_relay_global', 'ipv4_src_addr_hsrp')
+    end
+
+    def ipv4_src_addr_hsrp=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_src_addr_hsrp', @set_args)
+    end
+
+    def default_ipv4_src_addr_hsrp
+      config_get_default('dhcp_relay_global', 'ipv4_src_addr_hsrp')
+    end
+
+    def ipv4_src_intf
+      intf = config_get('dhcp_relay_global', 'ipv4_src_intf')
+      intf = intf.downcase.delete(' ') if intf
+      intf
+    end
+
+    def ipv4_src_intf=(val)
+      state = val == default_ipv4_src_intf ? 'no' : ''
+      intf = val == default_ipv4_src_intf ? '' : val
+      set_args_keys(state: state, intf: intf)
+      config_set('dhcp_relay_global', 'ipv4_src_intf', @set_args)
+    end
+
+    def default_ipv4_src_intf
+      config_get_default('dhcp_relay_global', 'ipv4_src_intf')
+    end
+
+    def ipv4_sub_option_circuit_id_custom
+      config_get('dhcp_relay_global', 'ipv4_sub_option_circuit_id_custom')
+    end
+
+    def ipv4_sub_option_circuit_id_custom=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_circuit_id_custom',
+                 @set_args)
+    end
+
+    def default_ipv4_sub_option_circuit_id_custom
+      config_get_default('dhcp_relay_global',
+                         'ipv4_sub_option_circuit_id_custom')
+    end
+
+    def ipv4_sub_option_circuit_id_string
+      str = config_get('dhcp_relay_global', 'ipv4_sub_option_circuit_id_string')
+      # Normalize by removing white space and add quotes
+      str.strip! if str.kind_of?(String)
+      str
+    end
+
+    def ipv4_sub_option_circuit_id_string=(val)
+      state = val == default_ipv4_sub_option_circuit_id_string ? 'no' : ''
+      format = val == default_ipv4_sub_option_circuit_id_string ? '' : 'format'
+      word = val == default_ipv4_sub_option_circuit_id_string ? '' : val
+      word = Utils.add_quotes(word) unless word.empty?
+      set_args_keys(state: state, format: format, word: word)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_circuit_id_string',
+                 @set_args)
+    end
+
+    def default_ipv4_sub_option_circuit_id_string
+      config_get_default('dhcp_relay_global',
+                         'ipv4_sub_option_circuit_id_string')
+    end
+
+    def ipv4_sub_option_cisco
+      config_get('dhcp_relay_global', 'ipv4_sub_option_cisco')
+    end
+
+    def ipv4_sub_option_cisco=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_cisco', @set_args)
+    end
+
+    def default_ipv4_sub_option_cisco
+      config_get_default('dhcp_relay_global', 'ipv4_sub_option_cisco')
+    end
+
+    def ipv6_option_cisco
+      config_get('dhcp_relay_global', 'ipv6_option_cisco')
+    end
+
+    def ipv6_option_cisco=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_option_cisco', @set_args)
+    end
+
+    def default_ipv6_option_cisco
+      config_get_default('dhcp_relay_global', 'ipv6_option_cisco')
+    end
+
+    def ipv6_option_vpn
+      config_get('dhcp_relay_global', 'ipv6_option_vpn')
+    end
+
+    def ipv6_option_vpn=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_option_vpn', @set_args)
+    end
+
+    def default_ipv6_option_vpn
+      config_get_default('dhcp_relay_global', 'ipv6_option_vpn')
+    end
+
+    def ipv6_relay
+      config_get('dhcp_relay_global', 'ipv6_relay')
+    end
+
+    def ipv6_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_relay', @set_args)
+    end
+
+    def default_ipv6_relay
+      config_get_default('dhcp_relay_global', 'ipv6_relay')
+    end
+
+    def ipv6_src_intf
+      intf = config_get('dhcp_relay_global', 'ipv6_src_intf')
+      # Normalize by downcasing and removing white space
+      intf = intf.downcase.delete(' ') if intf
+      intf
+    end
+
+    def ipv6_src_intf=(val)
+      state = val == default_ipv6_src_intf ? 'no' : ''
+      intf = val == default_ipv6_src_intf ? '' : val
+      set_args_keys(state: state, intf: intf)
+      config_set('dhcp_relay_global', 'ipv6_src_intf', @set_args)
+    end
+
+    def default_ipv6_src_intf
+      config_get_default('dhcp_relay_global', 'ipv6_src_intf')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/dns_domain.rb

@@ -0,0 +1,93 @@
+#
+# NXAPI implementation of DnsDomain class
+#
+# September 2015, Hunter Haugen
+#
+# 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.
+#
+# "group" is a standard SNMP term but in NXOS "role" is used to serve the
+# purpose of group; thus this provider utility does not create snmp groups
+# and is limited to reporting group (role) existence only.
+
+require_relative 'node_util'
+
+module Cisco
+  # DnsDomain - node utility class for DNS search domain config management
+  class DnsDomain < NodeUtil
+    attr_reader :name, :vrf
+
+    def initialize(name, vrf=nil, instantiate=true)
+      unless name.is_a? String
+        fail TypeError, "Expected a string, got a #{name.class.inspect}"
+      end
+      @name = name
+      @vrf = vrf
+      create if instantiate
+    end
+
+    def self.dnsdomains(vrf=nil)
+      if vrf.nil?
+        domains = config_get('dnsclient', 'domain_list')
+      else
+        domains = config_get('dnsclient', 'domain_list_vrf', vrf: vrf)
+      end
+      hash = {}
+      domains.each do |name|
+        hash[name] = DnsDomain.new(name, vrf, false)
+      end
+      hash
+    end
+
+    def ==(other)
+      (name == other.name) && (vrf == other.vrf)
+    end
+
+    def create
+      if @vrf.nil?
+        config_set('dnsclient', 'domain_list',
+                   state: '', name: @name)
+      else
+        # On some platforms attempts to create a new domain-list results
+        # in the error. 'ERROR: Deletion of VRF test in progresswait
+        # for it to complete'.  We handle this by trying up to 20 times
+        # with a 1 second delay between attempts before giving up.
+        tries = 20
+        begin
+          config_set('dnsclient', 'domain_list_vrf',
+                     state: '', name: @name, vrf: @vrf)
+        rescue Cisco::CliError => e
+          if /ERROR: Deletion of VRF .* in progress/.match(e.to_s)
+            sleep 1
+            tries -= 1
+            # rubocop:disable Metrics/BlockNesting
+            retry if tries > 0
+            # rubocop:enable Metrics/BlockNesting
+          end
+          raise
+        end
+      end
+    end
+
+    def destroy
+      if @vrf.nil?
+        config_set('dnsclient', 'domain_list',
+                   state: 'no', name: @name)
+      else
+        config_set('dnsclient', 'domain_list_vrf',
+                   state: 'no', name: @name, vrf: @vrf)
+      end
+    end
+  end
+end