Skip to content

Commit

Permalink
Update nxos.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
dbarrosop committed Nov 24, 2015
1 parent 7f565a3 commit 42ead13
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/support/nxos.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
NXOS
----

Notes on configuration replacement
==================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



Config files aren't aren't normal config files but special "checkpoint" files.
That's because on NXOS the only way to replace a config without reboot is to rollback to a checkpoint (which could be a file).
Expand All @@ -8,7 +13,7 @@ The ``!#`` part isn't necessary for the rollback to work, but leaving these line
See the "Known gotchas" section below.

Prerequisites
-------------
_____________

Your device must be running NXOS 6.1. The features ``nxapi`` server ``scp-server`` must be enabled.
On the device and any checkpoint file you push, you must have the lines::
Expand All @@ -17,14 +22,14 @@ On the device and any checkpoint file you push, you must have the lines::


Getting a base checkpoint file
------------------------------
______________________________

An example of a checkpoint file can be seen in ``test/unit/nxos/new_good.conf``.
You can get a checkpoint file representing your device's current config by running the ``get_checkpoint_file()``
function in the ``napalm.nxos`` driver.

Known gotchas
------------------------------
_____________

- Leaving out a ``shutdown`` or ``no shutdown`` line will cause the switch to toggle the up/down state of an interface, depending on it's current state.

Expand All @@ -39,19 +44,19 @@ Known gotchas
vlan 30

Diffs
---------
_____

Diffs for config replacement are a list of commands that would be needed to take the device from it's current state
to the desired config state. See ``test/unit/nxos/new_good.diff`` as an example.

Notes on configuration merging
==============================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Merges are currently implemented by simply applying the the merge config line by line.
This doesn't use the checkpoint/rollback functionality.
As a result, merges are **not atomic**.

Diffs
-------
_____

Diffs for merges are simply the lines in the merge candidate config.

0 comments on commit 42ead13

Please sign in to comment.