cisco_node_utils 1.3.0 → 1.4.0

data/lib/cisco_node_utils/bgp_neighbor_af.rb

@@ -99,7 +99,10 @@ module Cisco
     # rubocop:enable Style/AccessorMethodNamefor
 
     def create
-      Feature.bgp_enable if platform == :nexus
+      if platform == :nexus
+        Feature.bgp_enable
+        Feature.nv_overlay_evpn_enable if @safi[/evpn/]
+      end
       set_args_keys(state: '')
       config_set('bgp_neighbor', 'af', @set_args)
     end

data/lib/cisco_node_utils/cisco_cmn_utils.rb

@@ -224,5 +224,131 @@ module Cisco
       end
       lranges.to_s.gsub('..', '-').delete('[').delete(']').delete(' ')
     end
+
+    # normalize_range_array
+    #
+    # Given a list of ranges, merge any overlapping ranges and sort them.
+    #
+    # Note: The ranges are converted to ruby ranges for easy merging,
+    # then converted back to a cli-syntax range.
+    #
+    # Accepts an array or string:
+    #   ["2-5", "9", "4-6"]  -or-  '2-5, 9, 4-6'  -or-  ["2-5, 9, 4-6"]
+    # Returns a merged and ordered range as an array or string:
+    #   ["2-6", "9"] -or- '2-6,9'
+    #
+    def self.normalize_range_array(range, fmt=:array)
+      return range if range.nil? || range.empty?
+      range = range.clone
+
+      # Handle string within an array: ["2-5, 9, 4-6"] to '2-5, 9, 4-6'
+      range = range.shift if range.is_a?(Array) && range.length == 1
+
+      # Handle string only: '2-5, 9, 4-6' to ["2-5", "9", "4-6"]
+      range = range.split(',') if range.is_a?(String)
+
+      # Convert to ruby-syntax ranges
+      range = dash_range_to_ruby_range(range)
+
+      # Sort & Merge
+      merged = merge_range(range)
+
+      # Convert back to cli dash-syntax
+      merged_array = ruby_range_to_dash_range(merged)
+
+      return merged_array.join(',') if fmt == :string
+      merged_array
+    end
+
+    # Convert a cli-dash-syntax range to ruby-range. This is useful for
+    # preparing inputs to merge_range().
+    #
+    # Inputs an array or string of dash-syntax ranges -> returns an array
+    # of ruby ranges.
+    #
+    # Accepts an array or string: ["2-5", "9", "4-6"] or '2-5, 9, 4-6'
+    # Returns an array of ranges: [2..5, 9..9, 4..6]
+    #
+    def self.dash_range_to_ruby_range(range)
+      range = range.split(',') if range.is_a?(String)
+      range.map! do |rng|
+        if rng[/-/]
+          # '2-5' -> 2..5
+          rng.split('-').inject { |a, e| a.to_i..e.to_i }
+        else
+          # '9' -> 9..9
+          rng.to_i..rng.to_i
+        end
+      end
+      range
+    end
+
+    # Convert a ruby-range to cli-dash-syntax.
+    #
+    # Inputs an array of ruby ranges -> returns an array or string of
+    # dash-syntax ranges.
+    #
+    # when (:array)  [2..6, 9..9]  ->  ['2-6', '9']
+    #
+    # when (:string)  [2..6, 9..9]  ->  '2-6, 9'
+    #
+    def self.ruby_range_to_dash_range(range, type=:array)
+      fail unless range.is_a?(Array)
+      range.map! do |r|
+        if r.first == r.last
+          # 9..9 -> '9'
+          r.first.to_s
+        else
+          # 2..6 -> '2-6'
+          r.first.to_s + '-' + r.last.to_s
+        end
+      end
+      return range.join(', ') if type == :string
+      range
+    end
+
+    # Convert a dash-range set into individual elements.
+    # This is useful for preparing inputs to delta_add_remove().
+    #
+    # Inputs an array or string of dash-ranges:
+    #  ["2-5", "9", "4-6"] or '2-5, 9, 4-6' or ['2-5, 9, 4-6']
+    # Returns an array of range elements:
+    #  ["2", "3", "4", "5", "6", "9"]
+    #
+    def self.dash_range_to_elements(range)
+      return [] if range.nil?
+      range = range.shift if range.is_a?(Array) && range.length == 1
+      range = range.split(',') if range.is_a?(String)
+
+      final = []
+      range = dash_range_to_ruby_range(range)
+      range.each do |rng|
+        # 2..5 maps to ["2", "3", "4", "5"]
+        final << rng.map(&:to_s)
+      end
+      final.flatten.uniq.sort
+    end
+
+    # Merge overlapping ranges.
+    #
+    # Inputs an array of ruby ranges:         [2..5, 9..9, 4..6]
+    # Returns an array of merged ruby ranges: [2..6, 9..9]
+    #
+    def self.merge_range(range)
+      # sort to lowest range 'first' values:
+      #    [2..5, 9..9, 4..6]  ->  [2..5, 4..6, 9..9]
+      range = range.sort_by(&:first)
+
+      *merged = range.shift
+      range.each do |r|
+        lastr = merged[-1]
+        if lastr.last >= r.first - 1
+          merged[-1] = lastr.first..[r.last, lastr.last].max
+        else
+          merged.push(r)
+        end
+      end
+      merged
+    end # merge_range
   end # class Utils
 end   # module Cisco

