ansible.posix.authorized_key – Adds or removes an SSH authorized key
ansible.posix.authorized_key – Adds or removes an SSH authorized key
Note
This plugin is part of the ansible.posix collection (version 1.1.1).
To install it use: ansible-galaxy collection install ansible.posix
.
To use it in a playbook, specify: ansible.posix.authorized_key
.
New in version 1.0.0: of ansible.posix
Synopsis
- Adds or removes SSH authorized keys for particular user accounts.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
comment string |
Change the comment on the public key. Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab. If no comment is specified, the existing comment will be kept. | |
exclusive boolean |
|
Whether to remove all other non-specified keys from the authorized_keys file. Multiple keys can be specified in a single This option is not loop aware, so if you use If you want multiple keys in the file you need to pass them all to |
follow boolean |
|
Follow path symlink instead of replacing it. |
key string / required |
The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys). | |
key_options string |
A string of ssh key options to be prepended to the key in the authorized_keys file. | |
manage_dir boolean |
|
Whether this module should manage the directory of the authorized key file. If set to Be sure to set See the example below. |
path path |
Alternate path to the authorized_keys file. When unset, this value defaults to ~/.ssh/authorized_keys. | |
state string |
|
Whether the given key (with the given key_options) should or should not be in the file. |
user string / required |
The username on the remote host whose authorized_keys file will be modified. | |
validate_certs boolean |
|
This only applies if using a https url as the source of the keys. If set to This should only set to Prior to 2.1 the code worked as if this was set to |
Examples
- name: Set authorized key taken from file
ansible.posix.authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
- name: Set authorized keys taken from url
ansible.posix.authorized_key:
user: charlie
state: present
key: https://github.com/charlie.keys
- name: Set authorized key in alternate location
ansible.posix.authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
path: /etc/ssh/authorized_keys/charlie
manage_dir: False
- name: Set up multiple authorized keys
ansible.posix.authorized_key:
user: deploy
state: present
key: '{{ item }}'
with_file:
- public_keys/doe-jane
- public_keys/doe-john
- name: Set authorized key defining key options
ansible.posix.authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
key_options: 'no-port-forwarding,from="10.0.1.1"'
- name: Set authorized key without validating the TLS/SSL certificates
ansible.posix.authorized_key:
user: charlie
state: present
key: https://github.com/user.keys
validate_certs: False
- name: Set authorized key, removing all the authorized keys already set
ansible.posix.authorized_key:
user: root
key: "{{ lookup('file', 'public_keys/doe-jane') }}"
state: present
exclusive: True
- name: Set authorized key for user ubuntu copying it from current user
ansible.posix.authorized_key:
user: ubuntu
state: present
key: "{{ lookup('file', lookup('env','HOME') + '/.ssh/id_rsa.pub') }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
exclusive boolean |
success |
If the key has been forced to be exclusive or not.
|
key string |
success |
The key that the module was running against.
Sample: |
key_option string |
success |
Key options related to the key.
|
keyfile string |
success |
Path for authorized key file.
Sample: /home/user/.ssh/authorized_keys |
manage_dir boolean |
success |
Whether this module managed the directory of the authorized key file.
Sample: True |
path string |
success |
Alternate path to the authorized_keys file
|
state string |
success |
Whether the given key (with the given key_options) should or should not be in the file
Sample: present |
unique boolean |
success |
Whether the key is unique
|
user string |
success |
The username on the remote host whose authorized_keys file will be modified
Sample: user |
validate_certs boolean |
success |
This only applies if using a https url as the source of the keys. If set to
Sample: True |
Authors
- Ansible Core Team
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/posix/authorized_key_module.html