cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/interface_channel_group.rb

@@ -26,6 +26,10 @@ module Cisco
       validate_args(name)
     end
 
+    def to_s
+      "interface_channel_group #{name}"
+    end
+
     def self.interfaces
       hash = {}
       all = config_get('interface_channel_group', 'all_interfaces')
@@ -52,10 +56,6 @@ module Cisco
       @set_args = @get_args.merge!(hash) unless hash.empty?
     end
 
-    def fail_cli(e)
-      fail "[#{@name}] '#{e.command}' : #{e.clierror}"
-    end
-
     ########################################################
     #                      PROPERTIES                      #
     ########################################################
@@ -65,12 +65,13 @@ module Cisco
     end
 
     def channel_group=(group)
-      # 'force' is needed by cli_nxos to handle the case where a port-channel
+      # 'force' is needed by NXOS to handle the case where a port-channel
       # interface is created prior to the channel-group cli; in which case
       # the properties of the port-channel interface will be different from
       # the ethernet interface. 'force' is not needed if the port-channel is
       # created as a result of the channel-group cli but since it does no
       # harm we will use it every time.
+      # IOS XR simply ignores 'force'
       if group
         state = ''
         force = 'force'
@@ -81,7 +82,11 @@ module Cisco
       config_set('interface_channel_group', 'channel_group',
                  set_args_keys(state: state, group: group, force: force))
     rescue Cisco::CliError => e
-      fail_cli(e)
+      # Some XR platforms do not support channel-group configuration
+      # on some OS versions. Since this is an OS version difference and not
+      # a platform difference, we can't handle this in the YAML.
+      raise unless e.message[/the entered commands do not exist/]
+      raise Cisco::UnsupportedError.new('interface', 'channel_group')
     end
 
     def default_channel_group
@@ -97,8 +102,6 @@ module Cisco
       state = desc.strip.empty? ? 'no' : ''
       config_set('interface_channel_group', 'description',
                  set_args_keys(state: state, desc: desc))
-    rescue Cisco::CliError => e
-      fail_cli(e)
     end
 
     def default_description
@@ -113,8 +116,6 @@ module Cisco
     def shutdown=(state)
       config_set('interface_channel_group', 'shutdown',
                  set_args_keys(state: state ? '' : 'no'))
-    rescue Cisco::CliError => e
-      fail_cli(e)
     end
 
     def default_shutdown

data/lib/cisco_node_utils/interface_ospf.rb

@@ -41,8 +41,7 @@ module Cisco
       @ospf_name = ospf_name
 
       return unless create
-      # enable feature ospf if it isn't
-      RouterOspf.enable unless RouterOspf.enabled
+      Feature.ospf_enable
 
       config_set('interface_ospf', 'area', @interface.name,
                  '', @ospf_name, area)

data/lib/cisco_node_utils/interface_portchannel.rb

@@ -32,6 +32,10 @@ module Cisco
       create if instantiate
     end
 
+    def to_s
+      "interface_port_channel #{name}"
+    end
+
     def self.interfaces
       hash = {}
       intf_list = config_get('interface', 'all_interfaces')
@@ -65,8 +69,6 @@ module Cisco
       no_cmd = (state ? '' : 'no')
       config_set('interface_portchannel',
                  'lacp_graceful_convergence', @name, no_cmd)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_lacp_graceful_convergence
@@ -79,8 +81,6 @@ module Cisco
 
     def lacp_max_bundle=(val)
       config_set('interface_portchannel', 'lacp_max_bundle', @name, val)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_lacp_max_bundle
@@ -93,8 +93,6 @@ module Cisco
 
     def lacp_min_links=(val)
       config_set('interface_portchannel', 'lacp_min_links', @name, val)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_lacp_min_links
@@ -109,8 +107,6 @@ module Cisco
       no_cmd = (state ? '' : 'no')
       config_set('interface_portchannel',
                  'lacp_suspend_individual', @name, no_cmd)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_lacp_suspend_individual
@@ -130,8 +126,6 @@ module Cisco
       end
       config_set('interface_portchannel',
                  'port_hash_distribution', @name, state, val)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_port_hash_distribution
