summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua Lund <josh@joshlund.com>2013-06-07 15:43:42 -0600
committerJoshua Lund <josh@joshlund.com>2013-06-07 15:43:42 -0600
commit51c74412444dad29f155b0e440c8372848199002 (patch)
tree67b83b9919e2ac0a2fda2b68a65cb984f5620112
parente204394c2c141ca9dcf867f350161e6b6da95c19 (diff)
downloadansible-51c74412444dad29f155b0e440c8372848199002.tar.gz
Updates to the authorized_key documentation
* Clarified the meaning of 'user' * Changed 'sshdir' to 'path' in the example * 'sshdir' is used internally in the module, but the argument is 'path' * Made the capitalization consistent in the descriptions
-rw-r--r--library/system/authorized_key10
1 files changed, 5 insertions, 5 deletions
diff --git a/library/system/authorized_key b/library/system/authorized_key
index 0423067f43..f70bc69ce1 100644
--- a/library/system/authorized_key
+++ b/library/system/authorized_key
@@ -31,13 +31,13 @@ version_added: "0.5"
options:
user:
description:
- - Name of the user who should have access to the remote host
+ - The username on the remote host whose authorized_keys file will be modified
required: true
default: null
aliases: []
key:
description:
- - the SSH public key, as a string
+ - The SSH public key, as a string
required: true
default: null
path:
@@ -55,12 +55,12 @@ options:
version_added: "1.2"
state:
description:
- - whether the given key should or should not be in the file
+ - Whether the given key should or should not be in the file
required: false
choices: [ "present", "absent" ]
default: "present"
description:
- - "adds or removes authorized keys for particular user accounts"
+ - "Adds or removes authorized keys for particular user accounts"
author: Brad Olson
'''
@@ -69,7 +69,7 @@ EXAMPLES = '''
authorized_key: user=charlie key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
# Using alternate directory locations:
-authorized_key: user=charlie key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" sshdir='/etc/ssh/authorized_keys/charlie' manage_dir=no
+authorized_key: user=charlie key="{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}" path='/etc/ssh/authorized_keys/charlie' manage_dir=no
'''
# Makes sure the public key line is present or absent in the user's .ssh/authorized_keys.