cisco_node_utils 1.6.0 → 1.7.0

data/lib/cisco_node_utils/cmd_ref/route_map.yaml

@@ -207,12 +207,14 @@ match_mac_list:
   default_value: []
 
 match_metric:
+  os_version: 'N9k-F:7.0.3.F2.1'
   get_value: '/^match metric (.*)$/'
   set_value: "<state> match metric <metric>"
   default_value: []
 
 match_ospf_area:
   _exclude: [N5k, N6k, N7k, N9k-F]
+  os_version: 'N3k, N9k:7.0.3.I5.1'
   get_value: '/^match ospf-area (.*)$/'
   set_value: "<state> match ospf-area <area>"
   default_value: []
@@ -303,6 +305,7 @@ set_comm_list:
   default_value: false
 
 set_community:
+  os_version: 'N9k:7.0.3.I5.1'
   get_value: '/^set community(?:\s+.*)?$/'
   set_value: "<state> set community <string>"
 
@@ -363,6 +366,7 @@ set_extcomm_list:
   default_value: false
 
 set_extcommunity_4bytes:
+  os_version: 'N9k-F:7.0.3.F2.1'
   get_value: '/^set extcommunity 4byteas-generic (.*)$/'
   set_value: "<state> set extcommunity 4byteas-generic <string>"
 
@@ -438,6 +442,7 @@ set_ipv4_next_hop:
 
 set_ipv4_next_hop_load_share:
   _exclude: [N5k, N6k]
+  os_version: 'N9k-F:7.0.3.F2.1; N9k:7.0.3.I5.1'
   default_value: false
 
 set_ipv4_next_hop_peer_addr:
@@ -448,6 +453,7 @@ set_ipv4_next_hop_peer_addr:
 
 set_ipv4_next_hop_redist:
   kind: boolean
+  os_version: 'N3k, N9k:7.0.3.I5.1'
   get_value: '/^set ip next-hop redist-unchanged$/'
   set_value: "<state> set ip next-hop redist-unchanged"
   default_value: false
@@ -487,6 +493,7 @@ set_ipv6_next_hop:
 
 set_ipv6_next_hop_load_share:
   _exclude: [N5k, N6k]
+  os_version: 'N9k-F:7.0.3.F2.1; N9k:7.0.3.I5.1'
   default_value: false
 
 set_ipv6_next_hop_peer_addr:
@@ -497,6 +504,7 @@ set_ipv6_next_hop_peer_addr:
 
 set_ipv6_next_hop_redist:
   kind: boolean
+  os_version: 'N3k, N9k:7.0.3.I5.1'
   get_value: '/^set ipv6 next-hop redist-unchanged$/'
   set_value: "<state> set ipv6 next-hop redist-unchanged"
   default_value: false

data/lib/cisco_node_utils/cmd_ref/span_session.yaml

@@ -0,0 +1,65 @@
+# SPAN session
+---
+_exclude: [N5k, N6k, N7k]
+
+_template:
+  get_command: "show running monitor all"
+  get_context: ["monitor session <id>(?: .*)?"]
+  set_context: ["monitor session <id>"]
+
+all_sessions:
+  multiple:
+  get_context: ~
+  get_value: '/^monitor session (\d+)/'
+
+create:
+  set_context: ~
+  set_value: 'monitor session <id>'
+
+description:
+  kind: string
+  get_value: '/^description (.*)/'
+  set_value: '<state> description <description>'
+  default_value: ''
+
+destination:
+  kind: string
+  get_value: '/^destination interface (\S+)$/'
+  set_value: '<state> destination interface <intf_name>'
+
+destroy:
+  set_context: ~
+  set_value: 'no monitor session <id>'
+
+session_id:
+  kind: int
+  default_value: false
+  get_context: ~
+  get_value: '/^monitor session (\d+)/'
+  set_context: ~
+  set_value: '<state> monitor session <id> <type> <val>'
+
+shutdown:
+  kind: boolean
+  default_value: true
+  get_value: '/^no shut$/'
+  set_value: '<state> shut'
+
+source_interfaces:
+  multiple:
+  get_value: '/^source interface (\S+) (\w+)$/'
+  set_value: '<state> source interface <int_name> <direction>'
+  default_value: []
+
+source_vlans:
+  get_value: '/^source vlan (\S+) (\w+)$/'
+  set_value: '<state> source vlan <vlans> <direction>'
+  default_value: []
+
+type:
+  kind: string
+  default_value: 'local'
+  get_context: ~
+  get_value: '/^monitor session \d+ type (\S+)$/'
+  set_context: ~
+  set_value: 'monitor session <id> type <type>'