@@ -146,8 +140,6 @@ module Cisco
       no_cmd = (state ? '' : 'no')
       config_set('interface_portchannel',
                  'port_load_defer', @name, no_cmd)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_port_load_defer

data/lib/cisco_node_utils/interface_service_vni.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require_relative 'node_util'
-require_relative 'vni'
+require_relative 'feature'
 
 module Cisco
   # InterfaceServiceVni - node utility class for Service VNI Instance commands
@@ -30,6 +30,10 @@ module Cisco
       create if instantiate
     end
 
+    def to_s
+      "interface_service_vni #{name} #{@sid}"
+    end
+
     def self.svc_vni_ids
       hash = {}
       intf_list = config_get('interface', 'all_interfaces')
@@ -49,7 +53,7 @@ module Cisco
     end
 
     def create
-      Vni.feature_vni_enable unless Vni.feature_vni_enabled
+      Feature.vni_enable
       @set_args[:state] = ''
       config_set('interface_service_vni', 'create_destroy', @set_args)
     end
@@ -87,7 +91,7 @@ module Cisco
     end
 
     def encapsulation_profile_vni=(profile)
-      Vni.feature_vni_enable unless Vni.feature_vni_enabled
+      Feature.vni_enable
       state = profile.empty? ? 'no' : ''
       current = encapsulation_profile_vni
 
@@ -103,8 +107,6 @@ module Cisco
         config_set('interface_service_vni', 'encapsulation_profile_vni',
                    set_args_keys(state: state, profile: profile))
       end
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_encapsulation_profile_vni
@@ -121,8 +123,6 @@ module Cisco
     def shutdown=(state)
       config_set('interface_service_vni', 'shutdown',
                  set_args_keys(state: state ? '' : 'no'))
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_shutdown

data/lib/cisco_node_utils/itd_device_group.rb