data/lib/cisco_node_utils/client/client.rb

@@ -167,9 +167,11 @@ class Cisco::Client
   # @param data_format one of Cisco::DATA_FORMATS. Default is :cli
   # @param context [String, Array<String>] Context for the configuration
   # @param values [String, Array<String>] Actual configuration to set
+  # @param kwargs data-format-specific args
   def set(data_format: :cli,
           context:     nil,
-          values:      nil)
+          values:      nil,
+          **_kwargs)
     # subclasses will generally want to call Client.munge_to_array()
     # on context and/or values before calling super()
     fail Cisco::RequestNotSupported unless self.supports?(data_format)
@@ -195,11 +197,13 @@ class Cisco::Client
   # @param command [String] the get command to execute
   # @param context [String, Array<String>] Context to refine/filter the results
   # @param value [String, Regexp] Specific key or regexp to look up
+  # @param kwargs data-format-specific args
   # @return [String, Hash, nil] The state found, or nil if not found.
   def get(data_format: :cli,
           command:     nil,
           context:     nil,
-          value:       nil)
+          value:       nil,
+          **_kwargs)
     # subclasses will generally want to call Client.munge_to_array()
     # on context and/or value before calling super()
     fail Cisco::RequestNotSupported unless self.supports?(data_format)

data/lib/cisco_node_utils/client/grpc/client.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require_relative '../client'
+require_relative '../../constants'
 Cisco::Client.silence_warnings do
   require 'grpc'
 end
@@ -37,7 +38,7 @@ class Cisco::Client::GRPC < Cisco::Client
     kwargs[:host] ||= '127.0.0.1'
     kwargs[:port] ||= 57_400
     # rubocop:disable Style/HashSyntax
-    super(data_formats: [:cli],
+    super(data_formats: [:cli, :yang_json],
           platform:     :ios_xr,
           **kwargs)
     # rubocop:enable Style/HashSyntax
@@ -85,47 +86,64 @@ class Cisco::Client::GRPC < Cisco::Client
   # @param data_format one of Cisco::DATA_FORMATS. Default is :cli
   # @param context [Array<String>] Zero or more configuration commands used
   #                to enter the desired CLI sub-mode
-  # @param values [Array<String>] One or more commands to enter within the
-  #   CLI sub-mode.
+  # @param values [Array<String>] One or more commands to execute /
+  #                               config strings to send
+  # @param kwargs data-format-specific args
   def set(data_format: :cli,
           context:     nil,
-          values:      nil)
+          values:      nil,
+          **kwargs)
     context = munge_to_array(context)
     values = munge_to_array(values)
     super
