cisco_node_utils 1.0.1 → 1.1.0

data/lib/cisco_node_utils/tacacs_server_host.rb

@@ -1,5 +1,3 @@
-# TacacsServerHost class
-#
 # Alex Hunsberger, March 2015
 #
 # Copyright (c) 2015 Cisco and/or its affiliates.
@@ -16,113 +14,112 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.join(File.dirname(__FILE__), 'node')
-require File.join(File.dirname(__FILE__), 'tacacs_server')
+require_relative 'node_util'
+require_relative 'tacacs_server'
 
 module Cisco
-class TacacsServerHost
-  attr_reader :name
-  @@node = Cisco::Node.instance
-  @@hosts = {}
-
-  def initialize(name, create=true)
-    raise TypeError unless name.is_a? String
-    raise ArgumentError if name.empty?
-    @name = name
-
-    if create
-      # feature Tacacs+ must be enabled to create a host
+  # TacacsServerHost - node utility class for TACACS+ server host config
+  class TacacsServerHost < NodeUtil
+    attr_reader :name
+    @hosts = {}
+
+    def initialize(name, create=true)
+      fail TypeError unless name.is_a? String
+      fail ArgumentError if name.empty?
+      @name = name
+      return unless create
+      # 'feature tacacs+' must be enabled to create a host
       TacacsServer.new.enable unless TacacsServer.enabled
-      @@node.config_set("tacacs_server_host", "host", "", name)
+      config_set('tacacs_server_host', 'host', '', name)
     end
-  end
 
-  def TacacsServerHost.hosts
-    @@hosts = {}
+    def self.hosts
+      @hosts = {}
 
-    return @@hosts unless TacacsServer.enabled
+      return @hosts unless TacacsServer.enabled
 
-    hosts = @@node.config_get("tacacs_server_host", "hosts")
-    unless hosts.nil?
-      hosts = [hosts] if hosts.is_a?(Hash)
-      hosts.each { |name|
-        @@hosts[name] = TacacsServerHost.new(name, false) if @@hosts[name].nil?
-      }
+      hosts = config_get('tacacs_server_host', 'hosts')
+      unless hosts.nil?
+        hosts = [hosts] if hosts.is_a?(Hash)
+        hosts.each do |name|
+          @hosts[name] = TacacsServerHost.new(name, false) if @hosts[name].nil?
+        end
+      end
+      @hosts
     end
-    @@hosts
-  end
 
-  def destroy
-    @@node.config_set("tacacs_server_host", "host", "no", @name)
-    @@hosts.delete(@name) unless @@hosts.nil?
-  end
+    def destroy
+      config_set('tacacs_server_host', 'host', 'no', @name)
+    end
 
-  def port
-    p = @@node.config_get("tacacs_server_host", "port", @name)
-    raise "unable to retrieve port information for #{@name}" if p.nil?
-    p.first.to_i
-  end
+    def port
+      p = config_get('tacacs_server_host', 'port', @name)
+      fail "unable to retrieve port information for #{@name}" if p.nil?
+      p.first.to_i
+    end
 
-  def port=(n)
-    @@node.config_set("tacacs_server_host", "port", @name, n.to_i)
-  end
+    def port=(n)
+      config_set('tacacs_server_host', 'port', @name, n.to_i)
+    end
 
-  def TacacsServerHost.default_port
-    @@node.config_get_default("tacacs_server_host", "port")
-  end
+    def self.default_port
+      config_get_default('tacacs_server_host', 'port')
+    end
 
-  def encryption_type
-    type = @@node.config_get("tacacs_server_host", "encryption_type", @name)
-    type.nil? ? TACACS_SERVER_ENC_UNKNOWN : type.first.to_i
-  end
+    def encryption_type
+      type = config_get('tacacs_server_host', 'encryption_type', @name)
+      type.nil? ? TACACS_SERVER_ENC_UNKNOWN : type.first.to_i
+    end
 
-  def TacacsServerHost.default_encryption_type
-    TacacsServer.default_encryption_type
-  end
+    def self.default_encryption_type
+      TacacsServer.default_encryption_type
+    end
 
-  def encryption_password
-    pass = @@node.config_get("tacacs_server_host", "encryption_password", @name)
-    pass.nil? ? TacacsServerHost.default_encryption_password : pass.first
-  end
+    def encryption_password
+      pass = config_get('tacacs_server_host', 'encryption_password', @name)
+      pass.nil? ? TacacsServerHost.default_encryption_password : pass.first
+    end
 