data/lib/cisco_node_utils/cmd_ref/stp_global.yaml

@@ -78,7 +78,8 @@ bridge_assurance:
   default_value: true
 
 domain:
-  _exclude: [N3k, N9k-F, N9k]
+  _exclude: [N9k-F]
+  os_version: 'N3k, N9k:7.0.3.I6.1'
   kind: int
   get_value: '/^spanning-tree domain (\d+)$/'
   set_value: "<state> spanning-tree domain <domain>"

data/lib/cisco_node_utils/cmd_ref/vpc.yaml

@@ -7,6 +7,12 @@ _template:
   get_context:  ['/^vpc domain\s*(\d+)$/']
   set_context:  ['vpc domain <domain>']
 
+arp_synchronize:
+  kind: boolean
+  default_value: false
+  get_value: '/^ip arp synchronize/'
+  set_value: "<state> ip arp synchronize"
+
 auto_recovery:
   kind: boolean
   _exclude: [N5k, N6k]
@@ -89,12 +95,19 @@ graceful_consistency_check:
   default_value: true
 
 layer3_peer_routing:
+  os_version: 'N3k, N9k:7.0.3.I6.1'
   kind: boolean
-  _exclude: [N3k, N9k-F, N9k]
   get_value: '/^layer3 peer-router$/'
   set_value: "<state> layer3 peer-router"
   default_value: false
 
+nd_synchronize:
+  kind: boolean
+  set_context:  ['terminal dont-ask', 'vpc domain <domain>']
+  get_value: '/^ipv6 nd synchronize/'
+  set_value: "<state> ipv6 nd synchronize"
+  default_value: false
+
 peer_gateway:
   kind: boolean
   set_context:  ['terminal dont-ask', 'vpc domain <domain>']
@@ -160,6 +173,13 @@ peer_keepalive_vrf:
   get_value:  '/^peer-keepalive .*vrf (\S+)/'
   default_value: 'management'
 
+peer_switch:
+  kind: boolean
+  set_context:  ['terminal dont-ask', 'vpc domain <domain>']
+  get_value: '/^peer-switch/'
+  set_value: "<state> peer-switch"
+  default_value: false
+
 phy_port_vpc_module_pids:
   _exclude: [N3k, N5k, N6k, N9k-F, N9k]
   default_only: 'N7[K7]-(?:F2|F3|F4|M3)'
@@ -186,8 +206,8 @@ self_isolation:
   default_value: false
 
 shutdown:
+  os_version: 'N3k, N9k:7.0.3.I6.1'
   kind: boolean
-  _exclude: [N3k, N9k-F, N9k]
   get_value: '/^shutdown/'
   set_value: "<state> shutdown"
   default_value: false
@@ -211,4 +231,3 @@ track:
   get_value: '/^track\s+(\d+)/'
   set_value: "<state> track <val>"
   default_value: 0
-

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep.yaml

@@ -50,7 +50,8 @@ source_intf:
   default_value: ''
 
 source_intf_hold_down_time:
-  _exclude: [N5k, N6k, N7k]
+  _exclude: [N5k, N6k]
+  os_version: 'N7k:8.1.1'
   kind: int
   get_value: '/^source-interface hold-down-time (\d+)$/'
   set_value: '<state> source-interface hold-down-time <time>'

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep_vni.yaml

@@ -16,7 +16,8 @@ all_vnis:
   get_value: '/^member vni (\d+|\d+-\d+) ?(associate-vrf)?$/'
 
 ingress_replication:
