New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
attributes
(added in 2.3) |
|
Attributes the file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr.
aliases: attr |
|
force
|
no
|
Should the key be regenerated even it it already exists
|
|
format
(added in 2.4) |
|
The format of the public key.
|
|
group
|
|
Name of the group that should own the file/directory, as would be fed to chown.
|
|
mode
|
|
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either specify the leading zero so that Ansible's YAML parser knows it is an octal number (like
0644 or 01777) or quote it (like '644' or '0644' so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). |
|
owner
|
|
Name of the user that should own the file/directory, as would be fed to chown.
|
|
path
required |
|
Name of the file in which the generated TLS/SSL public key will be written.
|
|
privatekey_passphrase
(added in 2.4) |
|
The passphrase for the privatekey.
|
|
privatekey_path
required |
|
Path to the TLS/SSL private key from which to generate the public key.
|
|
selevel
|
Default:
s0
|
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the
range. _default feature works as for seuser. |
|
serole
|
|
Role part of SELinux file context,
_default feature works as for seuser. |
|
setype
|
|
Type part of SELinux file context,
_default feature works as for seuser. |
|
seuser
|
|
User part of SELinux file context. Will default to system policy, if applicable. If set to
_default, it will use the user portion of the policy if available. |
|
state
|
|
Whether the public key should exist or not, taking action if the state is different from what is stated.
|
|
unsafe_writes
(added in 2.2) |
|
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
|
# Generate an OpenSSL public key in PEM format.
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
# Generate an OpenSSL public key in OpenSSH v2 format.
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
format: OpenSSH
# Generate an OpenSSL public key with a passphrase protected
# private key
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
privatekey_passphrase: ansible
# Force regenerate an OpenSSL public key if it already exists
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
force: True
# Remove an OpenSSL public key
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
filename
string
|
changed or success |
Path to the generated TLS/SSL public key file
Sample:
/etc/ssl/public/ansible.com.pem
|
|
fingerprint
dict
|
changed or success |
The fingerprint of the public key. Fingerprint will be generated for each hashlib.algorithms available. Requires PyOpenSSL >= 16.0 for meaningful output.
Sample:
{'sha1': '51:cc:7c:68:5d:eb:41:43:88:7e:1a:ae:c7:f8:24:72:ee:71:f6:10', 'sha384': '85:39:50:4e:de:d9:19:33:40:70:ae:10:ab:59:24:19:51:c3:a2:e4:0b:1c:b1:6e:dd:b3:0c:d9:9e:6a:46:af:da:18:f8:ef:ae:2e:c0:9a:75:2c:9b:b3:0f:3a:5f:3d', 'sha224': 'b1:19:a6:6c:14:ac:33:1d:ed:18:50:d3:06:5c:b2:32:91:f1:f1:52:8c:cb:d5:75:e9:f5:9b:46', 'sha256': '41:ab:c7:cb:d5:5f:30:60:46:99:ac:d4:00:70:cf:a1:76:4f:24:5d:10:24:57:5d:51:6e:09:97:df:2f:de:c7', 'sha512': 'fd:ed:5e:39:48:5f:9f:fe:7f:25:06:3f:79:08:cd:ee:a5:e7:b3:3d:13:82:87:1f:84:e1:f5:c7:28:77:53:94:86:56:38:69:f0:d9:35:22:01:1e:a6:60:...:0f:9b', 'md5': '84:75:71:72:8d:04:b5:6c:4d:37:6d:66:83:f5:4c:29'}
|
|
format
string
|
changed or success |
The format of the public key (PEM, OpenSSH, ...)
Sample:
PEM
|
|
privatekey
string
|
changed or success |
Path to the TLS/SSL private key the public key was generated from
Sample:
/etc/ssl/private/ansible.com.pem
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.