cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/radius_server_group.rb

@@ -0,0 +1,117 @@
+# Radius Server Group provider class
+
+# Jonathan Tripathy et al., 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 'node_util'
+require 'ipaddr'
+
+module Cisco
+  # RadiusServerGroup - node utility class for
+  # Raidus Server configuration management
+  class RadiusServerGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      unless name.is_a?(String)
+        fail ArgumentError, 'Invalid value (Name is not a String)'
+      end
+
+      @name = name
+
+      create if instantiate
+    end
+
+    def self.radius_server_groups
+      hash = {}
+      group_list = config_get('radius_server_group', 'group')
+      return hash if group_list.nil?
+
+      group_list.each do |id|
+        hash[id] = RadiusServerGroup.new(id, false)
+      end
+
+      hash
+    end
+
+    def create
+      config_set('radius_server_group',
+                 'group',
+                 state: '',
+                 name:  @name)
+    end
+
+    def destroy
+      config_set('radius_server_group',
+                 'group',
+                 state: 'no',
+                 name:  @name)
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def default_servers
+      config_get_default('radius_server_group', 'servers')
+    end
+
+    def servers
+      val = config_get('radius_server_group', 'servers', @name)
+      val = default_servers if val.nil?
+      val
+    end
+
+    def servers=(val)
+      fail ArgumentError, 'Servers must be an array of valid IP addresses' \
+        unless val.is_a?(Array)
+
+      current = servers
+
+      # Remove IPs that are no longer required
+      current.each do |old_ip|
+        next if val.include?(old_ip)
+        config_set('radius_server_group',
+                   'servers',
+                   group: @name,
+                   state: 'no',
+                   ip:    old_ip)
+      end
+
+      # Add new IPs that aren't already on the device
+      val.each do |new_ip|
+        unless new_ip =~ /^[a-zA-Z0-9\.\:]*$/
+          fail ArgumentError,
+               'Servers must be an array of valid IPv4/IPv6 addresses'
+        end
+
+        begin
+          IPAddr.new(new_ip)
+        rescue
+          raise ArgumentError,
+                'Servers must be an array of valid IPv4/IPv6 addresses'
+        end
+
+        next unless current.nil? || !current.include?(new_ip)
+        config_set('radius_server_group',
+                   'servers',
+                   group: @name,
+                   state: '',
+                   ip:    new_ip)
+      end
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/router_ospf.rb

@@ -1,6 +1,6 @@
 # November 2014, Chris Van Heuveln
 #
-# Copyright (c) 2014-2015 Cisco and/or its affiliates.
+# 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.

data/lib/cisco_node_utils/router_ospf_vrf.rb

@@ -1,6 +1,6 @@
 # Mike Wiebe, March 2015
 #
-# 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.
@@ -56,8 +56,9 @@ module Cisco
       RouterOspf.routers.each do |instance|
         name = instance[0]
         vrf_ids = config_get('ospf', 'vrf', name: name)
-        hash_tmp = { name =>
-          { 'default' => RouterOspfVrf.new(name, 'default', false) } }
+        hash_tmp = {
+          name => { 'default' => RouterOspfVrf.new(name, 'default', false) }
+        }
         unless vrf_ids.nil?
           vrf_ids.each do |vrf|
             hash_tmp[name][vrf] = RouterOspfVrf.new(name, vrf, false)
@@ -89,12 +90,10 @@ module Cisco
     def auto_cost
       match = config_get('ospf', 'auto_cost', @get_args)
       return default_auto_cost if match.nil?
-      # Multiple matches are possible but the first match is used.
-      # This can be removed when rally defect DE3614 is resolved.
-      if match[0].last.nil?
-        [match[0].first.to_i, OSPF_AUTO_COST[:mbps]]
+      if match.last.nil?
+        [match.first.to_i, OSPF_AUTO_COST[:mbps]]
       else
-        [match[0].first.to_i, match[0].last]
+        [match.first.to_i, match.last]
       end
     end
 
@@ -110,8 +109,7 @@ module Cisco
     end
 
     def default_metric
-      match = config_get('ospf', 'default_metric', @get_args)
-      match.nil? ? default_default_metric : match.first.to_i
+      config_get('ospf', 'default_metric', @get_args)
     end
 
     def default_metric=(metric)
@@ -133,9 +131,7 @@ module Cisco
     def log_adjacency
       match = config_get('ospf', 'log_adjacency', @get_args)
       return default_log_adjacency if match.nil?
-      # Multiple matches are possible but the first match is used.
-      # This can be removed when rally defect DE3614 is resolved.
-      match[0].flatten.last.nil? ? :log : :detail
+      match.flatten.last.nil? ? :log : :detail
     end
 
     def log_adjacency=(type)
@@ -156,8 +152,7 @@ module Cisco
     end
 
     def router_id
-      match = config_get('ospf', 'router_id', @get_args)
-      match.nil? ? default_router_id : match.first
+      config_get('ospf', 'router_id', @get_args)
     end
 
     def router_id=(router_id)
@@ -179,10 +174,10 @@ module Cisco
 
     def timer_throttle_lsa
       match = config_get('ospf', 'timer_throttle_lsa', @get_args)
-      if match.nil? || match.first.nil?
+      if match.nil?
         default_timer_throttle_lsa
       else
-        match.first.collect(&:to_i)
+        match.collect(&:to_i)
       end
     end
 
@@ -232,10 +227,10 @@ module Cisco
 
     def timer_throttle_spf
       match = config_get('ospf', 'timer_throttle_spf', @get_args)
-      if match.nil? || match.first.nil?
+      if match.nil?
         default_timer_throttle_spf
       else
-        match.first.collect(&:to_i)
+        match.collect(&:to_i)
       end
     end
 