-  def TacacsServerHost.default_encryption_password
-    @@node.config_get_default("tacacs_server_host", "encryption_password")
-  end
+    def self.default_encryption_password
+      config_get_default('tacacs_server_host', 'encryption_password')
+    end
 
-  def encryption_key_set(enctype, password)
-    raise TypeError unless enctype.is_a? Fixnum
-    raise ArgumentError if password and not [TACACS_SERVER_ENC_NONE,
-                                             TACACS_SERVER_ENC_CISCO_TYPE_7,
-                                             TACACS_SERVER_ENC_UNKNOWN].include? enctype
-    # if enctype is TACACS_SERVER_ENC_UNKNOWN, we'll unset the key
-    if enctype == TACACS_SERVER_ENC_UNKNOWN
-      # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we need
-      # to unset the key value. Otherwise, the box is not configured with key,
-      # thus we don't need to do anything
-      if encryption_type != TACACS_SERVER_ENC_UNKNOWN
-         @@node.config_set("tacacs_server_host", "encryption", "no", @name,
-                        encryption_type,
-                        encryption_password)
+    def encryption_key_set(enctype, password)
+      fail TypeError unless enctype.is_a? Fixnum
+      fail ArgumentError if password && ![TACACS_SERVER_ENC_NONE,
+                                          TACACS_SERVER_ENC_CISCO_TYPE_7,
+                                          TACACS_SERVER_ENC_UNKNOWN,
+                                         ].include?(enctype)
+      # if enctype is TACACS_SERVER_ENC_UNKNOWN, we'll unset the key
+      if enctype == TACACS_SERVER_ENC_UNKNOWN
+        # if current encryption type is not TACACS_SERVER_ENC_UNKNOWN, we need
+        # to unset the key value. Otherwise, the box is not configured with key,
+        # thus we don't need to do anything
+        if encryption_type != TACACS_SERVER_ENC_UNKNOWN
+          config_set('tacacs_server_host', 'encryption', 'no', @name,
+                     encryption_type,
+                     encryption_password)
+        end
+      else
+        config_set('tacacs_server_host', 'encryption',
+                   '', @name, enctype, password)
       end
-    else
-      @@node.config_set("tacacs_server_host", "encryption", "", @name, enctype, password)
     end
-  end
 
-  def timeout
-    t = @@node.config_get("tacacs_server_host", "timeout", @name)
-    t.nil? ? TacacsServerHost.default_timeout : t.first.to_i
-  end
+    def timeout
+      t = config_get('tacacs_server_host', 'timeout', @name)
+      t.nil? ? TacacsServerHost.default_timeout : t.first.to_i
+    end
 
-  def timeout=(t)
-    raise TypeError unless t.is_a? Fixnum
-    return if t == timeout
+    def timeout=(t)
+      fail TypeError unless t.is_a? Fixnum
+      return if t == timeout
 
-    @@node.config_set("tacacs_server_host", "timeout", "", @name, t)
-  end
+      config_set('tacacs_server_host', 'timeout', '', @name, t)
+    end
 
-  def TacacsServerHost.default_timeout
-    @@node.config_get_default("tacacs_server_host", "timeout")
+    def self.default_timeout
+      config_get_default('tacacs_server_host', 'timeout')
+    end
   end
 end
-end

data/lib/cisco_node_utils/version.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Container module for version number only.
 module CiscoNodeUtils
-  VERSION = "1.0.1"
+  VERSION = '1.1.0'
 end

data/lib/cisco_node_utils/vlan.rb

@@ -1,5 +1,3 @@
-# VLAN provider class
-#
 # Jie Yang, November 2014
 #
 # Copyright (c) 2014-2015 Cisco and/or its affiliates.
@@ -16,29 +14,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.join(File.dirname(__FILE__), 'node')
-require File.join(File.dirname(__FILE__), 'interface')
+require_relative 'node_util'
+require_relative 'interface'
 
+# Add some Vlan-specific constants to the Cisco namespace
 module Cisco
   VLAN_NAME_SIZE = 33
 
-  class Vlan
+  # Vlan - node utility class for VLAN configuration management
+  class Vlan < NodeUtil
     attr_reader :name, :vlan_id
 
