Last updated on: 2024-04-01 03:24:20.
bigip_ssl_pkcs12 – Manage BIG-IP PKCS12 certificates/keys¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
attributes
string
added in 2.3 |
The attributes the resulting filesystem object 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.
The
= operator is assumed as default, otherwise + or - operators need to be included in the string.aliases: attr |
||
|
cert_pass
string
|
Passphrase with which the PKCS12 file is encrypted.
|
||
|
force
boolean
|
|
When set to
true, any existing certificate/key with the same name is overwritten by the new import. |
|
|
group
string
|
Name of the group that should own the filesystem object, as would be fed to chown.
When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership.
|
||
|
mode
raw
|
The permissions the resulting filesystem object should have.
For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances.
Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results.
As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)).
If O(mode) is not specified and the destination filesystem object does not exist, the default
umask on the system will be used when setting the mode for the newly created filesystem object.If O(mode) is not specified and the destination filesystem object does exist, the mode of the existing filesystem object will be used.
Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details.
|
||
|
name
string
|
The name of the PKCS12 certificate and key to create or override.
This parameter is mandatory when
state is absent.When
state is present and the parameter is not given, the certificate and key name is derived from the source parameter. |
||
|
owner
string
|
Name of the user that should own the filesystem object, as would be fed to chown.
When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership.
Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion.
|
||
|
partition
string
|
Default: "Common"
|
Used to check for the existence and removal of installed PKCS12 keys and certificates.
|
|
|
selevel
string
|
The level part of the SELinux filesystem object context.
This is the MLS/MCS attribute, sometimes known as the
range.When set to V(_default), it will use the
level portion of the policy if available. |
||
|
serole
string
|
The role part of the SELinux filesystem object context.
When set to V(_default), it will use the
role portion of the policy if available. |
||
|
setype
string
|
The type part of the SELinux filesystem object context.
When set to V(_default), it will use the
type portion of the policy if available. |
||
|
seuser
string
|
The user part of the SELinux filesystem object context.
By default it uses the V(system) policy, where applicable.
When set to V(_default), it will use the
user portion of the policy if available. |
||
|
source
path
|
Full path to a PKCS12 file to be imported onto the BIG-IP.
Parameter is mandatory when
state is present. |
||
|
state
string
|
|
Certificate and key state. This determines if the provided certificate and key are to be made
present on the device or absent. |
|
|
unsafe_writes
boolean
added in 2.2 |
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object.
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner.
This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes).
IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
|
Examples¶
- name: Install PKCS12 cert and key
bigip_ssl_pkcs12:
source: /root/baz.p12
state: present
- name: Install PKCS12 cert and key - force
bigip_ssl_pkcs12:
name: foo
source: /root/baz.p12
state: present
force: true
- name: Remove PKCS12 cert and key
bigip_ssl_pkcs12:
name: foo
state: absent
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
name
string
|
changed |
Name of the PKCS12 cert and key to be created/overwritten.
Sample:
some_cert
|
|
source
string
|
changed |
Local path to PKCS12 file.
Sample:
/root/some_cert.p12
|