data/lib/cisco_node_utils/snmp_notification_receiver.rb

@@ -0,0 +1,158 @@
+# November 2015, Jonathan Tripathy
+#
+# 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
+  # SnmpNotificationReceiver - node utility class for SNMP server management
+  class SnmpNotificationReceiver < NodeUtil
+    attr_reader :name
+
+    def initialize(name,
+                   instantiate:      true,
+                   type:             '',
+                   version:          '',
+                   security:         '',
+                   username:         '',
+                   port:             '',
+                   vrf:              '',
+                   source_interface: '')
+
+      fail TypeError unless name.is_a?(String)
+      @name = name
+
+      fail TypeError unless type.is_a?(String)
+
+      fail TypeError unless version.is_a?(String) || version.is_a?(Integer)
+
+      fail TypeError unless security.is_a?(String)
+
+      fail TypeError unless username.is_a?(String)
+
+      fail TypeError unless port.is_a?(String) || port.is_a?(Integer)
+
+      fail TypeError unless vrf.is_a?(String)
+
+      fail TypeError unless source_interface.is_a?(String)
+
+      return unless instantiate
+
+      # Mandatory Properties
+      fail TypeError unless name.length > 0
+      fail TypeError unless type.length > 0
+
+      if version.is_a?(Integer)
+        fail TypeError if version <= 0
+      else
+        fail TypeError if version.length <= 0
+      end
+
+      fail TypeError unless username.length > 0
+
+      config_set('snmp_notification_receiver',
+                 'receivers',
+                 state:    '',
+                 ip:       name,
+                 type:     type,
+                 version:  version,
+                 security: security,
+                 username: username,
+                 udp_port: port.empty? ? '' : "udp-port #{port}")
+
+      unless source_interface.empty?
+        config_set('snmp_notification_receiver',
+                   'source_interface',
+                   ip:               name,
+                   source_interface: source_interface,
+                   port:             port.empty? ? '' : "udp-port #{port}")
+      end
+
+      return if vrf.empty?
+      config_set('snmp_notification_receiver',
+                 'vrf',
+                 ip:   name,
+                 vrf:  vrf,
+                 port: port.empty? ? '' : "udp-port #{port}")
+    end
+
+    def self.receivers
+      hash = {}
+
+      receivers_list = config_get('snmp_notification_receiver', 'receivers')
+      return hash if receivers_list.nil?
+
+      receivers_list.each do |arr|
+        next if !arr.is_a?(Array) || arr.empty?
+        id = arr[0]
+        hash[id] = SnmpNotificationReceiver.new(id, instantiate: false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def destroy
+      config_set('snmp_notification_receiver',
+                 'receivers',
+                 state:    'no',
+                 ip:       name,
+                 type:     type,
+                 version:  version,
+                 security: security.nil? ? '' : "#{security}",
+                 username: username,
+                 udp_port: port.nil? ? '' : "udp-port #{port}")
+    end
+
+    def port
+      config_get('snmp_notification_receiver', 'port', @name)
+    end
+
+    def username
+      if !port.nil?
+        endpoint = 'username_with_port'
+      else
+        endpoint = 'username'
+      end
+
+      config_get('snmp_notification_receiver', endpoint, @name)
+    end
+
+    def version
+      config_get('snmp_notification_receiver', 'version', @name)
+    end
+
+    def type
+      config_get('snmp_notification_receiver', 'type', @name)
+    end
+
+    def security
+      config_get('snmp_notification_receiver', 'security', @name)
+    end
+
+    def vrf
+      config_get('snmp_notification_receiver', 'vrf', @name)
+    end
+
+    def source_interface
+      val = config_get('snmp_notification_receiver', 'source_interface', @name)
+      val = val.downcase unless val.nil?
+      val
+    end
+  end
+end

data/lib/cisco_node_utils/snmpcommunity.rb

@@ -1,6 +1,6 @@
 # December 2014, Alex Hunsberger
 #
-# Copyright (c) 2014-2015 Cisco and/or its affiliates.
+# 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.
@@ -50,8 +50,7 @@ module Cisco
     #  end
 
     def group
-      result = config_get('snmp_community', 'group', @name)
-      result.nil? ? SnmpCommunity.default_group : result.first
+      config_get('snmp_community', 'group', @name)
     end
 
     def group=(group)
@@ -64,8 +63,7 @@ module Cisco
     end
 
     def acl
-      result = config_get('snmp_community', 'acl', @name)
-      result.nil? ? SnmpCommunity.default_acl : result.first
+      config_get('snmp_community', 'acl', @name)
     end
 
     def acl=(acl)

data/lib/cisco_node_utils/snmpgroup.rb

@@ -3,7 +3,7 @@
 #
 # February 2015, Chris Van Heuveln
 #
-# 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.

data/lib/cisco_node_utils/snmpnotification.rb

@@ -0,0 +1,57 @@
+# December 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'
+
+module Cisco
+  # SnmpNotification - node utility class for SNMP notification management
+  class SnmpNotification < NodeUtil
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      @name = name
+    end
+
+    def self.notifications
+      @notifications = {}
+      notifs = config_get('snmpnotification', 'notifications')
+      unless notifs.nil?
+        notifs.each do |notif|
+          @notifications[notif] = SnmpNotification.new(notif)
+        end
+      end
+      @notifications
+    end
+
+    def destroy
+      # not needed
+    end
+
+    # Set enable
+    def enable=(enable)
+      config_set('snmpnotification',
+                 'enable',
+                 state:     enable ? '' : 'no',
+                 trap_name: @name)
+    end
+
+    # Get enable
+    def enable
+      value = config_get('snmpnotification', 'enable', trap_name: @name)
+      enabled = value.nil? ? false : true
+      enabled
+    end
+  end
+end