-    # IOS XR lets us concatenate submode commands together.
-    # This makes it possible to guarantee we are in the correct context:
-    #   context: ['foo', 'bar'], values: ['baz', 'bat']
-    #   ---> values: ['foo bar baz', 'foo bar bat']
-    # However, there's a special case for 'no' commands:
-    #   context: ['foo', 'bar'], values: ['no baz']
-    #   ---> values: ['no foo bar baz'] ---- the 'no' goes at the start
-    context = context.join(' ')
-    unless context.empty?
-      values.map! do |cmd|
-        match = cmd[/^\s*no\s+(.*)/, 1]
-        if match
-          cmd = "no #{context} #{match}"
-        else
-          cmd = "#{context} #{cmd}"
+    if data_format == :yang_json
+      mode = kwargs[:mode] || :merge_config
+      fail ArgumentError unless Cisco::YANG_SET_MODE.include? mode
+      values.each do |yang|
+        yang_req(@config, mode.to_s, ConfigArgs.new(yangjson: yang))
+      end
+    else
+      # IOS XR lets us concatenate submode commands together.
+      # This makes it possible to guarantee we are in the correct context:
+      #   context: ['foo', 'bar'], values: ['baz', 'bat']
+      #   ---> values: ['foo bar baz', 'foo bar bat']
+      # However, there's a special case for 'no' commands:
+      #   context: ['foo', 'bar'], values: ['no baz']
+      #   ---> values: ['no foo bar baz'] ---- the 'no' goes at the start
+      context = context.join(' ')
+      unless context.empty?
+        values.map! do |cmd|
+          match = cmd[/^\s*no\s+(.*)/, 1]
+          if match
+            cmd = "no #{context} #{match}"
+          else
+            cmd = "#{context} #{cmd}"
+          end
+          cmd
         end
-        cmd
       end
+      # CliConfigArgs wants a newline-separated string of commands
+      args = CliConfigArgs.new(cli: values.join("\n"))
+      req(@config, 'cli_config', args)
     end
-    # CliConfigArgs wants a newline-separated string of commands
-    args = CliConfigArgs.new(cli: values.join("\n"))
-    req(@config, 'cli_config', args)
   end
 
   def get(data_format: :cli,
           command:     nil,
           context:     nil,
-          value:       nil)
+          value:       nil,
+          **kwargs)
     super
     fail ArgumentError if command.nil?
-    args = ShowCmdArgs.new(cli: command)
-    output = req(@exec, 'show_cmd_text_output', args)
-    self.class.filter_cli(cli_output: output, context: context, value: value)
+
+    if data_format == :yang_json
+      mode = kwargs[:mode] || :get_config
+      yang_req(@config, mode, ConfigGetArgs.new(yangpathjson: command))
+    else
+      args = ShowCmdArgs.new(cli: command)
+      output = req(@exec, 'show_cmd_text_output', args)
+      self.class.filter_cli(cli_output: output, context: context, value: value)
+    end
   end
 
   def req(stub, type, args)
@@ -170,6 +188,51 @@ class Cisco::Client::GRPC < Cisco::Client
     end
   end
 
+  # Send a YANG request via gRPC
+  def yang_req(stub, type, args)
+    debug "Sending '#{type}' request:"
+    if args.is_a?(ConfigGetArgs)
+      debug "  with yangpathjson: #{args.yangpathjson}"
+    elsif args.is_a?(ConfigArgs)
+      debug " with yangjson: #{args.yangjson}"
+    end
+
+    output = Cisco::Client.silence_warnings do
+      response = stub.send(type, args,
+                           timeout:  @timeout,
+                           username: @username,
+                           password: @password)
+      # gRPC server may split the response into multiples
+      response = response.is_a?(Enumerator) ? response.to_a : [response]
+      debug "Got responses: #{response.map(&:class).join(', ')}"
+      debug "response: #{response}"
+      # Check for errors first
+      handle_errors(args, response.select { |r| !r.errors.empty? })
+
+      # If we got here, no errors occurred
+      handle_response(args, response)
+    end
+    return output
+
+  rescue ::GRPC::BadStatus => e
+    warn "gRPC error '#{e.code}' during '#{type}' request: "
+    if args.is_a?(ConfigGetArgs)
+      debug "  with yangpathjson: #{args.yangpathjson}"
+    elsif args.is_a?(ConfigArgs)
+      debug " with yangjson: #{args.yangjson}"
+    end
+
+    warn "  '#{e.details}'"
+    case e.code
+    when ::GRPC::Core::StatusCodes::UNAVAILABLE
+      raise Cisco::ConnectionRefused, "Connection refused: #{e.details}"
+    when ::GRPC::Core::StatusCodes::UNAUTHENTICATED
+      raise Cisco::AuthenticationFailed, e.details
+    else
+      raise Cisco::ClientError, e.details
+    end
+  end
+
   def handle_response(args, replies)
     klass = replies[0].class
     unless replies.all? { |r| r.class == klass }
