cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/tacacs_server_group.rb

@@ -0,0 +1,149 @@
+#
+# NXAPI implementation of TacacsServerGroup class
+#
+# April 2015, Alex Hunsberger
+#
+# 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'
+require_relative 'tacacs_server'
+
+module Cisco
+  # NXAPI implementation of AAA Server Group class
+  class TacacsServerGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name, create=true)
+      fail TypeError unless name.is_a? String
+      @name = name
+
+      return unless create
+
+      TacacsServer.new.enable if platform != :ios_xr && !TacacsServer.enabled
+      config_set('tacacs_server_group', 'group', state: '', name: name)
+    end
+
+    def destroy
+      config_set('tacacs_server_group', 'group', state: 'no', name: @name)
+    end
+
+    def servers
+      config_get('tacacs_server_group', 'servers', @name)
+    end
+
+    def servers=(new_servs)
+      fail TypeError unless new_servs.is_a? Array
+      current_servs = servers
+      new_servs.each do |s|
+        # add any servers not yet configured
+        next if current_servs.include? s
+        config_set('tacacs_server_group',
+                   'servers',
+                   name:   @name,
+                   state:  '',
+                   server: s)
+      end
+      current_servs.each do |s|
+        # remove any undesired existing servers
+        next if new_servs.include? s
+        config_set('tacacs_server_group',
+                   'servers',
+                   name:   @name,
+                   state:  'no',
+                   server: s)
+      end
+    end
+
+    def default_servers
+      config_get_default('tacacs_server_group', 'servers')
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    # for netdev compatibility
+    def self.tacacs_server_groups
+      groups
+    end
+
+    def self.groups
+      grps = {}
+      if platform == :ios_xr
+        tacgroups = config_get('tacacs_server_group', 'group')
+      else
+        tacgroups = config_get('tacacs_server_group', 'group') if
+          TacacsServer.enabled
+      end
+      unless tacgroups.nil?
+        tacgroups.each { |s| grps[s] = TacacsServerGroup.new(s, false) }
+      end
+      grps
+    end
+
+    def vrf
+      # vrf is always present in running config
+      v = config_get('tacacs_server_group', 'vrf', @name)
+      v.nil? ? default_vrf : v
+    end
+
+    def vrf=(v)
+      fail TypeError unless v.is_a? String
+      # vrf = "default" is equivalent to unconfiguring vrf
+      config_set('tacacs_server_group', 'vrf', name: @name, state: '', vrf: v)
+    end
+
+    def default_vrf
+      config_get_default('tacacs_server_group', 'vrf')
+    end
+
+    def deadtime
+      d = config_get('tacacs_server_group', 'deadtime', @name)
+      d.nil? ? default_deadtime : d.to_i
+    end
+
+    def deadtime=(t)
+      no_cmd = t == default_deadtime ? 'no' : ''
+      config_set('tacacs_server_group',
+                 'deadtime',
+                 name:     @name,
+                 state:    no_cmd,
+                 deadtime: t)
+    end
+
+    def default_deadtime
+      config_get_default('tacacs_server_group', 'deadtime')
+    end
+
+    def source_interface
+      i = config_get('tacacs_server_group', 'source_interface', @name)
+      i.nil? ? default_source_interface : i.downcase
+    end
+
+    def source_interface=(s)
+      fail TypeError unless s.is_a? String
+      no_cmd = s == default_source_interface ? 'no' : ''
+      config_set('tacacs_server_group',
+                 'source_interface',
+                 name:      @name,
+                 state:     no_cmd,
+                 interface: s)
+    end
+
+    def default_source_interface
+      config_get_default('tacacs_server_group', 'source_interface')
+    end
+  end
+end

data/lib/cisco_node_utils/tacacs_server_host.rb

