Add output (#19212)
This commit is contained in:
parent
474c0dc87c
commit
2790999ee9
1 changed files with 53 additions and 0 deletions
|
@ -154,6 +154,59 @@ EXAMPLES = '''
|
|||
key: "{{ lookup('file', lookup('env','HOME') + '/.ssh/id_rsa.pub') }}"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
exclusive:
|
||||
description: If the key has been forced to be exclusive or not.
|
||||
returned: success
|
||||
type: boolean
|
||||
sample: False
|
||||
key:
|
||||
description: The key that the module was running against.
|
||||
returned: success
|
||||
type: string
|
||||
sample: https://github.com/user.keys
|
||||
key_option:
|
||||
description: Key options related to the key.
|
||||
returned: success
|
||||
type: string
|
||||
sameple: null
|
||||
keyfile:
|
||||
description: Path for authorzied key file.
|
||||
returned: success
|
||||
type: string
|
||||
sameple: /home/user/.ssh/authorized_keys
|
||||
manage_dir:
|
||||
description: Whether this module managed the directory of the authorized key file.
|
||||
returned: success
|
||||
type: boolean
|
||||
sameple: True
|
||||
path:
|
||||
description: Alternate path to the authorized_keys file
|
||||
returned: success
|
||||
type: string
|
||||
sameple: null
|
||||
state:
|
||||
description: Whether the given key (with the given key_options) should or should not be in the file
|
||||
returned: success
|
||||
type: string
|
||||
sameple: present
|
||||
unique:
|
||||
description: Whether the key is unique
|
||||
returned: success
|
||||
type: boolean
|
||||
sameple: false
|
||||
user:
|
||||
description: The username on the remote host whose authorized_keys file will be modified
|
||||
returned: success
|
||||
type: string
|
||||
sameple: user
|
||||
validate_certs:
|
||||
description: This only applies if using a https url as the source of the keys. If set to C(no), the SSL certificates will not be validated.
|
||||
returned: success
|
||||
type: boolean
|
||||
sameple: true
|
||||
'''
|
||||
|
||||
# Makes sure the public key line is present or absent in the user's .ssh/authorized_keys.
|
||||
#
|
||||
# Arguments
|
||||
|
|
Loading…
Reference in a new issue