Merge pull request #227 from cisco/release_1.2.0

Release 1.2.0

Author: chrisvanheuveln

.gitignore

@@ -3,4 +3,5 @@ pkg/*
 vendor/*
 coverage
 Gemfile.lock
-*.gem
+*.gem
+*.swp

CHANGELOG.md

@@ -1,6 +1,126 @@
 Changelog
 =========
 
+## [v1.2.0]
+
+### New feature support
+* ACL (platforms: Nexus 3k and Nexus 9k)
+  * acl (@saqibraza)
+  * ace (@yjyongz)
+  * remark ace (@bansalpradeep)
+* EVPN (platforms: Nexus 3k and Nexus 9k)
+  * evpn_vni (@andish)
+* Fabric Path (platforms: Nexus 7k)
+  * fabricpath_global (@dcheriancisco)
+  * fabricpath_topology (@dcheriancisco)
+* Feature
+  * feature (@robert-w-gries)
+* Interface (platforms: Nexus 3k, Nexus 5k, Nexus 6k, Nexus 7k and Nexus 9k)
+  * interface_channel_group (@chrisvanheuveln)
+  * interface_portchannel (@saichint)
+  * interface_service_vni (@chrisvanheuveln)
+* PIM (platforms: Nexus 3k and Nexus 9k)
+  * pim (@smigopal)
+  * pim_group_list (@smigopal)
+  * pim_rp_address (@smigopal)
+* Port Channel (platforms: Nexus 3k, Nexus 5k, Nexus 6k, Nexus 7k and Nexus 9k)
+  * interface_channel_group (@chrisvanheuveln)
+  * interface_portchannel (@saichint)
+  * portchannel_global (@saichint)
+* SNMP (platforms: Nexus 3k, Nexus 5k, Nexus 6k, Nexus 7k and Nexus 9k)
+  * snmpnotification (@tphoney)
+* VDC (platforms: Nexus 7k)
+  * vdc (@chrisvanheuveln)
+* VPC (platforms: Nexus 3k, Nexus 5k, Nexus 6k, Nexus 7k and Nexus 9k)
+  * vpc (@dcheriancisco)
+* VRF (platforms: Nexus 3k, Nexus 5k, Nexus 6k, Nexus 7k and Nexus 9k)
+  * vrf_af (@chrisvanheuveln)
+* VXLAN (platforms: Nexus 9k)
+  * overlay_global (@alok-aggarwal)
+  * vxlan_vtep (@dcheriancisco)
+  * vxlan_vtep_vni (@mikewiebe)
+
+  
+### Additional platform support added to existing classes
+#### Cisco Nexus 56xx, 60xx and 7xxx
+* AAA
+  * aaa_authentication_login
+  * aaa_authentication_login_service
+  * aaa_authentication_service
+* BGP
+  * bgp
+  * bgp_af
+  * bgp_af_neighobr
+  * bgp_neighbor_af
+* COMMAND_CONFIG
+  * command_config (config_parser)
+* DOMAIN
+  * dns_domain
+  * domain_name
+  * name_server
+* INTERFACE
+  * interface
+* NTP
+  * ntp_config
+  * ntp_server
+* OSPF
+  * interface_ospf
+  * ospf
+  * ospf_vrf
+* RADIUS
+  * radius_global
+* SNMP
+  * snmp_community
+  * snmp_group
+  * snmp_notification_receiver
+  * snmp_server
+  * snmp_user
+* SYSLOG
+  * syslog_server
+  * syslog_setting
+* TACACS
+  * tacacs_server
+  * tacacs_server_group
+  * tacacs_server_host
+* VLAN
+  * vlan
+
+### Added
+
+* `Cisco::UnsupportedError` exception class, raised when a command is explicitly marked as unsupported on a particular class of nodes.
+* Extend bgp with attributes:
+  * `disable_policy_batching`, `disable_policy_batching_ipv4`, `disable_policy_batching_ipv6`
+  * `event_history_cli`, `event_history_detail`, `event_history_events`, `event_history_periodic`
+  * `fast_external_fallover`
+  * `flush_routes`
+  * `isolate`
+  * `neighbor_down_fib_accelerate`
+  * `route_distinguisher`
+* Extend bgp_af with attributes:
+  * `default_metric`
+  * `distance_ebgp`, `distance_ibgp`, `distance_local`
+  * `inject_map`
+  * `suppress_inactive`
+  * `table_map`
+* Extend interface with attributes:
+  * `fabric_forwarding_anycast_gateway`
+  * `ipv4_acl_in`, `ipv4_acl_out`, `ipv6_acl_in`, `ipv6_acl_out`
+  * `ipv4_address_secondary`, `ipv4_arp_timeout`
+  * `vlan_mapping`
+  * `vpc_id`, `vpc_peer_link`
+  * switchport mode `fabricpath`
+* Extend vrf with attributes:
+  * `vni`
+* Extend vlan with attribute:
+  * `mode`
+
+### Changed
+
+* Major refactor and enhancement of `CommandReference` YAML files:
+  - Added support for `auto_default`, `default_only`, `kind`, and `multiple`
+  - Added filtering by product ID (`/N7K/`) and by client type (`cli_nexus`)
+  - `CommandReference` methods that do key-value style wildcard substitution now raise an `ArgumentError` if the result is empty (because not enough parameters were supplied). 
+
 ## [v1.1.0]
 
 ### New feature support
@@ -15,10 +135,12 @@ Changelog
 * RADIUS
   * radius_global (@jonnytpuppet)
   * radius_server (@jonnytpuppet)
+* SNMP
+  * snmp_notification_receiver (@jonnytpuppet)
 * SYSLOG
   * syslog_server (@jonnytpuppet)
   * syslog_setting (@jonnytpuppet)
-* Miscellaneous 
+* Miscellaneous
   * dns_domain (@hunner)
   * domain_name (@bmjen)
   * name_server (@hunner)
@@ -43,6 +165,8 @@ Changelog
   * Added `config` and `(assert|refute)_show_match` helper methods for testing.
 * Added `bin/check_metric_limits.rb` helper script in support of refactoring.
 * Added best practices development guide.
+* Added support for radius_global (@jonnytpuppet)
+* Added support for radius_server_group (@jonnytpuppet)
 
 ### Fixed
 
@@ -92,6 +216,7 @@ Changelog
 [git-flow]: https://github.com/petervanderdoes/gitflow-avh
 [SimpleCov]: https://github.com/colszowka/simplecov
 
+[v1.2.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.1.0...v1.2.0
 [v1.1.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.0.1...v1.1.0
 [v1.0.1]: https://github.com/cisco/cisco-network-node-utils/compare/v1.0.0...v1.0.1
 [v1.0.0]: https://github.com/cisco/cisco-network-node-utils/compare/v0.9.0...v1.0.0

README.md

@@ -35,10 +35,23 @@ Please see [Learning Resources](#resources) for additional references.
 
 The CiscoNodeUtils gem provides utilities for management of Cisco network
 nodes. It is designed to work with Puppet and Chef as well as other
-open source management tools. This release supports Cisco NX-OS nodes
-running NX-OS 7.0(3)I2(1) and later.
+open source management tools.
 
-Please note: A virtual Nexus N9000/N3000 may be helpful for development and testing. Users with a valid [cisco.com](http://cisco.com) user ID can obtain a copy of a virtual Nexus N9000/N3000 by sending their [cisco.com](http://cisco.com) user ID in an email to <[email protected]>. If you do not have a [cisco.com](http://cisco.com) user ID please register for one at [https://tools.cisco.com/IDREG/guestRegistration](https://tools.cisco.com/IDREG/guestRegistration)
+This CiscoNodeUtils gem release supports the following:
+
+Platform         | OS    | OS Version           |
+-----------------|-------|----------------------|
+Cisco Nexus 30xx | NX-OS | 7.0(3)I2(1) and later
+Cisco Nexus 31xx | NX-OS | 7.0(3)I2(1) and later
+Cisco Nexus 93xx | NX-OS | 7.0(3)I2(1) and later
+Cisco Nexus 95xx | NX-OS | 7.0(3)I2(1) and later
+Cisco N9kv       | NX-OS | 7.0(3)I2(1) and later
+Cisco Nexus 56xx | NX-OS | 7.3(0)N1(1) and later
+Cisco Nexus 60xx | NX-OS | 7.3(0)N1(1) and later
+Cisco Nexus 7xxx | NX-OS | 7.3(0)D1(1) and later
+
+
+Please note: For Cisco Nexus 3k and 9k platforms, a virtual Nexus N9000/N3000 may be helpful for development and testing. Users with a valid [cisco.com](http://cisco.com) user ID can obtain a copy of a virtual Nexus N9000/N3000 by sending their [cisco.com](http://cisco.com) user ID in an email to <[email protected]>. If you do not have a [cisco.com](http://cisco.com) user ID please register for one at [https://tools.cisco.com/IDREG/guestRegistration](https://tools.cisco.com/IDREG/guestRegistration)
 
 ## <a name="installation">Installation</a>
 
@@ -97,15 +110,9 @@ network node. It provides the base APIs `config_set`, `config_get`, and
 
 ### CommandReference
 
-The `CommandReference` module provides for the abstraction of NX-OS CLI,
-especially to handle its variance between hardware platforms.
-A series of YAML files are used to describe the CLI corresponding to a given
-`(feature, attribute)` tuple for any given platform. When a `Node` is
-connected, the platform identification of the Node is used to construct a
-`CmdRef` object that corresponds to this platform. The `Node` APIs
-`config_set`, `config_get`, and `config_get_default` all rely on the `CmdRef`.
+The `CommandReference` class abstracts away the differences between various supported `Node` types, be that API differences (CLI vs. YANG), platform differences (NX-OS vs. IOS XR), or hardware differences (Nexus 9xxx vs. Nexus 3xxx). A series of YAML files describe various `feature` groupings. Each file describes a set of `attributes` of the given feature and the specifics of how to inspect and manage these attributes for any supported `Node` types.  When a `Node` is connected, the platform identification of the Node is used to construct a `CommandReference` instance containing a set of `CmdRef` objects specific to this `Node`. The `Node` APIs `config_set`, `config_get`, and `config_get_default` all rely on the `CmdRef`.
 
-See also [README_YAML](lib/cisco_node_utils/README_YAML.md).
+See also [README_YAML](lib/cisco_node_utils/cmd_ref/README_YAML.md).
 
 ### Feature Providers
 
@@ -161,7 +168,7 @@ See [CHANGELOG](CHANGELOG.md) for a list of changes.
 ## <a name="license_info">License Information</a>
 
 
-Copyright (c) 2013-2015 Cisco and/or its affiliates.
+Copyright (c) 2013-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.

Rakefile

@@ -18,4 +18,5 @@ Rake::TestTask.new do |t|
   t.pattern = 'tests/test_*.rb'
   t.warning = true
   t.verbose = true
+  t.options = '-v'
 end

bin/git/hooks/commit-msg/enforce_style

@@ -76,6 +76,14 @@ if $errors > 0 # rubocop:disable Style/GlobalVars
   puts '{'
   puts message_lines.join("\n")
   puts '}'
+
+  fd = IO.sysopen('/dev/tty', 'w+')
+  a = IO.new(fd, 'w+')
+  a.puts 'Continue anyway? [y/N] '
+  response = a.gets.chomp
+  # rubocop:disable Style/GlobalVars
+  $errors = 0 if response.downcase[0] == 'y'
+  # rubocop:enable Style/GlobalVars
 end
 
 exit $errors # rubocop:disable Style/GlobalVars

cisco_node_utils.gemspec

@@ -7,7 +7,8 @@ Gem::Specification.new do |spec|
   spec.name          = 'cisco_node_utils'
   spec.version       = CiscoNodeUtils::VERSION
   spec.authors       = ['Alex Hunsberger', 'Glenn Matthews',
-                        'Chris Van Heuveln', 'Mike Wiebe', 'Jie Yang']
+                        'Chris Van Heuveln', 'Mike Wiebe', 'Jie Yang',
+                        'Rob Gries']
   spec.email         = '[email protected]'
   spec.summary       = 'Utilities for management of Cisco network nodes'
   spec.description   = <<-EOF
@@ -30,7 +31,7 @@ Currently supports NX-OS nodes.
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '= 0.34.2'
+  spec.add_development_dependency 'rubocop', '= 0.35.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
-  spec.add_runtime_dependency 'cisco_nxapi', '~> 1.0'
+  spec.add_runtime_dependency 'cisco_nxapi', '~> 1.0', '>= 1.0.1'
 end