mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Document ssh_key options are in version 0.9
This commit is contained in:
parent
f9a2f4687e
commit
5d8c130a7f
1 changed files with 6 additions and 3 deletions
|
@ -108,34 +108,37 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether to generate a SSH key for the user in question.
|
- Whether to generate a SSH key for the user in question.
|
||||||
This will B(not) overwrite an existing SSH key.
|
This will B(not) overwrite an existing SSH key.
|
||||||
|
New in version 0.9.
|
||||||
ssh_key_bits:
|
ssh_key_bits:
|
||||||
required: false
|
required: false
|
||||||
default: 2048
|
default: 2048
|
||||||
description:
|
description:
|
||||||
- Optionally specify number of bits in SSH key to create.
|
- Optionally specify number of bits in SSH key to create.
|
||||||
|
New in version 0.9.
|
||||||
ssh_key_type:
|
ssh_key_type:
|
||||||
required: false
|
required: false
|
||||||
default: rsa
|
default: rsa
|
||||||
description:
|
description:
|
||||||
- Optionally specify the tyep of SSH key to generate.
|
- Optionally specify the tyep of SSH key to generate.
|
||||||
Available SSH key types will depend on implementation
|
Available SSH key types will depend on implementation
|
||||||
present on target host.
|
present on target host. New in version 0.9.
|
||||||
ssh_key_file:
|
ssh_key_file:
|
||||||
required: false
|
required: false
|
||||||
default: $HOME/.ssh/id_rsa
|
default: $HOME/.ssh/id_rsa
|
||||||
description:
|
description:
|
||||||
- Optionally specify the SSH key filename.
|
- Optionally specify the SSH key filename. New in version 0.9.
|
||||||
ssh_key_comment:
|
ssh_key_comment:
|
||||||
required: false
|
required: false
|
||||||
default: ansible-generated
|
default: ansible-generated
|
||||||
description:
|
description:
|
||||||
- Optionally define the comment for the SSH key.
|
- Optionally define the comment for the SSH key.
|
||||||
|
New in version 0.9.
|
||||||
ssh_key_passphrase:
|
ssh_key_passphrase:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
- Set a passphrase for the SSH key. If no
|
- Set a passphrase for the SSH key. If no
|
||||||
passphrase is provided, the SSH key will default to
|
passphrase is provided, the SSH key will default to
|
||||||
having no passphrase.
|
having no passphrase. New in version 0.9.
|
||||||
examples:
|
examples:
|
||||||
- code: 'user: name=johnd comment="John Doe" uid=1040'
|
- code: 'user: name=johnd comment="John Doe" uid=1040'
|
||||||
description: "Add the user 'johnd' with a specific uid and a primary group of 'admin'"
|
description: "Add the user 'johnd' with a specific uid and a primary group of 'admin'"
|
||||||
|
|
Loading…
Reference in a new issue