@@ -189,6 +252,15 @@ class Cisco::Client::GRPC < Cisco::Client
     when /CliConfigReply/
       # nothing to process
       output = ''
+    when /ConfigGetReply/
+      replies.each { |r| debug "  yangjson:\n#{r.yangjson}" }
+      output = replies.map(&:yangjson).join('')
+    when /GetOperReply/
+      replies.each { |r| debug "  yangjson:\n#{r.yangjson}" }
+      output = replies.map(&:yangjson).join('')
+    when /ConfigReply/
+      # nothing to process
+      output = ''
     else
       fail Cisco::ClientError, "unsupported reply class #{klass}"
     end
@@ -242,6 +314,11 @@ class Cisco::Client::GRPC < Cisco::Client
   def handle_text_error(args, msg)
     if /^Disallowed commands:/ =~ msg
       fail Cisco::RequestNotSupported, msg
+    elsif args.is_a?(ConfigGetArgs) || args.is_a?(ConfigArgs)
+      fail Cisco::YangError.new( # rubocop:disable Style/RaiseArgs
+        rejected_input: args.yangpathjson,
+        error:          msg,
+      )
     else
       fail Cisco::CliError.new( # rubocop:disable Style/RaiseArgs
         rejected_input: args.cli,
@@ -277,7 +354,8 @@ class Cisco::Client::GRPC < Cisco::Client
     msg = msg['error'] unless msg.is_a?(Array)
     msg.each do |m|
       type = m['error-type']
-      message = m['error-message']
+      message = m['error-message'] || m['error-tag']
+      message += ': ' + m['error-path'] if m['error-path']
       if type == 'protocol' && message == 'Failed authentication'
         fail Cisco::AuthenticationFailed, message
       elsif type == 'application'
@@ -293,16 +371,22 @@ class Cisco::Client::GRPC < Cisco::Client
         # foo
         # bar
         #
-        match = /\n\n(.*)\n\n\Z/m.match(message)
-        if match.nil?
-          rejected = '(unknown, see error message)'
+        if m['error-path']
+          fail Cisco::YangError.new( # rubocop:disable Style/RaiseArgs
+            message
+          )
         else
-          rejected = match[1].split("\n")
+          match = /\n\n(.*)\n\n\Z/m.match(message)
+          if match.nil?
+            rejected = '(unknown, see error message)'
+          else
+            rejected = match[1].split("\n")
+          end
+          fail Cisco::CliError.new( # rubocop:disable Style/RaiseArgs
+            rejected_input: rejected,
+            clierror:       message,
+          )
         end
-        fail Cisco::CliError.new( # rubocop:disable Style/RaiseArgs
-          rejected_input: rejected,
-          clierror:       message,
-        )
       else
         fail Cisco::ClientError, message
       end

data/lib/cisco_node_utils/client/nxapi/client.rb

@@ -105,9 +105,11 @@ class Cisco::Client::NXAPI < Cisco::Client
   #   used to enter the desired CLI sub-mode
   # @param values [String, Array<String>] One or more commands
   #   to enter within the CLI sub-mode.
+  # @param kwargs data-format-specific args
   def set(data_format: :cli,
           context: nil,
-          values: nil)
+          values: nil,
+          **_kwargs)
     # we don't currently support nxapi_structured for configuration
     fail Cisco::RequestNotSupported if data_format == :nxapi_structured
     context = munge_to_array(context)
@@ -130,11 +132,13 @@ class Cisco::Client::NXAPI < Cisco::Client
   # @param command [String] the show command to execute
   # @param context [String, Array<String>] Context to refine the results
   # @param value [String] Specific key to look up
+  # @param kwargs data-format-specific args
   # @return [String, Hash]
   def get(data_format: :cli,
           command:     nil,
           context:     nil,
-          value:       nil)
+          value:       nil,
+          **_kwargs)
     context = munge_to_array(context)
     super
     if data_format == :cli

data/lib/cisco_node_utils/cmd_ref/DEPRECATED.yaml

