Skip to content

Commit

Permalink
Merge pull request saltstack#40302 from cloudflare/nitorgen-doc
Browse files Browse the repository at this point in the history
Add NAPALM section in Nitrogen release notes
  • Loading branch information
Nicole Thomas authored Mar 28, 2017
2 parents 75565df + 15808b0 commit 863a9b9
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions doc/topics/releases/nitrogen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,56 @@ release cycle (two major releases after this one), those who are using the
:ref:`netapi module <all-netapi-modules>`) are encouraged to update their code
to use ``tgt_type``.


Network Automation
==================

NAPALM
------

Introduced in 2016.11, the modules for cross-vendor network automation
have been improved, enhanced and widenened in scope:

- Manage network devices like servers: the NAPALM modules have been transformed
so they can run in both proxy and regular minions. That means, if the
operating system allows, the salt-minion package can be installed directly
on the network gear. Examples of such devices (also covered by NAPALM)
include: Arista, Cumulus, Cisco IOS-XR or Cisco Nexus.
- Not always alive: in certain less dynamic environments,
maintaining the remote connection permanently open with the network device
is not always beneficial. In those particular cases, the user can select
to initialize the connection only when needed, by specifying the field
``always_alive: false`` in the :mod:`proxy configuration <salt.proxy.napalm>`
or using the :conf_proxy:`proxy_always_alive` option.
- Proxy keepalive: due to external factors, the connection with the remote
device can be dropped, e.g.: packet loss, idle time (no commands issued
within a couple of minutes or seconds), or simply the device decides to kill
the process. In Nitrogen we have introduced the functionality to re-establish
the connection. One can disable feature this feature through the
:conf_proxy:`proxy_keep_alive` option and adjust the polling frequency
speciying a custom value for :conf_proxy:`proxy_keep_alive_interval`,
in minutes.

New modules:

- :mod:`Netconfig state <salt.states.netconfig>` - Manage the configuration
of network devices using arbitrary templates and the Salt-specific
advanced templating methodologies.
- :mod:`Network ACL execution module <salt.modules.napalm_acl>` - Generate and
load ACL (firewall) configuration on network devices.
- :mod:`Network ACL state <salt.states.netacl>` - Manage the firewall
configuration. It only requires writing the pillar structure correctly!
- :mod:`NET finder <salt.runners.net>` - Runner to find details easily and
fast. It's smart enough to know what you are looking for. It will search
in the details of the network interfaces, IP addresses, MAC address tables,
ARP tables and LLDP neighbors.
- :mod:`BGP finder <salt.runners.bgp>` - Runner to search BGP neighbors details.

New grains: :mod:`Host <salt.grains.napalm.host>`,
:mod:`Username <salt.grains.napalm.username>` and
:mod:`Optional args <salt.grains.napalm.optional_args>`.


Custom Refspecs in GitFS / git_pillar / winrepo
===============================================

Expand Down

0 comments on commit 863a9b9

Please sign in to comment.