cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/pim_rp_address.rb

@@ -0,0 +1,103 @@
+# NXAPI implementation of the PimRpAddress class
+#
+# Smitha Gopalan, November 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 'pim'
+
+module Cisco
+  # node_utils class for pim_rp_address
+  class PimRpAddress < NodeUtil
+    attr_reader :afi, :rp_addr, :vrf
+
+    # Constructor with afi, rp_address and vrf
+    # -----------------------------------------
+    def initialize(afi, vrf, rp_addr, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @afi = Pim.afi_cli(afi)
+      @rp_addr = rp_addr
+      @vrf = vrf
+      create if instantiate
+    end
+
+    # Create a hash of [afi][vrf][rp_address]
+    # ------------------------------------------------
+    def self.rp_addresses
+      afis = %w(ipv4) # TBD ipv6
+      hash = {}
+      return hash unless Feature.pim_enabled?
+      afis.each do |afi|
+        hash[afi] = {}
+        default_vrf = 'default'
+        get_args = { afi: Pim.afi_cli(afi) }
+        rp_addrs = config_get('pim', 'all_rp_addresses', get_args)
+        unless rp_addrs.nil?
+          rp_addrs.each do |addr|
+            hash[afi][default_vrf] ||= {}
+            hash[afi][default_vrf][addr] =
+              PimRpAddress.new(afi, default_vrf, addr, false)
+          end
+        end
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.each do |vrf|
+          get_args = { afi: Pim.afi_cli(afi), vrf: vrf }
+          rp_addrs = config_get('pim', 'all_rp_addresses', get_args)
+          next if rp_addrs.nil?
+          rp_addrs.each do |addr|
+            hash[afi][vrf] ||= {}
+            hash[afi][vrf][addr] = PimRpAddress.new(afi, vrf, addr, false)
+          end
+        end
+      end
+      hash
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    # set_args_keys_default
+    # ----------------------
+    def set_args_keys_default
+      keys = { afi: @afi, addr: @rp_addr }
+      keys[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args = keys
+    end
+
+    # set_args_key
+    # -------------
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    # Create pim rp_addr instance
+    # ------------------------------
+    def create
+      Feature.pim_enable
+      set_args_keys(state: '')
+      config_set('pim', 'rp_address', @set_args)
+    end
+
+    # Destroy pim rp_addr instance
+    # ------------------------------
+    def destroy
+      set_args_keys(state: 'no')
+      config_set('pim', 'rp_address', @set_args)
+    end
+  end
+end

data/lib/cisco_node_utils/platform.rb

@@ -0,0 +1,217 @@
+# Alex Hunsberger, Mar 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'
+
+module Cisco
+  # Platform - class for gathering platform hardware and software information
+  class Platform < NodeUtil
+    #
+    # NX: 7.0(3)I2(3) [build 7.0(3)I2(2.118)]
+    # XR: 6.1.1.04I
+    def self.image_version
+      config_get('show_version', 'version')
+    end
+
+    # ex: 'n3500-uk9.6.0.2.A3.0.40.bin'
+    def self.system_image
+      config_get('show_version', 'system_image')
+    end
+
+    # Returns package hash with state values
+    # Ex: { 'n3000-uk9.6.0.2.U1.1.CSCaa12345.bin' => 'inactive committed',
+    #       'n3000-uk9.6.0.2.U1.1.CSCaa12346.bin' => 'active', }
+    def self.packages
+      pkgs = []
+      pkg_hsh = {}
+      begin
+        pkgs = config_get('images', 'packages')
+      rescue RuntimeError => e
+        raise unless e.message[/Invalid command/]
+      end
+      return {} if pkgs.nil?
+      pkgs.each { |p| pkg_hsh[p[0]] = p[1].downcase }
+      pkg_hsh
+    end
+
+    # Ex: 'Cisco Nexus3064 Chassis ("48x10GE + 16x10G/4x40G Supervisor")'
+    def self.hardware_type
+      config_get('show_version', 'description')
+    end
+
+    # Ex: 'Intel(R) Celeron(R) CPU P450'
+    def self.cpu
+      config_get('show_version', 'cpu')
+    end
+
+    # Return hash with keys "total", "used", "free"
+    # Ex: { 'total' => '16402252K',
+    #       'used'  => '5909004K',
+    #       'free'  => '10493248K' }
+    def self.memory
+      {
+        'total' => config_get('memory', 'total'),
+        'used'  => config_get('memory', 'used'),
+        'free'  => config_get('memory', 'free'),
+      }
+    end
+
+    # Ex: 'Processor Board ID FOC15430TEY'
+    def self.board
+      config_get('show_version', 'board')
+    rescue RuntimeError => e
+      # Some Nexus platforms may fail to report this value.
+      return nil if /No key/ =~ e.message
+      raise
+    end
+
+    # Ex: '1 day(s), 21 hour(s), 46 minute(s), 54 second(s)'
+    def self.uptime
+      u = config_get('show_version', 'uptime')
+      fail 'failed to retrieve platform uptime' if u.nil?
+      u
+    end
+
+    # Ex: '23113 usecs after  Mon Jul  1 15:24:29 2013'
+    def self.last_reset
+      config_get('show_version', 'last_reset_time')
+    rescue RuntimeError => e
+      # Some Nexus platforms may fail to report this value.
+      return nil if /No key/ =~ e.message
+      raise
+    end
+
+    # Ex: 'Reset Requested by CLI command reload'
+    def self.reset_reason
+      config_get('show_version', 'last_reset_reason')
+    end
+
+    # Returns chassis hash with keys "descr", "pid", "vid", "sn"
+    # Ex: { 'descr' => 'Nexus9000 C9396PX Chassis',
+    #       'pid'   => 'N9K-C9396PX',
+    #       'vid'   => 'V02',
+    #       'sn'    => 'SAL1812NTBP' }
+    def self.chassis
+      # node.cache_flush # TODO: investigate why this is needed
+      all = config_get('inventory', 'chassis')
+      return nil if all.nil?
+
+      # item['name'] value is "\"Chassis\"" on most platforms,
+      # but n5k/n6k use "Chassis" so make the quotes optional.
+      chas = all.find { |item| item['name'][/^"?Chassis"?$/] }
+      return nil if chas.nil?
+      {
+        'descr' => chas['desc'].tr('"', ''),
+        'pid'   => chas['productid'],
+        'vid'   => chas['vendorid'],
+        'sn'    => chas['serialnum'],
+      }
+    end
+
+    # Returns hash of hashes with inner keys "name", "descr", "pid", "vid", "sn"
+    # Ex: { 'Slot 1' => { 'descr' => '1/10G SFP+ Ethernet Module',
+    #                     'pid'   => 'N9K-C9396PX',
+    #                     'vid'   => 'V02',
+    #                     'sn'    => 'SAL1812NTBP' },
+    #       'Slot 2' => { ... }}
+    def self.inventory_of(type)
+      inv = config_get('inventory', 'all')
+      inv_hsh = {}
+      return inv_hsh if inv.nil?
+      # Nexus gets structured output
+      inv_copy = inv.select { |x| x['name'].include? type }
+      return inv_hsh if inv_copy.empty?
+      # match desired output format
+      inv_copy.each do |s|
+        inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
+                                           'pid'   => s['productid'],
+                                           'vid'   => s['vendorid'],
+                                           'sn'    => s['serialnum'] }
+      end
+      inv_hsh
+    end
+
+    # Returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+    def self.slots
+      Platform.inventory_of('Slot')
+    end
+
+    # Returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+    def self.power_supplies
+      Platform.inventory_of('Power Supply')
+    end
+
+    # Returns array of hashes with keys "name", "descr", "pid", "vid", "sn"
+    def self.fans
+      Platform.inventory_of('Fan')
+    end
+
+    # Returns hash of hashes with inner keys "state", "application", ...
+    # Ex: { 'chef' => {
+    #        'package_info' => { 'name'     => 'n3k_chef.ova',
+    #                            'path'     => 'bootflash:/n3k_chef.ova' },
+    #        'application'  => { 'name'     => 'ChefAgent',
+    #                            'version'  => '0.1',
+    #                            'descr'    => 'Cisco Chef Agent' },
+    #        'signing'      => { 'key_type' => 'Cisco development key',
+    #                            'method'   => 'SHA-1' }
+    #        'licensing'    => { 'name'     => 'none',
+    #                            'version'  => 'none' }
+    #        'reservation'  => { 'disk'     => '111 MB',
+    #                            'memory'   => '0 MB',
+    #                            'cpu'      => '0% system CPU' }},
+    #      { ... }}
+    def self.virtual_services
+      # If no virtual-services are installed, this will result
+      # in a RuntimeError.  We need to rescue this specific case.
+      begin
+        virts = config_get('virtual_service', 'services')
+      rescue RuntimeError => e
+        return {} if e.message[/No key \"TABLE_detail\"/]
+        raise
+      end
+      return {} if virts.nil?
+      # NXAPI returns hash instead of array if there's only 1
+      virts = [virts] if virts.is_a? Hash
+      # convert to expected format
+      virts_hsh = {}
+      virts.each do |serv|
+        # rubocop:disable Style/AlignHash
+        virts_hsh[serv['name']] = {
+          'package_info' => { 'name'     => serv['package_name'],
+                              'path'     => serv['ova_path'],
+          },
+          'application'  => { 'name'     => serv['application_name'],
+                              'version'  => serv['application_version'],
+                              'descr'    => serv['application_description'],
+          },
+          'signing'      => { 'key_type' => serv['key_type'],
+                              'method'   => serv['signing_method'],
+          },
+          'licensing'    => { 'name'     => serv['licensing_name'],
+                              'version'  => serv['licensing_version'],
+          },
+          'reservation'  => { 'disk'     => serv['disk_reservation'],
+                              'memory'   => serv['memory_reservation'],
+                              'cpu'      => serv['cpu_reservation'],
+          },
+        }
+        # rubocop:enable Style/AlignHash
+      end
+      virts_hsh
+    end
+  end
+end

data/lib/cisco_node_utils/portchannel_global.rb

@@ -0,0 +1,347 @@
+# December 2015, Sai Chintalapudi
+#
+# 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 portchannel_global
+  class PortChannelGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name == 'default'
+      @name = name.downcase
+    end
+
+    def to_s
+      "portchannel_global #{name}"
+    end
+
+    def self.globals
+      { 'default' => PortChannelGlobal.new('default') }
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def load_balance_type
+      config_get('portchannel_global', 'load_balance_type')
+    end
+
+    def hash_distribution
+      config_get('portchannel_global', 'hash_distribution')
+    end
+
+    def hash_distribution=(val)
+      config_set('portchannel_global',
+                 'hash_distribution', val)
+    end
+
+    def default_hash_distribution
+      config_get_default('portchannel_global', 'hash_distribution')
+    end
+
+    def load_defer
+      config_get('portchannel_global', 'load_defer')
+    end
+
+    def load_defer=(val)
+      config_set('portchannel_global', 'load_defer', val)
+    end
+
+    def default_load_defer
+      config_get_default('portchannel_global', 'load_defer')
+    end
+
+    def resilient
+      config_get('portchannel_global', 'resilient')
+    end
+
+    def resilient=(state)
+      fail TypeError unless state == true || state == false
+      no_cmd = (state ? '' : 'no')
+      config_set('portchannel_global', 'resilient', no_cmd)
+    end
+
+    def default_resilient
+      config_get_default('portchannel_global', 'resilient')
+    end
+
+    # port-channel load-balance is a complicated command
+    # and this has so many forms in the same device and in
+    # different devices.
+    # For ex:
+    # port-channel load-balance src-dst ip rotate 4 concatenation symmetric
+    # port-channel load-balance resilient
+    # port-channel load-balance ethernet destination-mac CRC10c
+    # port-channel load-balance ethernet source-ip
+    # port-channel load-balance dst ip-l4port rotate 4 asymmetric
+    # port-channel load-balance dst ip-l4port-vlan module 9
+    # port-channel load-balance hash-modulo
+    # we need to eliminate all the clutter and get the correct
+    # line of config first and after that get index of each property
+    # and get the property value because some properties may or
+    # may not be present always.
+    # This method returns a hash
+    def port_channel_load_balance
+      lb = config_get('portchannel_global',
+                      'port_channel_load_balance')
+      hash = {}
+      lb.each do |line|
+        next if line[/(internal|resilient|module|fex|hash)/]
+        params = line.split
+        lb_type = config_get('portchannel_global', 'load_balance_type')
+        case lb_type.to_sym
+        when :no_rotate # n3k
+          _parse_no_rotate_params(hash, params, line)
+        when :ethernet # n6k
+          _parse_ethernet_params(hash, params)
+        when :asymmetric # n7k
+          _parse_asymmetric_params(hash, params, line)
+        when :no_hash # n9k-f or n3k-f
+          _parse_no_hash_params(hash, params)
+        when :symmetry # n9k
+          _parse_symmetry_params(hash, params, line)
+        end
+      end
+      hash
+    end
+
+    def asymmetric
+      port_channel_load_balance[:asymmetric]
+    end
+
+    def default_asymmetric
+      config_get_default('portchannel_global',
+                         'asymmetric')
+    end
+
+    def bundle_hash
+      port_channel_load_balance[:bundle_hash]
+    end
+
+    def default_bundle_hash
+      config_get_default('portchannel_global',
+                         'bundle_hash')
+    end
+
+    def bundle_select
+      port_channel_load_balance[:bundle_select]
+    end
+
+    def default_bundle_select
+      config_get_default('portchannel_global',
+                         'bundle_select')
+    end
+
+    def concatenation
+      port_channel_load_balance[:concatenation]
+    end
+
+    def default_concatenation
+      config_get_default('portchannel_global',
+                         'concatenation')
+    end
+
+    def hash_poly
+      port_channel_load_balance[:hash_poly]
+    end
+
+    def rotate
+      port_channel_load_balance[:rotate]
+    end
+
+    def default_rotate
+      config_get_default('portchannel_global',
+                         'rotate')
+    end
+
+    def symmetry
+      port_channel_load_balance[:symmetry]
+    end
+
+    def default_symmetry
+      config_get_default('portchannel_global',
+                         'symmetry')
+    end
+
+    def port_channel_load_balance=(bselect, bhash, hpoly, asy, sy, conc, rot)
+      lb_type = config_get('portchannel_global', 'load_balance_type')
+      case lb_type.to_sym
+      when :no_rotate # n3k
+        sym = sy ? 'symmetric' : ''
+        if bselect == 'src'
+          sel = 'source'
+        elsif bselect == 'dst'
+          sel = 'destination'
+        else
+          sel = 'source-dest'
+        end
+        sel_hash = sel + '-' + bhash
+        # port-channel load-balance ethernet source-dest-ip symmetric
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   'ethernet', sel_hash, sym, '', '', '')
+      when :ethernet # n6k
+        if bselect == 'src'
+          sel = 'source'
+        elsif bselect == 'dst'
+          sel = 'destination'
+        else
+          sel = 'source-dest'
+        end
+        sel_hash = sel + '-' + bhash
+        # port-channel load-balance ethernet destination-mac CRC10c
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   'ethernet', sel_hash, hpoly, '', '', '')
+      when :asymmetric # n7k
+        asym = (asy == true) ? 'asymmetric' : ''
+        # port-channel load-balance dst ip-l4port rotate 4 asymmetric
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   bselect, bhash, 'rotate', rot.to_s, asym, '')
+      when :no_hash # n9k-f or n3k-f
+        # port-channel load-balance dst ip-l4port rotate 4
+        rot_str = rot.zero? ? '' : 'rotate'
+        rot_val = rot.zero? ? '' : rot.to_s
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   bselect, bhash, rot_str, rot_val, '', '')
+      when :symmetry # n9k
+        sym = sy ? 'symmetric' : ''
+        concat = conc ? 'concatenation' : ''
+        rot_str = rot.zero? ? '' : 'rotate'
+        rot_val = rot.zero? ? '' : rot.to_s
+        # port-channel load-balance src-dst ip rotate 4 concatenation symmetric
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   bselect, bhash, rot_str, rot_val, concat, sym)
+      end
+    end
+
+    # N3k: The bundle hash and bundle select are merged into one output;
+    # also note that the field names are source & destination instead of
+    # src & dst as in other devices.
+    def _parse_no_rotate_params(hash, params, line)
+      sym = (line.include? 'symmetric') ? true : false
+
+      select_hash = params[1]
+      lparams = select_hash.split('-')
+      if lparams[0].downcase == 'destination'
+        bselect = 'dst'
+        bhash = lparams[1]
+        # there are bundles hashes like ip-gre which
+        # need extra processing
+        bhash += '-gre' if select_hash.include? 'gre'
+      else
+        if select_hash.include? '-dest-'
+          bselect = 'src-dst'
+          bhash = lparams[2]
+          bhash += '-gre' if select_hash.include? 'gre'
+          # there are bundles hashes like ip-only and
+          # port-only specific to src-dst
+          bhash += '-only' if select_hash.include? 'only'
+        else
+          bselect = 'src'
+          bhash = lparams[1]
+          # there are bundles hashes like ip-gre which
+          # need extra processing
+          bhash += '-gre' if select_hash.include? 'gre'
+        end
+      end
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:symmetry] = sym
+      hash
+    end
+
+    # N5k/N6k: The bundle hash and bundle select are merged into one output;
+    # also note that the field names are source & destination instead of
+    # src & dst as in other devices.
+    def _parse_ethernet_params(hash, params)
+      hash_poly = params[2]
+
+      # Depending on the chipset, hash_poly may have have a different
+      # default value within the same platform family (this is done to
+      # avoid polarization) but there is currently no command available
+      # to dynamically determine the default state. As a result the
+      # getter simply hard-codes a default value which means it may
+      # encounter occasional idempotence issues.
+      hash_poly = hash_poly.nil? ? 'CRC10b' : hash_poly
+
+      select_hash = params[1]
+      lparams = select_hash.split('-')
+      if lparams[0].downcase == 'destination'
+        bselect = 'dst'
+        bhash = lparams[1]
+      else
+        if select_hash.include? '-dest-'
+          bselect = 'src-dst'
+          bhash = lparams[2]
+          # there are bundles hashes like ip-only and
+          # port-only specific to src-dst
+          bhash += '-only' if select_hash.include? 'only'
+        else
+          bselect = 'src'
+          bhash = lparams[1]
+        end
+      end
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:hash_poly] = hash_poly
+      hash
+    end
+
+    def _parse_asymmetric_params(hash, params, line)
+      bselect = params[0]
+      bhash = params[1]
+      # asymmetric keyword does not show up if it is false
+      asym = (line.include? 'asymmetric') ? true : false
+      ri = params.index('rotate')
+      rotate = params[ri + 1].to_i
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:asymmetric] = asym
+      hash[:rotate] = rotate
+      hash
+    end
+
+    def _parse_no_hash_params(hash, params)
+      bselect = params[0]
+      bhash = params[1]
+      ri = params.index('rotate')
+      rotate = params[ri + 1].to_i
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:rotate] = rotate
+      hash
+    end
+
+    def _parse_symmetry_params(hash, params, line)
+      bselect = params[0]
+      bhash = params[1]
+      ri = params.index('rotate')
+      rotate = params[ri + 1].to_i
+      # concatenation and symmetry keywords do not show up if false
+      concat = (line.include? 'concatenation') ? true : false
+      sym = (line.include? 'symmetric') ? true : false
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:symmetry] = sym
+      hash[:rotate] = rotate
+      hash[:concatenation] = concat
+      hash
+    end
+  end # class
+end # module