Skip to content

Commit

Permalink
Merge pull request #413 from napalm-automation/develop
Browse files Browse the repository at this point in the history
Hotfixes to the docs
  • Loading branch information
dbarrosop committed Aug 26, 2017
2 parents d5a5ed1 + 3b25469 commit 27731ca
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 45 deletions.
12 changes: 3 additions & 9 deletions docs/cli.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Command Line Tool
=================

NAPALM ships with a very simple cli tool so you can use napalm straight from the CLI. It's use is quite simple and you can see the help with ``--help``:

.. code-block::
NAPALM ships with a very simple cli tool so you can use napalm straight from the CLI. It's use is quite simple and you can see the help with ``--help``::

$ napalm --help
usage: napalm [-h] [--user USER] [--password PASSWORD] --vendor VENDOR
Expand Down Expand Up @@ -44,9 +42,7 @@ You can mostly do three things:
2. Call any method (like ``get_interfaces`` or ``ping``)
3. Validate configuration/state

Let's see a few examples:

.. code-block::
Let's see a few examples::

# napalm --user vagrant --password vagrant --vendor eos --optional_args "port=12443" localhost configure new_config.txt --strategy merge --dry-run
@@ -8,7 +8,7 @@
Expand Down Expand Up @@ -135,9 +131,7 @@ Let's see a few examples:
Debug Mode
----------

The debugging mode is also quite useful and it's recommended you use it to report and issue.

.. code-block::
The debugging mode is also quite useful and it's recommended you use it to report and issue.::

$ napalm --debug --user vagrant --password vagrant --vendor eos --optional_args "port=12443" localhost configure new_config.txt --strategy merge --dry-run
2017-08-15 15:14:23,527 - napalm - DEBUG - Starting napalm's debugging tool
Expand Down
37 changes: 1 addition & 36 deletions docs/support/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ ____________________________________
* :code:`global_delay_factor` (ios, vyos) - Allow for additional delay in command execution (default: ``1``).
* :code:`transport` (eos, ios, nxos) - Protocol to connect with (see `The transport argument`_ for more information).
* :code:`enable_password` (eos) - Password required to enter privileged exec (enable) (default: ``''``).
* :code:`secret` (ios) - Password required to enter privileged exec (enable) (default: ``''``).
* :code:`ssh_strict` (iosxr, ios, panos, vyos) - Automatically reject unknown SSH host keys (default: ``False``, which means unknown SSH host keys will be accepted).
* :code:`allow_agent` (ios, iosxr, panos, vyos) - Paramiko argument, enable connecting to the SSH agent (default: ``False``).
* :code:`use_keys` (iosxr, ios, panos, vyos) - Paramiko argument, enable searching for discoverable private key files in ``~/.ssh/`` (default: ``False``).
Expand All @@ -148,42 +149,6 @@ _ EOS NXOS IOS
**Supported** ``http``, ``https`` ``http``, ``https`` ``telnet``, ``ssh``
=============== ==================== ==================== ===================

The transport argument
______________________

Certain drivers support providing an alternate transport in the :code:`optional_args`, overriding the default protocol to connect with. Allowed transports are therefore device/library dependant:

=============== ==================== ==================== ===================
_ EOS NXOS IOS
=============== ==================== ==================== ===================
**Default** ``https`` ``https`` ``ssh``
**Supported** ``http``, ``https`` ``http``, ``https`` ``telnet``, ``ssh``
=============== ==================== ==================== ===================

The transport argument
______________________

Certain drivers support providing an alternate transport in the :code:`optional_args`, overriding the default protocol to connect with. Allowed transports are therefore device/library dependant:

=============== ==================== ==================== ===================
_ EOS NXOS IOS
=============== ==================== ==================== ===================
**Default** ``https`` ``https`` ``ssh``
**Supported** ``http``, ``https`` ``http``, ``https`` ``telnet``, ``ssh``
=============== ==================== ==================== ===================

The transport argument
______________________

Certain drivers support providing an alternate transport in the :code:`optional_args`, overriding the default protocol to connect with. Allowed transports are therefore device/library dependant:

=============== ==================== ==================== ===================
_ EOS NXOS IOS
=============== ==================== ==================== ===================
**Default** ``https`` ``https`` ``ssh``
**Supported** ``http``, ``https`` ``http``, ``https`` ``telnet``, ``ssh``
=============== ==================== ==================== ===================

Adding optional arguments to NAPALM drivers
___________________________________________

Expand Down

0 comments on commit 27731ca

Please sign in to comment.