@@ -0,0 +1,248 @@
+# February 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 itd_device_group
+  class ItdDeviceGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name.length > 0
+      @name = name
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    def self.itds
+      hash = {}
+      groups = config_get('itd_device_group',
+                          'all_itd_device_groups')
+      return hash if groups.nil?
+
+      groups.each do |id|
+        hash[id] = ItdDeviceGroup.new(id, false)
+      end
+      hash
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def create
+      Feature.itd_enable
+      config_set('itd_device_group', 'create', name: @name)
+    end
+
+    def destroy
+      config_set('itd_device_group', 'destroy', name: @name)
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      keys = { name: @name }
+      @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
+
+    # extract value of property from probe
+    def extract_value(prop, prefix=nil)
+      prefix = prop if prefix.nil?
+      probe_match = probe_get
+
+      # matching probe not found
+      return nil if probe_match.nil? # no matching probe found
+
+      # property not defined for matching probe
+      return nil unless probe_match.names.include?(prop)
+
+      # extract and return value that follows prefix + <space>
+      regexp = Regexp.new("#{Regexp.escape(prefix)} (?<extracted>.*)")
+      value_match = regexp.match(probe_match[prop])
+      return nil if value_match.nil?
+      value_match[:extracted]
+    end
+
+    # prepend property name prefix/keyword to value
+    def attach_prefix(val, prop, prefix=nil)
+      prefix = prop.to_s if prefix.nil?
+      @set_args[prop] = val.to_s.empty? ? val : "#{prefix} #{val}"
+    end
+
+    # probe configuration is all done in a single line (like below)
+    # probe tcp port 32 frequency 10 timeout 5 retry-down-count 3 ...
+    # probe udp port 23 frequency 10 timeout 5 retry-down-count 3 ...
+    # probe icmp frequency 10 timeout 5 retry-down-count 3 retry-up-count 3
+    # probe dns host 8.8.8.8 frequency 10 timeout 5 retry-down-count 3 ...
+    # also the 'control enable' can be set if the type is tcp or udp only
+    # probe udp port 23 control enable frequency 10 timeout 5 ...
+    def probe_get
+      str = config_get('itd_device_group', 'probe', @get_args)
+      return nil if str.nil?
+      regexp = Regexp.new('(?<type>\S+)'\
+                 ' *(?<dns_host>host \S+)?'\
+                 ' *(?<port>port \d+)?'\
+                 ' *(?<control>control \S+)?'\
+                 ' *(?<frequency>frequency \d+)?'\
+                 ' *(?<timeout>timeout \d+)'\
+                 ' *(?<retry_down>retry-down-count \d+)'\
+                 ' *(?<retry_up>retry-up-count \d+)')
+      regexp.match(str)
+    end
+
+    def probe_control
+      val = extract_value('control')
+      return default_probe_control if val.nil?
+      val == 'enable' ? true : default_probe_control
+    end
+
+    def probe_control=(control)
+      if control
+        @set_args[:control] = 'control enable'
+      else
+        @set_args[:control] = ''
+      end
+    end
+
+    def default_probe_control
+      config_get_default('itd_device_group', 'probe_control')
+    end
+
+    def probe_dns_host
+      extract_value('dns_host', 'host')
+    end
+
+    def probe_dns_host=(dns_host)
+      attach_prefix(dns_host, :dns_host, 'host')
+    end
+
+    def probe_frequency
+      val = extract_value('frequency')
+      return default_probe_frequency if val.nil?
+      val.to_i
+    end
+
+    def probe_frequency=(frequency)
+      attach_prefix(frequency, :frequency)
+    end
+
+    def default_probe_frequency
+      config_get_default('itd_device_group', 'probe_frequency')
+    end
+
+    def probe_port
+      val = extract_value('port')
+      val.to_i unless val.nil?
+    end
+
+    def probe_port=(port)
+      attach_prefix(port, :port)
+    end
+
+    def probe_retry_down
+      val = extract_value('retry_down', 'retry-down-count')
+      return default_probe_retry_down if val.nil?
+      val.to_i
+    end
+
+    def probe_retry_down=(rdc)
+      attach_prefix(rdc, :retry_down_count, 'retry-down-count')
+    end
+
+    def default_probe_retry_down
+      config_get_default('itd_device_group', 'probe_retry_down')
+    end
+
+    def probe_retry_up
+      val = extract_value('retry_up', 'retry-up-count')
+      return default_probe_retry_up if val.nil?
+      val.to_i
+    end
+
+    def probe_retry_up=(ruc)
+      attach_prefix(ruc, :retry_up_count, 'retry-up-count')
+    end
+
+    def default_probe_retry_up
+      config_get_default('itd_device_group', 'probe_retry_up')
+    end
+
+    def probe_timeout
+      val = extract_value('timeout')
+      return default_probe_timeout if val.nil?
+      val.to_i
+    end
+
+    def probe_timeout=(timeout)
+      attach_prefix(timeout, :timeout)
+    end
+
+    def default_probe_timeout
+      config_get_default('itd_device_group', 'probe_timeout')
+    end
+
+    def probe_type
+      match = probe_get
+      return default_probe_type if match.nil?
+      match.names.include?('type') ? match[:type] : default_probe_type
+    end
+
+    def probe_type=(type)
+      @set_args[:type] = type
+    end
+
+    def default_probe_type
+      config_get_default('itd_device_group', 'probe_type')
+    end
+
+    def probe_set(attrs)
+      if attrs[:probe_type] == false
+        cmd = 'probe_type'
+        @set_args[:state] = 'no'
+      else
+        cmd = 'probe'
+        set_args_keys_default
+        set_args_keys(attrs)
+        [:probe_type,
+         :probe_dns_host,
+         :probe_port,
+         :probe_control,
+         :probe_frequency,
+         :probe_timeout,
+         :probe_retry_down,
+         :probe_retry_up,
+        ].each do |p|
+          attrs[p] = '' if attrs[p].nil?
+          send(p.to_s + '=', attrs[p])
+        end
+        # for boolean we need to do this
+        send('probe_control=', false) if attrs[:probe_control] == ''
+        @get_args = @set_args
+      end
+      config_set('itd_device_group', cmd, @set_args)
+      set_args_keys_default
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/itd_device_group_node.rb