@@ -0,0 +1,216 @@
+# Alex Hunsberger, March 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'
+require_relative 'tacacs_server'
+
+module Cisco
+  # TacacsServerHost - node utility class for TACACS+ server host config
+  class TacacsServerHost < NodeUtil
+    attr_reader :name
+    @hosts = {}
+
+    def initialize(name, instantiate=true, host_port=nil)
+      fail TypeError unless name.is_a? String
+      fail ArgumentError if name.empty?
+      @name = name
+
+      if platform == :ios_xr
+        if host_port.nil?
+          @port = config_get_default('tacacs_server_host', 'port')
+        else
+          fail ArgumentError, 'host_port must be an Integer' \
+            unless host_port.is_a?(Integer)
+          @port = host_port
+        end
+      end
+
+      create if instantiate
+
+      return if platform == :ios_xr
+
+      return if host_port.nil?
+      fail ArgumentError, 'host_port must be an Integer' \
+        unless host_port.is_a?(Integer)
+      self.port = host_port
+    end
+
+    def self.hosts
+      hosts = {}
+      return hosts unless Feature.tacacs_enabled?
+
+      hosts_list = config_get('tacacs_server_host', 'hosts')
+      return hosts if hosts_list.nil? || hosts_list.empty?
+
+      hosts_list.each do |name|
+        if platform == :ios_xr
+          host_port = config_get('tacacs_server_host', 'port', ip: name)
+          host_port = host_port[0] if host_port.is_a?(Array)
+          host_port = host_port.to_i
+
+          hosts[name] = TacacsServerHost.new(name, false, host_port)
+        else
+          hosts[name] = TacacsServerHost.new(name, false) if @hosts[name].nil?
+        end
+      end
+      hosts
+    end
+
+    def create
+      destroy if platform == :ios_xr
+      Feature.tacacs_enable
+      config_set('tacacs_server_host',
+                 'host',
+                 state: '',
+                 ip:    name,
+                 port:  @port)
+    end
+
+    def destroy
+      if platform == :ios_xr
+        # This provider only support a 1-1 mapping between host and ports.
+        # Thus, we must remove the other entries on different ports.
+        all_hosts = config_get('tacacs_server_host',
+                               'host_port_pairs',
+                               ip: @name)
+        return unless all_hosts.is_a?(Array)
+
+        warn("#{name} is configured multiple times on the device" \
+            ' (possibly using different ports). This is unsupported by this' \
+            ' API and the duplicate entries are being deleted.') \
+          if all_hosts.count > 1
+
+        all_hosts.each do |host_port|
+          config_set('tacacs_server_host',
+                     'host',
+                     state: 'no',
+                     ip:    @name,
+                     port:  host_port)
+        end
+      else
+        config_set('tacacs_server_host',
+                   'host',
+                   state: 'no',
+                   ip:    @name,
+                   port:  @port)
+      end
+    end
+
+    def port
+      platform == :ios_xr ? @port : config_get('tacacs_server_host',
+                                               'port',
+                                               ip: @name)
+    end
+
+    def port=(n)
+      fail("'port' setter method not applicable for this platform." \
+        'port must be passed in to the constructor.') \
+          if platform == :ios_xr
+
+      config_set('tacacs_server_host', 'port', ip: @name, port: n.to_i)
+    end
+
+    def self.default_port
+      config_get_default('tacacs_server_host', 'port')
+    end
+
+    def encryption_type
+      type = config_get('tacacs_server_host',
+                        'encryption_type',
+                        ip:   @name,
+                        port: @port)
+      type.nil? ? TACACS_SERVER_ENC_UNKNOWN : type.to_i
+    end
+
+    def self.default_encryption_type
+      TacacsServer.default_encryption_type
+    end
+
+    def encryption_password
+      str = config_get('tacacs_server_host',
+                       'encryption_password',
+                       ip:   @name,
+                       port: @port)
+      return str if str.nil? || str.empty?
+      index = str.index('port')
+      str = str[0..index - 2] unless index.nil?
+      str.strip
+    end
+
+    def self.default_encryption_password
+      config_get_default('tacacs_server_host', 'encryption_password')
+    end
+
+    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)
+      password = Utils.add_quotes(password) unless password.empty?
+      # 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',
+                     state:    'no',
+                     ip:       @name,
+                     port:     @port,
+                     enc_type: encryption_type,
+                     password: encryption_password)
+        end
+      else
+        config_set('tacacs_server_host',
+                   'encryption',
+                   state:    '',
+                   ip:       @name,
+                   port:     @port,
+                   enc_type: enctype,
+                   password: password)
+      end
+    end
+
+    def timeout
+      config_get('tacacs_server_host',
+                 'timeout',
+                 ip:   @name,
+                 port: @port)
+    end
+
+    def timeout=(t)
+      fail TypeError unless t.is_a? Fixnum
+      return if t == timeout
+
+      config_set('tacacs_server_host',
+                 'timeout',
+                 state:   '',
+                 ip:      @name,
+                 port:    @port,
+                 timeout: t)
+    end
+
+    def self.default_timeout
+      config_get_default('tacacs_server_host', 'timeout')
+    end
+
+    def ==(other)
+      name == other.name
+    end
+  end
+end