-  _exclude: [N5k, N6k, N7k]
+  _exclude: [N5k, N6k]
+  os_version: 'N7k:8.1.1'
   kind: string
   get_value: '/^ingress-replication protocol (\S+)$/'
   set_value: '<state> ingress-replication protocol <protocol>'
@@ -28,7 +29,8 @@ multicast_group:
   default_value: ''
 
 peer_list:
-  _exclude: [N5k, N6k, N7k]
+  _exclude: [N5k, N6k]
+  os_version: 'N7k:8.1.1'
   multiple:
   get_context:
     - '/^interface <name>$/i'
@@ -49,7 +51,8 @@ suppress_arp:
   default_value: false
 
 suppress_uuc:
-  _exclude: [N7k, N9k-F, N9k]
+  _exclude: [N9k-F, N9k]
+  os_version: 'N7k:8.1.1'
   kind: boolean
   get_value: '/^suppress-unknown-unicast$/'
   set_value: '<state> suppress-unknown-unicast'

data/lib/cisco_node_utils/cmd_ref/yum.yaml

@@ -1,12 +1,26 @@
 # yum
 ---
-_exclude: [ios_xr]
+_exclude: [ios_xr, N5k, N6k, N7k]
+
+activate:
+  set_value: "install activate <pkg>"
+
+add:
+  set_value: "install add <pkg> <vrf>"
+
+commit:
+  set_value: "install commit <pkg>"
 
 deactivate:
-  set_value: "install deactivate %s"
+  set_value: "install deactivate <pkg>"
 
 install:
-  set_value: "install add %s %s activate"
+  set_value: "install add <pkg> <vrf> activate"
+
+pkg_name:
+  kind: string
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Name\s+:\s+(\S+)/i'
 
 query:
   multiple: true
@@ -14,11 +28,41 @@ query:
   # pass in the pkg name, retrieve version
   get_value: '/^%s\S*\s+(\S+)\s+(?:installed|@\S+)/'
 
+query_activated:
+  kind: boolean
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Patch\s+State\s+:\s+Active/i'
+
+query_added:
+  kind: boolean
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Name\s+:\s+\S+/i'
+
 query_all:
   multiple: true
   get_command: "show install packages"
   get_value: '/^(\S+)\s+(\S+)\s+(\S+)$/'
   default_value: []
 
+query_committed:
+  multiple: true
+  get_command: "show install committed"
+  get_value: '/<pkg>/'
+
+query_inactive:
+  kind: boolean
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Patch\s+State\s+:\s+Inactive/i'
+
+query_removed:
+  kind: boolean
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Name\s+:\s+\S+/i'
+
+query_state:
+  kind: string
+  get_command: "show install pkg-info <pkg>"
+  get_value: '/Patch\s+State\s+:\s+(\S+)/i'
+
 remove:
-  set_value: "install remove %s forced"
+  set_value: "install remove <pkg> forced"

data/lib/cisco_node_utils/command_reference.rb

@@ -19,7 +19,7 @@ module Cisco
   # Control a reference for an attribute.
   class CmdRef
     attr_reader :feature, :name, :hash
-    attr_reader :auto_default, :multiple, :kind, :default_only
+    attr_reader :auto_default, :multiple, :kind, :default_only, :os_version
     alias_method :auto_default?, :auto_default
     alias_method :default_only?, :default_only
     alias_method :multiple?, :multiple
@@ -28,7 +28,7 @@ module Cisco
               data_format context value
               get_data_format get_command get_context get_value
               set_data_format set_context set_value
-              auto_default multiple kind)
+              auto_default multiple kind os_version)
 
     def self.keys
       KEYS
@@ -48,6 +48,7 @@ module Cisco
       @default_only = false
       @multiple = false
       @kind = nil
+      @os_version = nil
 
       values_to_hash(values, file)
 
@@ -86,6 +87,8 @@ module Cisco
         when 'kind'
           fail "Unknown 'kind': '#{value}'" unless KINDS.include?(value)
           @kind = value.to_sym
