ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Merge pull request #1433 from jpmens/doc_user

Browse source 
fix DOCUMENTATION for user
This commit is contained in:
Michael DeHaan 2012-10-24 04:26:50 -07:00
commit ca4fb043ef
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
library/user
View file

@ -105,40 +105,43 @@ options:
ssh_key: ssh_key:
required: false required: false
choices: [ generate ] choices: [ generate ]
version_added: "0.9"
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
version_added: "0.9"
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
version_added: "0.9"
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. New in version 0.9. present on target host.
ssh_key_file: ssh_key_file:
required: false required: false
default: $HOME/.ssh/id_rsa default: $HOME/.ssh/id_rsa
version_added: "0.9"
description: description:
- Optionally specify the SSH key filename. New in version 0.9. - Optionally specify the SSH key filename.
ssh_key_comment: ssh_key_comment:
required: false required: false
default: ansible-generated default: ansible-generated
version_added: "0.9"
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
version_added: "0.9"
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. New in version 0.9. having no passphrase.
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'"