-    @@node = Node.instance
-    raise TypeError if @@node.nil?
-
     def initialize(vlan_id, instantiate=true)
       @vlan_id = vlan_id.to_s
-      raise ArgumentError,
-        "Invalid value(non-numeric Vlan id)" unless @vlan_id[/^\d+$/]
+      fail ArgumentError,
+           'Invalid value(non-numeric Vlan id)' unless @vlan_id[/^\d+$/]
 
       create if instantiate
     end
 
-    def Vlan.vlans
+    def self.vlans
       hash = {}
-      vlan_list = @@node.config_get("vlan", "all_vlans")
+      vlan_list = config_get('vlan', 'all_vlans')
       return hash if vlan_list.nil?
 
       vlan_list.each do |id|
@@ -48,11 +45,11 @@ module Cisco
     end
 
     def create
-      @@node.config_set("vlan", "create", @vlan_id)
+      config_set('vlan', 'create', @vlan_id)
     end
 
     def destroy
-      @@node.config_set("vlan", "destroy", @vlan_id)
+      config_set('vlan', 'destroy', @vlan_id)
     end
 
     def cli_error_check(result)
@@ -60,21 +57,21 @@ module Cisco
       # instead just displays a STDOUT error message; thus NXAPI does not detect
       # the failure and we must catch it by inspecting the "body" hash entry
       # returned by NXAPI. This vlan cli behavior is unlikely to change.
-      raise result[2]["body"] unless result[2]["body"].empty?
+      fail result[2]['body'] unless result[2]['body'].empty?
     end
 
     def vlan_name
-      result = @@node.config_get("vlan", "name", @vlan_id)
+      result = config_get('vlan', 'name', @vlan_id)
       return default_vlan_name if result.nil?
       result.shift
     end
 
     def vlan_name=(str)
-      raise TypeError unless str.is_a?(String)
+      fail TypeError unless str.is_a?(String)
       if str.empty?
-        result = @@node.config_set("vlan", "name", @vlan_id, "no", "")
+        result = config_set('vlan', 'name', @vlan_id, 'no', '')
       else
-        result = @@node.config_set("vlan", "name", @vlan_id, "", str)
+        result = config_set('vlan', 'name', @vlan_id, '', str)
       end
       cli_error_check(result)
     rescue CliError => e
@@ -82,26 +79,26 @@ module Cisco
     end
 
     def default_vlan_name
-      "VLAN%04d" % @vlan_id
+      sprintf('VLAN%04d', @vlan_id)
     end
 
     def state
-      result = @@node.config_get("vlan", "state", @vlan_id)
+      result = config_get('vlan', 'state', @vlan_id)
       return default_state if result.nil?
       case result.first
       when /act/
-        return "active"
+        return 'active'
       when /sus/
-        return "suspend"
+        return 'suspend'
       end
     end
 
     def state=(str)
       str = str.to_s
       if str.empty?
-        result = @@node.config_set("vlan", "state", @vlan_id, "no", "")
+        result = config_set('vlan', 'state', @vlan_id, 'no', '')
       else
-        result = @@node.config_set("vlan", "state", @vlan_id, "", str)
+        result = config_set('vlan', 'state', @vlan_id, '', str)
       end
       cli_error_check(result)
     rescue CliError => e
@@ -109,26 +106,26 @@ module Cisco
     end
 
     def default_state
-      @@node.config_get_default("vlan", "state")
+      config_get_default('vlan', 'state')
     end
 
     def shutdown
-      result = @@node.config_get("vlan", "shutdown", @vlan_id)
+      result = config_get('vlan', 'shutdown', @vlan_id)
       return default_shutdown if result.nil?
-      # valid result is either: "active"(aka no shutdown) or "shutdown"
+      # Valid result is either: "active"(aka no shutdown) or "shutdown"
       result.first[/shut/] ? true : false
     end
 
     def shutdown=(val)
-      no_cmd = (val) ? "" : "no"
-      result = @@node.config_set("vlan", "shutdown", @vlan_id, no_cmd)
+      no_cmd = (val) ? '' : 'no'
+      result = config_set('vlan', 'shutdown', @vlan_id, no_cmd)
       cli_error_check(result)
     rescue CliError => e
       raise "[vlan #{@vlan_id}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_shutdown