data/lib/cisco_node_utils/upgrade.rb

@@ -0,0 +1,122 @@
+# October 2016, Michael G Wiebe and Rahul Shenoy
+#
+# Copyright (c) 2016-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'
+require_relative 'logger'
+
+module Cisco
+  # Upgrade - node util class for upgrading Cisco devices
+  class Upgrade < NodeUtil
+    # Delete install logs from previous installation
+    def self.clear_status
+      config_set('upgrade', 'clear_status')
+    end
+
+    # Deletes 'image' from 'uri'
+    def self.delete(image, uri='bootflash:')
+      config_set('upgrade', 'delete', image: image, uri: uri)
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Deletes currently booted image
+    def self.delete_boot(uri='bootflash:')
+      # Incase of a N9K, N3K and N9Kv the system and kickstart images are
+      # the same.
+      # Incase of a N5K, N6K and N7K the system and kickstart images are
+      # different.
+      system_image = config_get('show_version', 'system_image').split('/')[-1]
+      kickstart_image = config_get('show_version', 'boot_image').split('/')[-1]
+      if kickstart_image == system_image
+        config_set('upgrade', 'delete_boot', image: system_image, uri: uri)
+      else
+        config_set('upgrade', 'delete_boot', image: system_image,
+                                             uri:   uri)
+        config_set('upgrade', 'delete_boot', image: kickstart_image,
+                                             uri:   uri)
+      end
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Returns version of the 'image'
+    def self.image_version(image=nil, uri=nil)
+      # Returns version of currently booted image by default
+      if image && uri
+        config_get('upgrade', 'image_version', image: image, uri: uri)
+      else
+        version = config_get('show_version', 'version')
+        # show version displays version differently for release and
+        # development builds.
+        # Eg: release build
+        #       NXOS: version 7.0(3)I4(2)
+        # Eg: development build
+        #       NXOS: version 7.0(3)IFD6(1) [build 7.0(3)IGD7(0.65)]
+        return version unless version[/build\s+\S+/]
+        version.split(' ')[-1].split(']')[0]
+      end
+    end
+
+    # Return the nxos image installed on the device
+    def self.package
+      config_get('show_version', 'system_image')
+    end
+
+    # Return true if box is online and config mode is ready to be used
+    def self.box_online?
+      output = config_set('upgrade', 'is_box_online')
+      output[0]['body'] == {}
+    end
+
+    def self.save_config
+      config_set('upgrade', 'save_config')
+    rescue Cisco::CliError => e
+      raise e
+    end
+
+    # Returns True if device upgraded
+    def self.upgraded?
+      return false unless config_get('upgrade', 'upgraded')
+      (0..500).each do
+        sleep 1
+        return true if box_online?
+      end
+      fail 'Configuration is still blocked'
+    end
+
+    # Attempts to upgrade the device to 'image'
+    def self.upgrade(image, uri='bootflash:', del_boot=false,
+                     force_all=false)
+      delete_boot(uri) if del_boot
+      force_all ? upgrade_str = 'upgrade_force' : upgrade_str = 'upgrade'
+      begin
+        Cisco::Logger.debug("Upgrading to version: #{image}")
+        config_set('upgrade', upgrade_str, image: image, uri: uri)
+      rescue Cisco::RequestFailed, Cisco::CliError => e1
+        # raise if install command failed
+        raise e1 if e1.class == Cisco::CliError
+        # Catch 'Backend Processing Error'. Install continues inspite of the
+        # error thrown. Resend install command and expect a CliError.
+        begin
+          config_set('upgrade', upgrade_str, image: image, uri: uri)
+        rescue Cisco::CliError => e2
+          raise e2 unless
+            e2.message.include?('Another install procedure may be in progress')
+        end
+      end
+    end
+  end
+end

