<commit_before># CiscoNodeUtils - Cisco Node Utilities

[![Gem Version](https://badge.fury.io/rb/cisco_node_utils.svg)](http://badge.fury.io/rb/cisco_node_utils)
[![Build Status](https://travis-ci.org/cisco/cisco-network-node-utils.svg?branch=develop)](https://travis-ci.org/cisco/cisco-network-node-utils)

--
##### Documentation Workflow Map

This workflow map aids *users*, *developers* and *maintainers* of the CiscoNodeUtils project in selecting the appropriate document(s) for their task.

* User Guides - the remainder of this document is aimed at end users
* Developer Guides
  * [CONTRIBUTING.md](CONTRIBUTING.md) : Contribution guidelines
  * [README-develop-node-utils-APIs.md](docs/README-develop-node-utils-APIs.md) : Developing new CiscoNodeUtils APIs
  * [README-develop-best-practices.md](docs/README-develop-best-practices.md) : Development best practices
* Maintainers Guides
  * [README-maintainers.md](docs/README-maintainers.md) : Guidelines for core maintainers of the CiscoNodeUtils project
  * All developer guides apply to maintainers as well

Please see [Learning Resources](#resources) for additional references.

--
#### Table of Contents

1. [Overview](#overview)
2. [Installation](#installation)
3. [Examples](#examples)
4. [Documentation](#documentation)
5. [Changelog](#changelog)
6. [Learning Resources](#resources)
7. [License Information](#license_info)


## <a name="overview">Overview</a>

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 the following Cisco NX-OS platforms
and releases.

Platform | Release |
---------| --------|
Cisco Nexus 30xx | OS Version 7.0(3)I2(1) and later
Cisco Nexus 31xx | OS Version 7.0(3)I2(1) and later
Cisco Nexus 93xx | OS Version 7.0(3)I2(1) and later
Cisco Nexus 95xx | OS Version 7.0(3)I2(1) and later
Cisco Nexus 56xx | OS Version 7.3(0)N1(1) and later
Cisco Nexus 60xx | OS Version 7.3(0)N1(1) and later
Cisco Nexus 70xx | OS Version 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>>. 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>

To install the CiscoNodeUtils, use the following command:

    $ gem install cisco_node_utils

(Add `sudo` if you're installing under a POSIX system as root)

Alternatively, if you've checked the source out directly, you can call
`rake install` from the root project directory.

## <a name="examples">Examples</a>


These utilities can be used directly on a Cisco device (as used by Puppet
and Chef) or can run on a workstation and point to a Cisco device (as used
by the included minitest suite).
<commit_msg>Refactored support table<commit_after># CiscoNodeUtils - Cisco Node Utilities

[![Gem Version](https://badge.fury.io/rb/cisco_node_utils.svg)](http://badge.fury.io/rb/cisco_node_utils)
[![Build Status](https://travis-ci.org/cisco/cisco-network-node-utils.svg?branch=develop)](https://travis-ci.org/cisco/cisco-network-node-utils)

--
##### Documentation Workflow Map

This workflow map aids *users*, *developers* and *maintainers* of the CiscoNodeUtils project in selecting the appropriate document(s) for their task.

* User Guides - the remainder of this document is aimed at end users
* Developer Guides
  * [CONTRIBUTING.md](CONTRIBUTING.md) : Contribution guidelines
  * [README-develop-node-utils-APIs.md](docs/README-develop-node-utils-APIs.md) : Developing new CiscoNodeUtils APIs
  * [README-develop-best-practices.md](docs/README-develop-best-practices.md) : Development best practices
* Maintainers Guides
  * [README-maintainers.md](docs/README-maintainers.md) : Guidelines for core maintainers of the CiscoNodeUtils project
  * All developer guides apply to maintainers as well

Please see [Learning Resources](#resources) for additional references.

--
#### Table of Contents

1. [Overview](#overview)
2. [Installation](#installation)
3. [Examples](#examples)
4. [Documentation](#documentation)
5. [Changelog](#changelog)
6. [Learning Resources](#resources)
7. [License Information](#license_info)


## <a name="overview">Overview</a>

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 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 70xx | 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>>. 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>

To install the CiscoNodeUtils, use the following command:

    $ gem install cisco_node_utils

(Add `sudo` if you're installing under a POSIX system as root)

Alternatively, if you've checked the source out directly, you can call
`rake install` from the root project directory.

## <a name="examples">Examples</a>


These utilities can be used directly on a Cisco device (as used by Puppet
and Chef) or can run on a workstation and point to a Cisco device (as used
by the included minitest suite).

{'fraction_non_alphanumeric': 0.11904005085823267, 'fraction_numerical': 0.024475524475524476, 'mean_word_length': 4.638888888888889, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4679086', 'n_tokens_mistral': 2201, 'n_tokens_neox': 1971, 'n_words': 684}