-      @@node.config_get_default("vlan", "shutdown")
+      config_get_default('vlan', 'shutdown')
     end
 
     def add_interface(interface)

data/lib/cisco_node_utils/vrf.rb

@@ -0,0 +1,80 @@
+# VRF provider class
+#
+# Jie Yang, July 2015
+#
+# Copyright (c) 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
+  # Vrf - node utility class for VRF configuration management
+  class Vrf < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      @name = name.downcase.strip
+      @args = { vrf: @name }
+      create if instantiate
+    end
+
+    def self.vrfs
+      hash = {}
+      vrf_list = config_get('vrf', 'all_vrfs')
+      return hash if vrf_list.nil?
+
+      vrf_list.each do |id|
+        id = id.downcase.strip
+        hash[id] = Vrf.new(id, false)
+      end
+      hash
+    end
+
+    def create
+      config_set('vrf', 'create', @args)
+    end
+
+    def destroy
+      config_set('vrf', 'destroy', @args)
+    end
+
+    def description
+      desc = config_get('vrf', 'description', @args)
+      return '' if desc.nil?
+      desc.shift.strip
+    end
+
+    def description=(desc)
+      fail TypeError unless desc.is_a?(String)
+      desc.strip!
+      no_cmd = desc.empty? ? 'no' : ''
+      config_set('vrf', 'description', vrf: @name, state: no_cmd, desc: desc)
+    rescue Cisco::CliError => e
+      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def shutdown
+      result = config_get('vrf', 'shutdown', @args)
+      result ? true : false
+    end
+
+    def shutdown=(val)
+      no_cmd = (val) ? '' : 'no'
+      config_set('vrf', 'shutdown', vrf: @name, state: no_cmd)
+    rescue Cisco::CliError => e
+      raise "[vrf #{@name}] '#{e.command}' : #{e.clierror}"
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/vtp.rb

@@ -1,5 +1,3 @@
-# VTP provider class
-#
 # Mike Wiebe, November 2014
 #
 # Copyright (c) 2014-2015 Cisco and/or its affiliates.
@@ -16,121 +14,126 @@
 # 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'
 
 module Cisco
-class Vtp
-  attr_reader :name
-
-  MAX_VTP_DOMAIN_NAME_SIZE = 32
-  MAX_VTP_PASSWORD_SIZE    = 64
+  # Vtp - node utility class for VTP configuration management
+  class Vtp < NodeUtil
+    attr_reader :name
 
-  @@node = Node.instance
+    MAX_VTP_DOMAIN_NAME_SIZE = 32
+    MAX_VTP_PASSWORD_SIZE    = 64
 
-  # Constructor for Vtp
-  def initialize(instantiate=true)
-    enable if instantiate and not Vtp.enabled
-  end
+    # Constructor for Vtp
+    def initialize(instantiate=true)
+      enable if instantiate && !Vtp.enabled
+    end
 
-  def Vtp.enabled
-    not @@node.config_get("vtp", "feature").nil?
-  end
+    def self.enabled
+      !config_get('vtp', 'feature').nil?
+    end
 
-  def enable
-    @@node.config_set("vtp", "feature", "")
-  end
+    def enable
+      config_set('vtp', 'feature', '')
+    end
 
-  # Disable vtp feature
-  def destroy
-    @@node.config_set("vtp", "feature", "no")
-  end
+    # Disable vtp feature
+    def destroy
+      config_set('vtp', 'feature', 'no')
+    end
 
-  # Get vtp domain name
-  def Vtp.domain
-    enabled ? @@node.config_get("vtp", "domain") : ""
-  end
+    # Get vtp domain name
+    def self.domain
+      enabled ? config_get('vtp', 'domain') : ''
+    end
 
-  def domain
-    Vtp.domain
-  end
+    def domain
+      Vtp.domain
+    end
 
-  # Set vtp domain name
-  def domain=(d)
-    raise ArgumentError unless d and d.is_a? String and
-                               d.length.between?(1, MAX_VTP_DOMAIN_NAME_SIZE)
-    enable unless Vtp.enabled
-    begin
-      @@node.config_set("vtp", "domain", d)
-    rescue Cisco::CliError => e
-      # cmd will syntax reject when setting name to same name
-      raise unless e.clierror =~ /ERROR: Domain name already set to /
+    # Set vtp domain name
+    def domain=(d)
+      fail ArgumentError unless d && d.is_a?(String) &&
+                                d.length.between?(1, MAX_VTP_DOMAIN_NAME_SIZE)
+      enable unless Vtp.enabled
+      begin
+        config_set('vtp', 'domain', d)
+      rescue Cisco::CliError => e
+        # cmd will syntax reject when setting name to same name
+        raise unless e.clierror =~ /ERROR: Domain name already set to /
+      end
     end
