cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/syslog_facility.rb

@@ -0,0 +1,64 @@
+# Syslog facility provider class
+#
+# Rick Sherman et al., August 2018
+#
+# Copyright (c) 2014-2018 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
+  # SyslogFacility - node utility class for Syslog facility severity management
+  class SyslogFacility < NodeUtil
+    attr_reader :facility, :level
+
+    def initialize(opts, instantiate=true)
+      @facility = opts['facility']
+      @level = opts['level']
+
+      create if instantiate
+    end
+
+    def self.facilities
+      keys = %w(facility level)
+      hash = {}
+      facility_key_list = config_get('syslog_facility', 'facility')
+      return hash if facility_key_list.nil?
+
+      facility_key_list.each do |id|
+        hash[id[0]] = SyslogFacility.new(Hash[keys.zip(id)], false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      facility == other.facility && level == other.level
+    end
+
+    def create
+      config_set('syslog_facility', 'facility', state: '', facility: @facility,
+                  level: @level)
+    end
+
+    def destroy
+      config_set('syslog_facility', 'facility', state: 'no',
+                  facility: @facility, level: @level)
+    end
+
+    def level
+      @level.to_i
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/syslog_server.rb

@@ -0,0 +1,146 @@
+# Syslog Server provider class
+#
+# June 2018
+# Jonathan Tripathy et al., September 2015
+#
+# Copyright (c) 2014-2018 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 'resolv'
+
+module Cisco
+  # SyslogServer - node utility class for syslog server configuration management
+  class SyslogServer < NodeUtil
+    attr_reader :name, :level, :port, :vrf, :severity_level, :facility
+
+    LEVEL_TO_NUM = { 'emergencies'   => 0,
+                     'alerts'        => 1,
+                     'critical'      => 2,
+                     'error'         => 3,
+                     'warning'       => 4,
+                     'notifications' => 5,
+                     'info'          => 6,
+                     'debugging'     => 7 }.freeze
+    NUM_TO_LEVEL = LEVEL_TO_NUM.invert.freeze
+
+    def initialize(opts, instantiate=true)
+      @name = opts['name']
+      @level = opts['level'] || opts['severity_level']
+      @port = opts['port']
+      @vrf = opts['vrf']
+      @severity_level = opts['severity_level'] || opts['level']
+      @facility = opts['facility']
+
+      hostname_regex = /^(?=.{1,255}$)[0-9A-Za-z]
+      (?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?
+      (?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$/x
+
+      unless @name =~ Resolv::AddressRegex ||
+             @name =~ hostname_regex
+        fail ArgumentError,
+             "Invalid value '#{@name}' \
+        (Must be valid IPv4/IPv6 address or hostname)"
+      end
+
+      create if instantiate
+    end
+
+    def self.syslogservers
+      keys = %w(name level port vrf facility severity_level)
+      hash = {}
+      syslogservers_list = config_get('syslog_server', 'server')
+      return hash if syslogservers_list.nil?
+
+      syslogservers_list.each do |id|
+        value_hash = Hash[keys.zip(id)]
+        value_hash['severity_level'] = value_hash['level']
+        value_hash['vrf'] = 'default' if value_hash['vrf'].nil?
+        value_hash['facility'] = 'local7' if value_hash['facility'].nil?
+        hash[id[0]] = SyslogServer.new(value_hash, false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      (name == other.name) && (vrf == other.vrf)
+    end
+
+    def create
+      if platform == :ios_xr
+
+        # This provider only support a 1-1 mapping between host and VRF.
+        # Thus, we must remove the other entries on different VRFs.
+        all_vrfs = config_get('syslog_server', 'vrf', name)
+        destroy(all_vrfs) if all_vrfs.is_a?(Array) && all_vrfs.count > 1
+
+        config_set('syslog_server',
+                   'server',
+                   state: '',
+                   ip:    @name,
+                   level: @level ? "severity #{NUM_TO_LEVEL[@level]}" : '',
+                   vrf:   @vrf ? "vrf #{@vrf}" : '',
+                  )
+      else
+        config_set('syslog_server',
+                   'server',
+                   state:    '',
+                   ip:       @name,
+                   level:    @level ? "#{@level}" : '',
+                   port:     @port ? "port #{@port}" : '',
+                   vrf:      @vrf ? "use-vrf #{@vrf}" : '',
+                   facility: @facility ? "facility #{@facility}" : '',
+                  )
+      end
+    end
+
+    def destroy(duplicate_vrfs=[])
+      if platform == :ios_xr
+        if duplicate_vrfs.empty?
+          config_set('syslog_server',
+                     'server',
+                     state: 'no',
+                     ip:    @name,
+                     level: '',
+                     vrf:   @vrf ? "vrf #{@vrf}" : '',
+                    )
+        else
+          warn("#{name} is configured multiple times on the device" \
+            ' (possibly in different VRFs). This is unsupported by this' \
+            ' API and the duplicate entries are being deleted.')
+          duplicate_vrfs.each do |dup|
+            config_set('syslog_server',
+                       'server',
+                       state: 'no',
+                       ip:    @name,
+                       level: '',
+                       vrf:   "vrf #{dup}",
+                      )
+          end
+        end
+      else
+        config_set('syslog_server',
+                   'server',
+                   state:    'no',
+                   ip:       @name,
+                   level:    '',
+                   port:     '',
+                   vrf:      '',
+                   facility: '',
+                  )
+      end
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/syslog_settings.rb

@@ -0,0 +1,174 @@
+# Syslog Settings provider class
+#
+# August 2018
+# Jonathan Tripathy et al., September 2015
+#
+# Copyright (c) 2014-2018 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
+  # SyslogSettings - node utility class for
+  # Syslog Settings configuration management
+  class SyslogSettings < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError,
+           "This provider only accepts an id of 'default'" \
+           unless name.eql?('default')
+      @name = name
+    end
+
+    def self.syslogsettings
+      hash = {}
+      hash['default'] = SyslogSettings.new('default')
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def default_console
+      config_get_default('syslog_settings', 'console')
+    end
+
+    def console
+      console = config_get('syslog_settings', 'console')
+      if console.is_a?(Array)
+        console = console[0] == 'no' ? 'unset' : console[1]
+      end
+      console
+    end
+
+    def console=(severity)
+      if severity
+        config_set(
+          'syslog_settings', 'console',
+          state: '', severity: severity)
+      else
+        config_set(
+          'syslog_settings', 'console',
+          state: 'no', severity: '')
+      end
+    end
+
+    def default_monitor
+      config_get_default('syslog_settings', 'monitor')
+    end
+
+    def monitor
+      monitor = config_get('syslog_settings', 'monitor')
+      if monitor.is_a?(Array)
+        monitor = monitor[0] == 'no' ? 'unset' : monitor[1]
+      end
+      monitor
+    end
+
+    def monitor=(severity)
+      if severity
+        config_set(
+          'syslog_settings', 'monitor',
+          state: '', severity: severity)
+      else
+        config_set(
+          'syslog_settings', 'monitor',
+          state: 'no', severity: '')
+      end
+    end
+
+    def default_source_interface
+      config_get_default('syslog_settings', 'source_interface')
+    end
+
+    def source_interface
+      i = config_get('syslog_settings', 'source_interface')
+      i.nil? ? default_source_interface : i.downcase
+    end
+
+    def source_interface=(name)
+      if name
+        config_set(
+          'syslog_settings', 'source_interface',
+          state: '', source_interface: name)
+      else
+        config_set(
+          'syslog_settings', 'source_interface',
+          state: 'no', source_interface: '')
+      end
+    end
+
+    def timestamp
+      config_get('syslog_settings', 'timestamp')
+    end
+
+    def timestamp=(val)
+      fail TypeError \
+        unless %w(seconds milliseconds).include?(val.to_s)
+
+      # There is no unset version as timestamp has a default value
+      config_set('syslog_settings',
+                 'timestamp',
+                 state: '',
+                 units: val)
+    end
+
+    def logfile_severity_level
+      logfile_severity_level =
+          config_get('syslog_settings', 'logfile_severity_level')
+      if logfile_severity_level.is_a?(Array)
+        if logfile_severity_level[0] == 'no'
+          logfile_severity_level = nil
+        else
+          logfile_severity_level = logfile_severity_level[1]
+        end
+      end
+      logfile_severity_level
+    end
+
+    def logfile_name=(logname, severity, size)
+      if logname
+        config_set(
+          'syslog_settings', 'logfile_name',
+          state: '', logname: logname, severity: severity, size: size)
+      else
+        config_set(
+          'syslog_settings', 'logfile_name',
+          state: 'no', logname: logname, severity: severity, size: size)
+      end
+    end
+
+    def logfile_name
+      logfile_name = config_get('syslog_settings', 'logfile_name')
+      if logfile_name.is_a?(Array)
+        logfile_name = (logfile_name[0] == 'no') ? 'unset' : logfile_name[1]
+      end
+      logfile_name
+    end
+
+    def logfile_size
+      logfile_size = config_get('syslog_settings', 'logfile_size')
+      if logfile_size.is_a?(Array)
+        logfile_size = (logfile_size[0] == 'no') ? nil : logfile_size[1]
+      end
+      logfile_size
+    end
+
+    alias_method :time_stamp_units, :timestamp
+    alias_method :time_stamp_units=, :timestamp=
+  end # class
+end # module

data/lib/cisco_node_utils/tacacs_global.rb

@@ -0,0 +1,137 @@
+# Tacacs Global provider class
+
+# TP HONEY et al., June 2014-2017
+
+# Copyright (c) 2014-2017 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'
+
+# Tacacs Global configuration management
+module Cisco
+  # TacacsGlobal - node utility class for
+  class TacacsGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError,
+           "This provider only accepts an id of 'default'" \
+           unless name.eql?('default')
+      @name = name
+    end
+
+    def self.tacacs_global
+      hash = {}
+      hash['default'] = TacacsGlobal.new('default')
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def timeout
+      return nil unless Feature.tacacs_enabled?
+      config_get('tacacs_global', 'timeout')
+    end
+
+    def default_timeout
+      config_get_default('tacacs_global', 'timeout')
+    end
+
+    def timeout=(val)
+      unless val.nil?
+        fail ArgumentError, 'timeout must be an Integer' \
+          unless val.is_a?(Integer)
+      end
+
+      if val.nil?
+        fail ArgumentError, 'timeout cannot be unset if TACACS enabled - ' \
+        "use default value #{default_timeout}" \
+          if Feature.tacacs_enabled?
+      else
+        Feature.tacacs_enable
+        config_set('tacacs_global',
+                   'timeout',
+                   state:   '',
+                   timeout: val)
+      end
+    end
+
+    def key_format
+      match = config_get('tacacs_global', 'key_format')
+      match.nil? ? TACACS_GLOBAL_ENC_UNKNOWN : match[0].to_i
+    end
+
+    def key
+      return nil unless Feature.tacacs_enabled?
+      str = config_get('tacacs_global', 'key')
+      return TacacsGlobal.default_key if str.empty?
+      str[1].strip.gsub(/\"/, '')
+    end
+
+    # Get default encryption password
+    def self.default_key
+      config_get_default('tacacs_global', 'key')
+    end
+
+    def encryption_key_set(key_format, key)
+      # If we get an empty key - remove default if configured
+      if key.nil? || key.to_s.empty?
+        key = self.key
+        return if key.empty?
+        key_format = self.key_format
+        config_set('tacacs_server', 'encryption', state: 'no',
+                    option: key_format, key: key)
+      else
+        Feature.tacacs_enable
+        key = Utils.add_quotes(key)
+        if key_format.nil? || key_format.to_s.empty?
+          config_set('tacacs_server', 'encryption', state: '', option: '',
+                    key: key)
+        else
+          config_set('tacacs_server', 'encryption', state: '',
+                    option: key_format, key: key)
+        end
+      end
+    end
+
+    # Get default source interface
+    def default_source_interface
+      config_get_default('tacacs_global', 'source_interface')
+    end
+
+    # Set source interface
+    def source_interface=(name)
+      if name
+        Feature.tacacs_enable
+        config_set(
+          'tacacs_global', 'source_interface',
+          state: '', source_interface: name)
+      else
+        config_set(
+          'tacacs_global', 'source_interface',
+          state: 'no', source_interface: '')
+      end
+    end
+
+    # Get source interface
+    def source_interface
+      return nil unless Feature.tacacs_enabled?
+      i = config_get('tacacs_global', 'source_interface')
+      i.nil? ? default_source_interface : i.downcase
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/tacacs_server.rb

@@ -0,0 +1,173 @@
+# Mike Wiebe, January 2015
+#
+# 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 TACACS+ server related constants to the Cisco namespace
+module Cisco
+  TACACS_SERVER_ENC_NONE = 0
+  TACACS_SERVER_ENC_CISCO_TYPE_7 = 7
+  TACACS_SERVER_ENC_UNKNOWN = 8
+
+  # TacacsServer - node utility class for TACACS+ server config management
+  class TacacsServer < NodeUtil
+    def initialize(instantiate=true)
+      enable if instantiate && !TacacsServer.enabled
+    end
+
+    # Check feature enablement
+    def self.enabled
+      Feature.tacacs_enabled?
+    end
+
+    # Enable tacacs_server feature
+    def enable
+      config_set('tacacs_server', 'feature', '') unless platform == :ios_xr
+    end
+
+    # Disable tacacs_server feature
+    def destroy
+      config_set('tacacs_server', 'feature', 'no') unless platform == :ios_xr
+    end
+
+    # --------------------
+    # Getters and Setters
+    # --------------------
+
+    # Set timeout
+    def timeout=(timeout)
+      # 'no tacacs timeout' will fail.
+      # Just set it to the requested timeout value.
+      config_set('tacacs_server', 'timeout', state: '', timeout: timeout)
+    end
+
+    # Get timeout
+    def timeout
+      config_get('tacacs_server', 'timeout')
+    end
+
+    # Get default timeout
+    def self.default_timeout
+      config_get_default('tacacs_server', 'timeout')
+    end
+
+    # Set deadtime
+    def deadtime=(deadtime)
+      # 'no tacacs deadtime' will fail.
+      # Just set it to the requested timeout value.
+      config_set('tacacs_server', 'deadtime', '', deadtime)
+    end
+
+    # Get deadtime
+    def deadtime
+      config_get('tacacs_server', 'deadtime')
+    end
+
+    # Get default deadtime
+    def self.default_deadtime
+      config_get_default('tacacs_server', 'deadtime')
+    end
+
+    # Set directed_request
+    def directed_request=(state)
+      fail TypeError unless state == true || state == false
+      if state == TacacsServer.default_directed_request
+        config_set('tacacs_server', 'directed_request', 'no')
+      else
+        config_set('tacacs_server', 'directed_request', '')
+      end
+    end
+
+    # Check if directed request is enabled
+    def directed_request?
+      config_get('tacacs_server', 'directed_request')
+    end
+
+    # Get default directed_request
+    def self.default_directed_request
+      config_get_default('tacacs_server', 'directed_request')
+    end
+
+    # Set source interface
+    def source_interface=(name)
+      fail TypeError unless name.is_a? String
+      if name.empty?
+        config_set('tacacs_server', 'source_interface', 'no', '')
+      else
+        config_set('tacacs_server', 'source_interface', '', name)
+      end
+    end
+
+    # Get source interface
+    def source_interface
+      # Sample output
+      # ip tacacs source-interface Ethernet1/1
+      # no tacacs source-interface
+      match = config_get('tacacs_server', 'source_interface')
+      return TacacsServer.default_source_interface if match.empty?
+      # match_data will contain one of the following
+      # [nil, " Ethernet1/1"] or ["no", nil]
+      match[0] == 'no' ? TacacsServer.default_source_interface : match[1]
+    end
+
+    # Get default source interface
+    def self.default_source_interface
+      config_get_default('tacacs_server', 'source_interface')
+    end
+
+    # Get encryption type used for the key
+    def encryption_type
+      match = config_get('tacacs_server', 'encryption_type')
+      match.nil? ? TACACS_SERVER_ENC_UNKNOWN : match[0].to_i
+    end
+
+    # Get default encryption type
+    def self.default_encryption_type
+      config_get_default('tacacs_server', 'encryption_type')
+    end
+
+    # Get encryption password
+    def encryption_password
+      str = config_get('tacacs_server', 'encryption_password')
+      return TacacsServer.default_encryption_password if str.empty?
+      str[1].strip
+    end
+
+    # Get default encryption password
+    def self.default_encryption_password
+      config_get_default('tacacs_server', 'encryption_password')
+    end
+
+    # Set encryption type and password
+    def encryption_key_set(enctype, password)
+      password = Utils.add_quotes(password)
+      # if enctype is TACACS_SERVER_ENC_UNKNOWN, we will unset the key
+      if enctype == TACACS_SERVER_ENC_UNKNOWN
+        # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we
+        # need to unset it. Otherwise the box is not configured with key, we
+        # don't need to do anything
+        if encryption_type != TACACS_SERVER_ENC_UNKNOWN
+          config_set('tacacs_server', 'encryption', state:  'no',
+                                                    option: encryption_type,
+                                                    key:    encryption_password)
+        end
+      else
+        config_set('tacacs_server', 'encryption', state: '', option: enctype,
+                    key: password)
+      end
+    end
+  end
+end