data/lib/cisco_node_utils/vdc.rb

@@ -0,0 +1,118 @@
+#
+# NXAPI implementation of VDC class
+#
+# December 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.
+
+require_relative 'node_util'
+
+module Cisco
+  # node_utils class for vdc
+  class Vdc < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      @vdc = (name == 'default') ? Vdc.default_vdc_name : name
+      create if instantiate
+    end
+
+    def self.vdcs
+      hash = {}
+      vdc_list = config_get('vdc', 'all_vdcs')
+      return hash if vdc_list.nil?
+
+      vdc_list.each do |vdc_name|
+        hash[vdc_name] = Vdc.new(vdc_name, false)
+      end
+      hash
+    end
+
+    def self.vdc_support
+      config_get('vdc', 'vdc_support')
+    end
+
+    def self.default_vdc_name
+      vdc = config_get('vdc', 'default_vdc_name')
+      fail 'default vdc not found, platform may not support vdc' if vdc.nil?
+      vdc
+    end
+
+    def create
+      fail ArgumentError,
+           'There is currently no support for non-default VDCs' unless
+        @vdc == Vdc.default_vdc_name
+      # noop for 'default' vdc
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def allocate_interface
+      # TBD: This property is only partially implemented because it is currently
+      # only used for minitest & beaker.
+      config_get('vdc', 'allocate_interface', vdc: @vdc)
+    end
+
+    def limit_resource_module_type
+      str = config_get('vdc', 'limit_resource_module_type', vdc: @vdc)
+      str.strip! unless str.nil?
+    end
+
+    def limit_resource_module_type=(mods)
+      state = mods.empty? ? 'no' : ''
+      begin
+        # limit-resource commands are time-consuming and process in the
+        # background. Back-to-back LR commands may fail if processed too
+        # quickly.
+        config_set('vdc', 'limit_resource_module_type',
+                   state: state, vdc: @vdc, mods: mods)
+
+        # TBD: No interfaces are allocated after changing the module-type
+        # so 'allocate' is needed to make this useful. Consider moving
+        # this into it's own property.
+        config_set('vdc', 'allocate_interface_unallocated', vdc: @vdc)
+
+      rescue CliError => e
+        count ||= 1
+        if e.message[/VDC is not in active state/] && (count += 1) < 10
+          retry
+        end
+        raise
+      end
+    end
+
+    def default_limit_resource_module_type
+      config_get_default('vdc', 'limit_resource_module_type')
+    end
+
+    def interface_membership
+      config_get('vdc', 'membership', vdc: @vdc)
+    end
+
+    def interface_membership=(intf)
+      config_set('vdc', 'membership', vdc: @vdc, intf: intf)
+    end
+
+    def default_interface_membership
+      config_get_default('vdc', 'membership')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/version.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2015-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.
+
+# Container module for version number only.
+module CiscoNodeUtils
+  VERSION = '2.1.0.1'
+  gem_version = Gem::Version.new(Gem::VERSION)
+  min_gem_version = Gem::Version.new('2.1.0')
+  fail 'Required rubygems version >= 2.1.0' if gem_version < min_gem_version
+end