-  end
 
-  # Get vtp password
-  def password
-    # Unfortunately nxapi returns "\\" when the password is not set
-    password = @@node.config_get("vtp", "password") if Vtp.enabled
-    return '' if password.nil? or password == "\\"
-    password
-  end
+    # Get vtp password
+    def password
+      # Unfortunately nxapi returns "\\" when the password is not set
+      password = config_get('vtp', 'password') if Vtp.enabled
+      return '' if password.nil? || password == '\\'
+      password
+    end
 
-  # Set vtp password
-  def password=(password)
-    raise TypeError if password.nil?
-    raise TypeError unless password.is_a? String
-    raise ArgumentError if password.length > MAX_VTP_PASSWORD_SIZE
-    enable unless Vtp.enabled
-    begin
-      password == default_password ?
-        @@node.config_set("vtp", "password", "no", "") :
-        @@node.config_set("vtp", "password", "", password)
-    rescue Cisco::CliError => e
-      raise unless e.clierror =~ /password cannot be set for NULL domain/
-      raise "Setting VTP password requires first setting VTP domain" unless password == default_password
+    # Set vtp password
+    def password=(password)
+      fail TypeError if password.nil?
+      fail TypeError unless password.is_a? String
+      fail ArgumentError if password.length > MAX_VTP_PASSWORD_SIZE
+      enable unless Vtp.enabled
+      begin
+        if password == default_password
+          config_set('vtp', 'password', 'no', '')
+        else
+          config_set('vtp', 'password', '', password)
+        end
+      rescue Cisco::CliError => e
+        raise unless e.clierror =~ /password cannot be set for NULL domain/
+        unless password == default_password
+          raise 'Setting VTP password requires first setting VTP domain'
+        end
+      end
     end
-  end
 
-  # Get default vtp password
-  def default_password
-    @@node.config_get_default("vtp", "password")
-  end
+    # Get default vtp password
+    def default_password
+      config_get_default('vtp', 'password')
+    end
 
-  # Get vtp filename
-  def filename
-    match = @@node.config_get("vtp", "filename")
-    match.nil? ? default_filename : match.first
-  end
+    # Get vtp filename
+    def filename
+      match = config_get('vtp', 'filename')
+      match.nil? ? default_filename : match.first
+    end
 
-  # Set vtp filename
-  def filename=(uri)
-    raise TypeError if uri.nil?
-    enable unless Vtp.enabled
-    uri.empty? ?
-      @@node.config_set("vtp", "filename", "no", "") :
-      @@node.config_set("vtp", "filename", "", uri)
-  end
+    # Set vtp filename
+    def filename=(uri)
+      fail TypeError if uri.nil?
+      enable unless Vtp.enabled
+      if uri.empty?
+        config_set('vtp', 'filename', 'no', '')
+      else
+        config_set('vtp', 'filename', '', uri)
+      end
+    end
 
-  # Get default vtp filename
-  def default_filename
-    @@node.config_get_default("vtp", "filename")
-  end
+    # Get default vtp filename
+    def default_filename
+      config_get_default('vtp', 'filename')
+    end
 
-  # Get vtp version
-  def version
-    match = @@node.config_get("vtp", "version") if Vtp.enabled
-    match.nil? ? default_version : match.first.to_i
-  end
+    # Get vtp version
+    def version
+      match = config_get('vtp', 'version') if Vtp.enabled
+      match.nil? ? default_version : match.first.to_i
+    end
 
-  # Set vtp version
-  def version=(version)
-    enable unless Vtp.enabled
-    @@node.config_set("vtp", "version", "#{version}")
-  end
+    # Set vtp version
+    def version=(version)
+      enable unless Vtp.enabled
+      config_set('vtp', 'version', "#{version}")
+    end
 
-  # Get default vtp version
-  def default_version
-    @@node.config_get_default("vtp", "version")
+    # Get default vtp version
+    def default_version
+      config_get_default('vtp', 'version')
+    end
   end
 end
-end