Skip to content

Commit 9c4e092

Browse files
committed
address comments
1 parent d29ce27 commit 9c4e092

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/user_guide/passwords.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ Password Handling
33

44
Passwords are defined in the testbed YAML file. This document describes the
55
password handling logic used by the different plugins.
6-
For understanding the password handling first we need to understand credentials on pyATS.
6+
Passwords are managed through device credentials in pyATS,
7+
the next section explains how credentials are handled in pyATS.
78

8-
.. _credentails:
9+
.. _credentials:
910

1011
Credentials
1112
-----------
@@ -28,7 +29,7 @@ raised.
2829

2930
Credentials are not retried, any username or password failure causes a
3031
`UniconAuthenticationError<unicon.core.errors.UniconAuthenticationError>`
31-
to be raised.
32+
to be raised, unless fallback credentials are defined. See :ref:`fallback_credentials`.
3233

3334
It is possible to specify the password to use for routing devices to enter
3435
enable mode. This may be done via the ``enable_password`` entry under the
@@ -216,7 +217,7 @@ specified by the specific plugin).
216217

217218
``login_creds`` is used to describe the order of credentials to use on
218219
initial login. If not specified, the ``default`` credential is used.
219-
Please see :ref:`credentails` for more details.
220+
Please see :ref:`credentials` for more details.
220221

221222
.. code-block:: yaml
222223
@@ -319,16 +320,17 @@ The following response pattern generates a bad password exception:
319320
320321
bad_passwords = r'^.*?% (Bad passwords|Access denied|Authentication failed)'
321322
323+
.. _fallback_credentials:
324+
322325
Fallback Credentials
323326
--------------------
324327

325-
In case of authentication failure,
326-
you could use fallback credentials before erroring out.
327-
you could have a couple of login credentials and define them using fallback credentials.
328-
These login credentials will be used in sequence. If none of the combination works on the device
329-
we get the bad password exception.
328+
In case of authentication failure, fallback credentials are used to try and login to the device
329+
when they are defined for the connection. You can define one or more device credentials and define
330+
them as fallback credentials by adding them to the fallback credentials list under the `defaults` section or under the connection.
331+
The fallback credentials credentials will be used in sequence. If none of the combinations work on the device a bad password exception is raised.
330332

331-
you could have a default list for all the connections in the testbed:
333+
Below an example of a testbed with fallback credentials defined.
332334

333335
.. code-block:: yaml
334336
@@ -364,7 +366,7 @@ you could have a default list for all the connections in the testbed:
364366
port: 23
365367
protocol: telnet
366368
367-
or you could define fallback credentails per connection:
369+
Example of fallback credentials per connection:
368370

369371
.. code-block:: yaml
370372

0 commit comments

Comments
 (0)