cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/snmp_notification_receiver.rb

@@ -0,0 +1,176 @@
+# 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, # rubocop:disable CyclomaticComplexity, MethodLength, PerceivedComplexity, LineLength, AbcSize
+                   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.empty? ? '' : "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?
+      if platform == :nexus
+        config_set('snmp_notification_receiver',
+                   'vrf',
+                   ip:   name,
+                   vrf:  vrf,
+                   port: port.empty? ? '' : "udp-port #{port}")
+      else
+        config_set('snmp_notification_receiver',
+                   'vrf',
+                   vrf:      vrf,
+                   ip:       name,
+                   username: username)
+      end
+    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.nil? ? '' : "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
+      if platform == :nexus
+        config_get('snmp_notification_receiver', 'vrf', @name)
+      else
+        # get all vrf
+        all_vrf = config_get('snmp_notification_receiver', 'vrf_all')
+        all_vrf.each do |vrf|
+          vrf_list = config_get('snmp_notification_receiver', 'vrf_values', vrf: vrf) # rubocop:disable Metrics/LineLength
+          # if vrf contains @name return vrf
+          return vrf if vrf_list.include?(@name)
+        end
+      end
+    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

@@ -0,0 +1,109 @@
+# December 2014, Alex Hunsberger
+#
+# 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
+  # SnmpCommunity - node utility class for SNMP community config management
+  class SnmpCommunity < NodeUtil
+    @communities = nil
+
+    def initialize(name, group, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail TypeError unless group.is_a?(String)
+      @name = name
+      return unless instantiate
+      if platform == :nexus
+        config_set('snmp_community', 'community',
+                   state: '',
+                   name:  @name,
+                   group: group)
+      else
+        config_set('snmp_community', 'community',
+                   state: '',
+                   name:  @name)
+        # create the mapping for group
+        config_set('snmp_community', 'group_simple', state: '', group: group)
+        config_set('snmp_community', 'group_community_mapping', name: @name, group: group) # rubocop:disable Metrics/LineLength
+      end
+    end
+
+    def self.communities
+      @communities = {}
+      comms = config_get('snmp_community', 'all_communities')
+      unless comms.nil?
+        comms.each do |comm|
+          @communities[comm] = SnmpCommunity.new(comm, '', false)
+        end
+      end
+      @communities
+    end
+
+    def destroy
+      # CLI requires specifying a group even for "no" commands
+      config_set('snmp_community', 'community',
+                 state: 'no',
+                 name:  @name,
+                 group: 'null')
+    end
+
+    # name is read only
+    #  def name
+    #    @name
+    #  end
+
+    def group
+      if platform == :nexus
+        config_get('snmp_community', 'group', name: @name)
+      else
+        config_get('snmp_community', 'group_community_mapping', name: @name)
+      end
+    end
+
+    def group=(group)
+      fail TypeError unless group.is_a?(String)
+      if platform == :nexus
+        config_set('snmp_community', 'group', name: @name, group: group)
+      else
+        # create the mapping
+        config_set('snmp_community', 'group_simple', group: group)
+        config_set('snmp_community', 'group_community_mapping', name: @name, group: group) # rubocop:disable Metrics/LineLength
+      end
+    end
+
+    def self.default_group
+      config_get_default('snmp_community', 'group')
+    end
+
+    def acl
+      config_get('snmp_community', 'acl', name: @name)
+    end
+
+    def acl=(acl)
+      fail TypeError unless acl.is_a?(String)
+      if acl.empty?
+        acl = self.acl
+        config_set('snmp_community', 'acl', state: 'no', name: @name, acl: acl) unless acl.empty? # rubocop:disable Metrics/LineLength
+      else
+        config_set('snmp_community', 'acl', state: '', name: @name, acl: acl)
+      end
+    end
+
+    def self.default_acl
+      config_get_default('snmp_community', 'acl')
+    end
+  end
+end

data/lib/cisco_node_utils/snmpgroup.rb

@@ -0,0 +1,54 @@
+#
+# NXAPI implementation of SnmpGroup class
+#
+# February 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.
+#
+# "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
+  # SnmpGroup - node utility class for SNMP group configuration management
+  class SnmpGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      @name = name
+    end
+
+    def self.groups
+      group_ids = config_get('snmp_group', 'group')
+      return {} if group_ids.nil?
+
+      hash = {}
+      group_ids.each do |name|
+        hash[name] = SnmpGroup.new(name)
+      end
+      hash
+    end
+
+    def self.exists?(group)
+      fail ArgumentError if group.empty?
+      fail TypeError unless group.is_a? String
+      groups = config_get('snmp_group', 'group')
+      (!groups.nil? && groups.include?(group))
+    end
+  end
+end

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

data/lib/cisco_node_utils/snmpserver.rb

@@ -0,0 +1,132 @@
+# November 2014, Alex Hunsberger
+#
+# 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
+  # SnmpServer - node utility class for SNMP server management
+  class SnmpServer < NodeUtil
+    def aaa_user_cache_timeout
+      config_get('snmp_server', 'aaa_user_cache_timeout')
+    end
+
+    def aaa_user_cache_timeout=(timeout)
+      config_set('snmp_server', 'aaa_user_cache_timeout', '', timeout)
+    end
+
+    def default_aaa_user_cache_timeout
+      config_get_default('snmp_server', 'aaa_user_cache_timeout')
+    end
+
+    def location
+      match = config_get('snmp_server', 'location')
+      match.nil? ? default_location : match
+    end
+
+    def location=(location)
+      fail TypeError unless location.is_a?(String)
+      if location.empty?
+        config_set('snmp_server', 'location', state: 'no', location: '')
+      else
+        config_set('snmp_server', 'location', state: '', location: location)
+      end
+    end
+
+    def default_location
+      config_get_default('snmp_server', 'location')
+    end
+
+    def contact
+      match = config_get('snmp_server', 'contact')
+      match.nil? ? default_contact : match
+    end
+
+    def contact=(contact)
+      fail TypeError unless contact.is_a?(String)
+      if contact.empty?
+        config_set('snmp_server', 'contact', state: 'no', contact: '')
+      else
+        config_set('snmp_server', 'contact', state: '', contact: contact)
+      end
+    end
+
+    def default_contact
+      config_get_default('snmp_server', 'contact')
+    end
+
+    def packet_size
+      config_get('snmp_server', 'packet_size')
+    end
+
+    def packet_size=(size)
+      if size == 0
+        ps = packet_size
+        config_set('snmp_server', 'packet_size', 'no', ps) unless ps == 0
+      else
+        config_set('snmp_server', 'packet_size', '', size)
+      end
+    end
+
+    def default_packet_size
+      config_get_default('snmp_server', 'packet_size')
+    end
+
+    def global_enforce_priv?
+      config_get('snmp_server', 'global_enforce_priv')
+    end
+
+    def global_enforce_priv=(enforce)
+      if enforce
+        config_set('snmp_server', 'global_enforce_priv', '')
+      else
+        config_set('snmp_server', 'global_enforce_priv', 'no')
+      end
+    end
+
+    def default_global_enforce_priv
+      config_get_default('snmp_server', 'global_enforce_priv')
+    end
+
+    def protocol?
+      config_get('snmp_server', 'protocol')
+    end
+
+    def protocol=(enable)
+      no_cmd = (enable ? '' : 'no')
+      config_set('snmp_server', 'protocol', no_cmd)
+    end
+
+    def default_protocol
+      config_get_default('snmp_server', 'protocol')
+    end
+
+    def tcp_session_auth?
+      config_get('snmp_server', 'tcp_session_auth')
+    end
+
+    def tcp_session_auth=(enable)
+      if enable
+        config_set('snmp_server', 'tcp_session_auth', '', 'auth')
+      else
+        config_set('snmp_server', 'tcp_session_auth', 'no', '')
+      end
+    end
+
+    def default_tcp_session_auth
+      config_get_default('snmp_server', 'tcp_session_auth')
+    end
+  end
+end