cisco_node_utils 1.0.1 → 1.1.0

data/lib/cisco_node_utils/syslog_server.rb

@@ -0,0 +1,92 @@
+# Syslog Server provider class
+#
+# Jonathan Tripathy et al., September 2015
+#
+# Copyright (c) 2014-2015 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
+  # NtpServer - node utility class for NTP Server configuration management
+  class SyslogServer < NodeUtil
+    attr_reader :name, :level, :vrf
+
+    def initialize(name,
+                   level=nil,
+                   vrf=nil,
+                   instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail TypeError unless name.length > 0
+      @name = name
+
+      fail TypeError unless level.is_a?(Integer) unless level.nil?
+      @level = level
+
+      fail TypeError unless vrf.is_a?(String) unless vrf.nil?
+      @vrf = vrf
+
+      create if instantiate
+    end
+
+    def self.syslogservers
+      hash = {}
+
+      syslogservers_list = config_get('syslog_server', 'server')
+      return hash if syslogservers_list.nil?
+
+      syslogservers_list.each do |id|
+        level = config_get('syslog_server', 'level', id)
+        level = level[0].to_i unless level.nil?
+
+        vrf = config_get('syslog_server', 'vrf', id)
+        if vrf.nil?
+          vrf = 'default'
+        else
+          vrf = vrf[0]
+        end
+
+        hash[id] = SyslogServer.new(id, level, vrf, false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      (name == other.name) && (vrf == other.vrf)
+    end
+
+    def create
+      # Set timestamp units
+      config_set('syslog_server',
+                 'server',
+                 state: '',
+                 ip:    "#{name}",
+                 level: level.nil? ? '' : "#{level}",
+                 vrf:   vrf.nil? ? '' : "use-vrf #{vrf}",
+                )
+    end
+
+    def destroy
+      # Set timestamp units
+      config_set('syslog_server',
+                 'server',
+                 state: 'no',
+                 ip:    "#{name}",
+                 level: '',
+                 vrf:   '',
+                )
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/syslog_settings.rb

@@ -0,0 +1,69 @@
+# Syslog Settings provider class
+#
+# Jonathan Tripathy et al., September 2015
+#
+# Copyright (c) 2014-2015 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 timestamp
+      timestamp = config_get('syslog_settings', 'timestamp')
+      if timestamp.nil?
+        # NXOS doesn't show if timestamp units is set to seconds, so we assume
+        # that no config displayed means that the parameter is set to seconds.
+        timestamp = config_get_default('syslog_settings', 'timestamp')
+      else
+        timestamp = config_get('syslog_settings', 'timestamp')[0]
+      end
+      timestamp
+    end
+
+    def timestamp=(val)
+      fail TypeError unless val.is_a?(String)
+      fail TypeError \
+        unless %w(seconds milliseconds).include?(timestamp)
+
+      # There is no unset version as timestamp has a default value
+      config_set('syslog_settings',
+                 'timestamp',
+                 state: '',
+                 units: val)
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/tacacs_server.rb

@@ -1,5 +1,3 @@
-# TacacsServer provider class
-#
 # Mike Wiebe, January 2015
 #
 # Copyright (c) 2015 Cisco and/or its affiliates.
@@ -16,160 +14,166 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.join(File.dirname(__FILE__), 'node')
+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
-
-class TacacsServer
-  @@node = Cisco::Node.instance
-
-  def initialize(instantiate=true)
-    enable if instantiate and not TacacsServer.enabled
-  end
+  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 TacacsServer.enabled
-    feat = @@node.config_get("tacacs_server", "feature")
-    return (!feat.nil? and !feat.empty?)
-  rescue Cisco::CliError => e
-    # cmd will syntax reject when feature is not enabled
-    raise unless e.clierror =~ /Syntax error/
-    return false
-  end
+    # Check feature enablement
+    def self.enabled
+      feat = config_get('tacacs_server', 'feature')
+      return !(feat.nil? || feat.empty?)
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
 
-  # Enable tacacs_server feature
-  def enable
-    @@node.config_set("tacacs_server", "feature", "")
-  end
+    # Enable tacacs_server feature
+    def enable
+      config_set('tacacs_server', 'feature', '')
+    end
 
-  # Disable tacacs_server feature
-  def destroy
-    @@node.config_set("tacacs_server", "feature", "no")
-  end
+    # Disable tacacs_server feature
+    def destroy
+      config_set('tacacs_server', 'feature', 'no')
+    end
 
-  # --------------------
-  # Getters and Setters
-  # --------------------
+    # --------------------
+    # Getters and Setters
+    # --------------------
 
-  # Set timeout
-  def timeout=(timeout)
-    # 'no tacacs timeout' will fail, just set it to the requested timeout value.
-    @@node.config_set("tacacs_server", "timeout", "", timeout)
-  end
+    # Set timeout
+    def timeout=(timeout)
+      # 'no tacacs timeout' will fail.
+      # Just set it to the requested timeout value.
+      config_set('tacacs_server', 'timeout', '', timeout)
+    end
 
-  # Get timeout
-  def timeout
-    match = @@node.config_get("tacacs_server", "timeout")
-    match.nil? ? TacacsServer.default_timeout : match.first.to_i
-  end
+    # Get timeout
+    def timeout
+      match = config_get('tacacs_server', 'timeout')
+      match.nil? ? TacacsServer.default_timeout : match.first.to_i
+    end
 
-  # Get default timeout
-  def TacacsServer.default_timeout
-    @@node.config_get_default("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.
-    @@node.config_set("tacacs_server", "deadtime", "", deadtime)
-  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
-    match = @@node.config_get("tacacs_server", "deadtime")
-    match.nil? ? TacacsServer.default_deadtime : match.first.to_i
-  end
+    # Get deadtime
+    def deadtime
+      match = config_get('tacacs_server', 'deadtime')
+      match.nil? ? TacacsServer.default_deadtime : match.first.to_i
+    end
 
-  # Get default deadtime
-  def TacacsServer.default_deadtime
-    @@node.config_get_default("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)
-    raise TypeError unless state == true || state == false
-    state == TacacsServer.default_directed_request ?
-      @@node.config_set("tacacs_server", "directed_request", "no") :
-      @@node.config_set("tacacs_server", "directed_request", "")
-  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?
-    match = @@node.config_get("tacacs_server", "directed_request")
-    return TacacsServer.default_directed_request if match.nil?
-    match.first[/^no/] ? false : true
-  end
+    # Check if directed request is enabled
+    def directed_request?
+      match = config_get('tacacs_server', 'directed_request')
+      return TacacsServer.default_directed_request if match.nil?
+      match.first[/^no/] ? false : true
+    end
 
-  # Get default directed_request
-  def TacacsServer.default_directed_request
-    @@node.config_get_default("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)
-    raise TypeError unless name.is_a? String
-    name.empty? ?
-      @@node.config_set("tacacs_server", "source_interface", "no", "") :
-      @@node.config_set("tacacs_server", "source_interface", "", name)
-  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 = @@node.config_get("tacacs_server", "source_interface")
-    return TacacsServer.default_source_interface if match.nil?
-    # match_data will contain one of the following
-    # [nil, " Ethernet1/1"] or ["no", nil]
-    match[0][0] == "no" ? TacacsServer.default_source_interface : match[0][1]
-  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.nil?
+      # match_data will contain one of the following
+      # [nil, " Ethernet1/1"] or ["no", nil]
+      match[0][0] == 'no' ? TacacsServer.default_source_interface : match[0][1]
+    end
 
-  # Get default source interface
-  def TacacsServer.default_source_interface
-    @@node.config_get_default("tacacs_server", "source_interface")
-  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 = @@node.config_get("tacacs_server", "encryption_type")
-    match.nil? ? TACACS_SERVER_ENC_UNKNOWN : match[0][0].to_i
-  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][0].to_i
+    end
 
-  # Get default encryption type
-  def TacacsServer.default_encryption_type
-    @@node.config_get_default("tacacs_server", "encryption_type")
-  end
+    # Get default encryption type
+    def self.default_encryption_type
+      config_get_default('tacacs_server', 'encryption_type')
+    end
 
-  # Get encryption password
-  def encryption_password
-    match = @@node.config_get("tacacs_server", "encryption_password")
-    match.nil? ? TacacsServer.default_encryption_password : match[0][1]
-  end
+    # Get encryption password
+    def encryption_password
+      match = config_get('tacacs_server', 'encryption_password')
+      match.nil? ? TacacsServer.default_encryption_password : match[0][1]
+    end
 
-  # Get default encryption password
-  def TacacsServer.default_encryption_password
-    @@node.config_get_default("tacacs_server", "encryption_password")
-  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)
-    # 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
-          @@node.config_set("tacacs_server", "encryption", "no",
-                      encryption_type,
-                      encryption_password)
-       end
-    else
-       @@node.config_set("tacacs_server", "encryption", "", enctype, password)
+    # Set encryption type and password
+    def encryption_key_set(enctype, 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', 'no',
+                     encryption_type,
+                     encryption_password)
+        end
+      else
+        config_set('tacacs_server', 'encryption', '', enctype, password)
+      end
     end
   end
 end
-end