cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/interface_channel_group.rb

@@ -0,0 +1,124 @@
+# January 2016, 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'
+
+# Add some interface-specific constants to the Cisco namespace
+module Cisco
+  # Interface - node utility class for general interface config management
+  class InterfaceChannelGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      validate_args(name)
+    end
+
+    def self.interfaces
+      hash = {}
+      all = config_get('interface_channel_group', 'all_interfaces')
+      return hash if all.nil?
+
+      all.each do |id|
+        id = id.downcase
+        hash[id] = InterfaceChannelGroup.new(id)
+      end
+      hash
+    end
+
+    def validate_args(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name.length > 0
+      fail "channel_group is not supported on #{name}" unless
+        name[/Ethernet/i]
+      @name = name.downcase
+      set_args_keys
+    end
+
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      @get_args = { name: @name }
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    def fail_cli(e)
+      fail "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def channel_group
+      config_get('interface_channel_group', 'channel_group', @get_args)
+    end
+
+    def channel_group=(group)
+      # 'force' is needed by cli_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.
+      if group
+        state = ''
+        force = 'force'
+      else
+        state = 'no'
+        group = force = ''
+      end
+      config_set('interface_channel_group', 'channel_group',
+                 set_args_keys(state: state, group: group, force: force))
+    rescue Cisco::CliError => e
+      fail_cli(e)
+    end
+
+    def default_channel_group
+      config_get_default('interface_channel_group', 'channel_group')
+    end
+
+    # ----------------------------
+    def description
+      config_get('interface_channel_group', 'description', @get_args)
+    end
+
+    def description=(desc)
+      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
+      config_get_default('interface_channel_group', 'description')
+    end
+
+    # ----------------------------
+    def shutdown
+      config_get('interface_channel_group', 'shutdown', @get_args)
+    end
+
+    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
+      config_get_default('interface_channel_group', 'shutdown')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/interface_ospf.rb

@@ -1,6 +1,6 @@
 # March 2015, Alex Hunsberger
 #
-# Copyright (c) 2015 Cisco and/or its affiliates.
+# 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.
@@ -59,8 +59,6 @@ module Cisco
       intf_list.each do |name|
         match = config_get('interface_ospf', 'area', name)
         next if match.nil?
-        # should only be a single match under a given interface
-        match = match.first
         # ip router ospf <name> area <area>
         ospf = match[0]
         area = match[1]
@@ -74,7 +72,7 @@ module Cisco
     def area
       match = config_get('interface_ospf', 'area', @interface.name)
       return nil if match.nil?
-      val = match[0][1]
+      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
@@ -103,8 +101,7 @@ module Cisco
     end
 
     def message_digest
-      !config_get('interface_ospf', 'message_digest',
-                  @interface.name).nil?
+      config_get('interface_ospf', 'message_digest', @interface.name)
     end
 
     # interface %s
@@ -119,10 +116,7 @@ module Cisco
     end
 
     def message_digest_key_id
-      match = config_get('interface_ospf', 'message_digest_key_id',
-                         @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      match.nil? ? default_message_digest_key_id : match.first.to_i
+      config_get('interface_ospf', 'message_digest_key_id', @interface.name)
     end
 
     def default_message_digest_algorithm_type
@@ -133,8 +127,7 @@ module Cisco
     def message_digest_algorithm_type
       match = config_get('interface_ospf', 'message_digest_alg_type',
                          @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      match.nil? ? default_message_digest_algorithm_type : match.first.to_sym
+      match.to_sym
     end
 
     def default_message_digest_encryption_type
@@ -145,18 +138,11 @@ module Cisco
     def message_digest_encryption_type
       match = config_get('interface_ospf', 'message_digest_enc_type',
                          @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      if match.nil?
-        default_message_digest_encryption_type
-      else
-        Encryption.cli_to_symbol(match.first)
-      end
+      Encryption.cli_to_symbol(match)
     end
 
     def message_digest_password
-      match = config_get('interface_ospf', 'message_digest_password',
-                         @interface.name)
-      match.nil? ? nil : match.first
+      config_get('interface_ospf', 'message_digest_password', @interface.name)
     end
 
     # interface %s
@@ -177,9 +163,7 @@ module Cisco
     end
 
     def cost
-      match = config_get('interface_ospf', 'cost', @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      match.nil? ? default_cost : match.first.to_i
+      config_get('interface_ospf', 'cost', @interface.name)
     end
 
     def default_cost
@@ -197,10 +181,7 @@ module Cisco
     end
 
     def hello_interval
-      match = config_get('interface_ospf', 'hello_interval',
-                         @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      match.nil? ? default_hello_interval : match.first.to_i
+      config_get('interface_ospf', 'hello_interval', @interface.name)
     end
 
     def default_hello_interval
@@ -215,10 +196,7 @@ module Cisco
     end
 
     def dead_interval
-      match = config_get('interface_ospf', 'dead_interval',
-                         @interface.name)
-      # regex in yaml returns an array result, use .first to get match
-      match.nil? ? default_dead_interval : match.first.to_i
+      config_get('interface_ospf', 'dead_interval', @interface.name)
     end
 
     def default_dead_interval
@@ -237,8 +215,7 @@ module Cisco
     end
 
     def passive_interface
-      !config_get('interface_ospf', 'passive_interface',
-                  @interface.name).nil?
+      config_get('interface_ospf', 'passive_interface', @interface.name)
     end
 
     # interface %s

data/lib/cisco_node_utils/interface_portchannel.rb

@@ -0,0 +1,157 @@
+# December 2015, Sai Chintalapudi
+#
+# 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 '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 self.interfaces
+      hash = {}
+      intf_list = config_get('interface', '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 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)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    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)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    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)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_lacp_min_links
+      config_get_default('interface_portchannel', 'lacp_min_links')
+    end
+
+    def lacp_suspend_individual
+      config_get('interface_portchannel', 'lacp_suspend_individual', @name)
+    end
+
+    def lacp_suspend_individual=(state)
+      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
+      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)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    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)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    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 'vni'
+
+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 self.svc_vni_ids
+      hash = {}
+      intf_list = config_get('interface', '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
+      Vni.feature_vni_enable unless Vni.feature_vni_enabled
+      @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)
+      Vni.feature_vni_enable unless Vni.feature_vni_enabled
+      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
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    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'))
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_shutdown
+      config_get_default('interface_service_vni', 'shutdown')
+    end
+  end  # Class
+end    # Module