@@ -0,0 +1,144 @@
+# February 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 'itd_device_group'
+
+module Cisco
+  # node_utils class for itd_device_group_node
+  class ItdDeviceGroupNode < ItdDeviceGroup
+    attr_reader :itd_device_group_name, :name, :node_type
+
+    def initialize(itd_dg_name, node_name, node_type, instantiate=true)
+      fail TypeError unless itd_dg_name.is_a?(String)
+      fail TypeError unless node_name.is_a?(String)
+      fail ArgumentError unless itd_dg_name.length > 0
+      fail ArgumentError unless node_name.length > 0
+
+      @itd_device_group_name = itd_dg_name
+      @itddg = ItdDeviceGroup.itds[itd_dg_name]
+      fail "itd device-group #{itd_dg_name} does not exist" if
+      @itddg.nil?
+      @name = node_name
+      @node_type = node_type
+
+      set_args_keys_default
+      create_node if instantiate
+    end
+
+    # itd_device_group_nodes have the name form as
+    # node ip 1.1.1.1
+    # node IPv6 2000::1
+    # and they depdend on the device_group
+    def self.itd_nodes(node_name=nil)
+      fail TypeError unless node_name.is_a?(String) || node_name.nil?
+      itd_nodes = {}
+      itd_list = ItdDeviceGroup.itds
+      return itd_nodes if itd_list.nil?
+      itd_list.keys.each do |name|
+        itd_nodes[name] = {}
+        match = config_get('itd_device_group',
+                           'all_itd_device_group_nodes', name: name)
+        next if match.nil?
+        match.each do |vars|
+          ntype = vars[0]
+          nname = vars[1].strip
+          next unless node_name.nil? || nname == node_name
+          itd_nodes[name][nname] =
+              ItdDeviceGroupNode.new(name, nname, ntype, false)
+        end
+      end
+      itd_nodes
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def ==(other)
+      (itd_device_group_name == other.itd_device_group_name) &&
+        (name == other.name) && (node_type == other.node_type)
+    end
+
+    def create_node
+      config_set('itd_device_group', 'create_node',
+                 name: @itddg.name, ntype: @node_type, nname: @name)
+    end
+
+    def destroy
+      config_set('itd_device_group', 'destroy_node', name: @itddg.name,
+                ntype: @node_type, nname: @name)
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { name: @itddg.name }
+      @set_args[:ntype] = @node_type
+      @set_args[:nname] = @name
+      @get_args = @set_args
+    end
+
+    def hot_standby
+      config_get('itd_device_group', 'hot_standby', @get_args)
+    end
+
+    # DO NOT call this directly
+    def lhot_standby=(state)
+      no_cmd = (state ? '' : 'no')
+      @set_args[:state] = no_cmd
+      config_set('itd_device_group', 'hot_standby', @set_args)
+      set_args_keys_default
+    end
+
+    def default_hot_standby
+      config_get_default('itd_device_group', 'hot_standby')
+    end
+
+    def weight
+      config_get('itd_device_group', 'weight', @get_args)
+    end
+
+    # DO NOT call this directly
+    def lweight=(val)
+      @set_args[:state] = val == default_weight ? 'no' : ''
+      @set_args[:weight] = val
+      config_set('itd_device_group', 'weight', @set_args)
+    end
+
+    # Call this for setting hot_standby and weight together because
+    # the CLI is pretty weird and it accepts these params in a very
+    # particular way and they cannot even be reset unless proper
+    # order is followed
+    def hs_weight(hs, wt)
+      if hs != hot_standby && hot_standby == default_hot_standby
+        self.lweight = wt unless weight == wt
+        self.lhot_standby = hs
+      elsif hs != hot_standby && hot_standby != default_hot_standby
+        self.lhot_standby = hs
+        self.lweight = wt unless weight == wt
+      elsif wt != weight && weight == default_weight
+        self.lweight = wt
+      elsif wt != weight && weight != default_weight
+        self.lweight = wt
+      end
+      set_args_keys_default
+    end
+
+    def default_weight
+      config_get_default('itd_device_group', 'weight')
+    end
+  end  # Class
+end    # Module