the-bastion/doc/sphinx/plugins/restricted/accountGeneratePassword.rst
Stéphane Lesimple fde20136ef
Initial commit
2020-10-20 14:30:27 +00:00

42 lines
1.3 KiB
ReStructuredText

========================
accountGeneratePassword
========================
Generate a new egress password for an account
=============================================
.. admonition:: usage
:class: cmdusage
--osh accountGeneratePassword --account ACCOUNT [--size SIZE] --do-it
.. program:: accountGeneratePassword
.. option:: --account ACCOUNT
Specify which account you want to generate a password for
.. option:: --size SIZE
Specify the number of characters of the password to generate
.. option:: --do-it
Required for the password to actually be generated, BEWARE: please read the note below
This plugin generates a new egress password to be used for ssh or telnet
NOTE: this is only needed for devices that don't support key-based SSH,
in most cases you should ignore this command completely, unless you
know that devices you need to access only support telnet or password-based SSH.
BEWARE: once a new password is generated this way, it'll be set as the new
egress password to use right away for the account, for any access that requires it.
A fallback mechanism exists that will auto-try the previous password if this one
doesn't work, but please ensure that this new password is deployed on the remote
devices as soon as possible.