cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Clarify documented behaviour of user module's ssh_key_file parameter

Browse source 
Fixes #9873
This commit is contained in:
Toshio Kuratomi 2015-01-07 08:45:55 -08:00 committed by Matt Clay
parent c5dfc66cb1
commit e75dc7e5a6
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
lib/ansible/modules/system/user.py
View file

@ -155,10 +155,11 @@ options:
present on target host. present on target host.
ssh_key_file: ssh_key_file:
required: false required: false
default: $HOME/.ssh/id_rsa default: .ssh/id_rsa
version_added: "0.9" version_added: "0.9"
description: description:
- Optionally specify the SSH key filename. - Optionally specify the SSH key filename. If this is a relative
filename then it will be relative to the user's home directory.
ssh_key_comment: ssh_key_comment:
required: false required: false
default: ansible-generated on $HOSTNAME default: ansible-generated on $HOSTNAME
@ -191,8 +192,8 @@ EXAMPLES = '''
# Remove the user 'johnd' # Remove the user 'johnd'
- user: name=johnd state=absent remove=yes - user: name=johnd state=absent remove=yes
# Create a 2048-bit SSH key for user jsmith # Create a 2048-bit SSH key for user jsmith in ~jsmith/.ssh/id_rsa
- user: name=jsmith generate_ssh_key=yes ssh_key_bits=2048 - user: name=jsmith generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa
''' '''
import os import os