@@ -0,0 +1,118 @@
+# DEPRECATED
+#
+###############################################################################
+# WARNING. DO NOT USE ANY OF THE YAML TAGS IN THIS FILE.
+# These yaml tags are deprecated and will be removed in future releases.
+###############################################################################
+---
+_template:
+  context: ["interface <name>"]
+  nexus:
+    get_command: "show running interface all"
+
+private_vlan_any:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_any'
+  multiple:
+  get_value: '/switchport private-vlan/'
+
+private_vlan_association:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_association'
+  _exclude: [N8k]
+  multiple: true
+  get_command: "show vlan private-vlan"
+  get_context: ~
+  get_value: '/^<id>\s+(\d+)/'
+  set_context: ['vlan <vlan>']
+  set_value: "<state> private-vlan association <vlans> ; end"
+  default_value: []
+
+private_vlan_mapping:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_mapping'
+  _exclude: [ios_xr, N8k]
+  multiple: true
+  get_value: '/^private-vlan mapping (.*)$/'
+  set_value: "<state> private-vlan mapping <vlans>"
+  default_value: []
+
+private_vlan_type:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_type'
+  _exclude: [N8k]
+  kind: string
+  get_command: 'show vlan private-vlan type'
+  get_context: ~
+  get_value: '/^<id>\s+(\S+)/'
+  set_context: ['vlan <vlan>']
+  set_value: "<state> private-vlan <type> ; end"
+  default_value: ""
+
+switchport_mode_private_vlan_host:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_host'
+  _exclude: [ios_xr, N8k]
+  get_value: '/^switchport mode private-vlan (.*)$/'
+  set_value: "<state> switchport mode private-vlan <mode>"
+  default_value: :disabled
+
+switchport_mode_private_vlan_host_association:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_host_association'
+  _exclude: [ios_xr, N8k]
+  multiple: true
+  get_value: '/^switchport private-vlan host-association (.*)$/'
+  set_value: "<state> switchport private-vlan host-association <vlan_pr> <vlan_sec>"
+  default_value: []
+
+switchport_mode_private_vlan_host_promiscous:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_promiscuous'
+  _exclude: [ios_xr, N8k]
+  multiple: true
+  get_value: '/^switchport private-vlan mapping (\d+.*)$/'
+  set_value: "<state> switchport private-vlan mapping <vlan_pr> <vlans>"
+  default_value: []
+
+switchport_mode_private_vlan_trunk_promiscuous:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_promiscuous'
+  _exclude: [ios_xr, N3k, N8k]
+  kind: boolean
+  get_value: '/^switchport mode private-vlan trunk promiscuous$/'
+  set_value: "<state> switchport mode private-vlan trunk promiscuous"
+  default_value: false
+
+switchport_mode_private_vlan_trunk_secondary:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_secondary'
+  _exclude: [ios_xr, N3k, N8k]
+  kind: boolean
+  get_value: '/^switchport mode private-vlan trunk secondary$/'
+  set_value: "<state> switchport mode private-vlan trunk secondary"
+  default_value: false
+
+switchport_private_vlan_association_trunk:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_association'
+  _exclude: [ios_xr, N3k, N8k]
+  multiple: true
+  #get_value: '/^switchport private-vlan association trunk (.*) (.*)$/'
+  get_value: '/^switchport private-vlan association trunk (.*)$/'
+  set_value: "<state> switchport private-vlan association trunk <vlan_pr> <vlan>"
+  default_value: []
+
+switchport_private_vlan_mapping_trunk:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_mapping_trunk'
+  _exclude: [ios_xr, N3k, N8k]
+  multiple: true
+  get_value: '/^switchport private-vlan mapping trunk (.*)$/'
+  set_value: "<state> switchport private-vlan mapping trunk <vlan_pr> <vlans>"
+  default_value: []
+
+switchport_private_vlan_trunk_allowed_vlan:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_allowed_vlan'
+  _exclude: [ios_xr, N8k]
+  multiple: true
+  get_value: '/^switchport private-vlan trunk allowed vlan (.*)$/'
+  set_value: "<state> switchport private-vlan trunk allowed vlan <oper> <vlans>"
+  default_value: []
+
+switchport_private_vlan_trunk_native_vlan:
+  # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_native_vlan'
+  _exclude: [ios_xr, N8k]
+  kind: int
+  get_value: '/^switchport private-vlan trunk native vlan (.*)$/'
+  set_value: "<state> switchport private-vlan trunk native vlan <vlan>"
+  default_value: 1