+        when 'os_version'
+          @os_version = value
         else
           # default_value overrides default_only
           @default_only = false if key == 'default_value'

data/lib/cisco_node_utils/feature.rb

@@ -1,6 +1,6 @@
 # January 2016, Robert W Gries
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-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.
@@ -147,6 +147,19 @@ module Cisco
       return false
     end
 
+    def self.lacp_enable
+      return if lacp_enabled?
+      config_set('feature', 'lacp')
+    end
+
+    def self.lacp_enabled?
+      config_get('feature', 'lacp')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
     # ---------------------------
     def self.nv_overlay_enable
       # Note: vdc platforms restrict this feature to F3 or newer linecards

data/lib/cisco_node_utils/interface.rb

@@ -1988,5 +1988,18 @@ module Cisco
         end
       end
     end
+
+    def purge_config=(val)
+      return unless val
+      fail ArgumentError,
+           'purge_config is only supported on Ethernet interfaces' unless
+        @name[/ethernet/]
+      config_set('interface', 'purge_config', name: @name) if val
+    end
+
+    def purge_config
+      state = config_get('interface', 'purge_config', name: @name)
+      state.nil? ? true : false
+    end
   end  # Class
 end    # Module

data/lib/cisco_node_utils/interface_channel_group.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require_relative 'node_util'
+require_relative 'feature'
 
 # Add some interface-specific constants to the Cisco namespace
 module Cisco
@@ -60,39 +61,46 @@ module Cisco
     #                      PROPERTIES                      #
     ########################################################
 
-    def channel_group
-      config_get('interface_channel_group', 'channel_group', @get_args)
-    end
-
-    def channel_group=(group)
-      # 'force' is needed by NXOS to handle the case where a port-channel
-      # interface is created prior to the channel-group cli; in which case
-      # the properties of the port-channel interface will be different from
-      # the ethernet interface. 'force' is not needed if the port-channel is
-      # created as a result of the channel-group cli but since it does no
-      # harm we will use it every time.
-      # IOS XR simply ignores 'force'
-      if group
-        state = ''
-        force = 'force'
+    def channel_group_mode
+      match = config_get('interface_channel_group', 'channel_group', @get_args)
+      return match unless match
+      mode = match[1].nil? ? default_channel_group_mode : match[1]
+      mode
+    end
+
+    def channel_group_mode_set(group, mode=false)
+      cgroup = channel_group
+      set_args_keys(state: 'no', group: cgroup, force: '', mode: '', val: '')
+      config_set('interface_channel_group', 'channel_group', @set_args) if
+        cgroup
+      return unless group
+      mode = false if mode && mode.to_str == 'on'
+      if mode
+        Cisco::Feature.lacp_enable
+        set_args_keys(state: '', group: group, force: 'force',
+                      mode: 'mode', val: mode)
+        config_set('interface_channel_group', 'channel_group', @set_args)
       else
-        state = 'no'
-        group = force = ''
+        set_args_keys(state: '', group: group, force: 'force',
+                      mode: '', val: '')
+        config_set('interface_channel_group', 'channel_group', @set_args)
       end
-      config_set('interface_channel_group', 'channel_group',
-                 set_args_keys(state: state, group: group, force: force))
-    rescue Cisco::CliError => e
-      # Some XR platforms do not support channel-group configuration
-      # on some OS versions. Since this is an OS version difference and not
-      # a platform difference, we can't handle this in the YAML.
-      raise unless e.message[/the entered commands do not exist/]
-      raise Cisco::UnsupportedError.new('interface', 'channel_group')
+    end
+
+    def channel_group
+      match = config_get('interface_channel_group', 'channel_group', @get_args)
+      return match unless match
+      match[0].to_i
     end
 
     def default_channel_group
       config_get_default('interface_channel_group', 'channel_group')
     end
 
+    def default_channel_group_mode
+      config_get_default('interface_channel_group', 'channel_group_mode')
+    end
+
     # ----------------------------
     def description
       config_get('interface_channel_group', 'description', @get_args)