New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
content |
Sets the contents of a key directly to the specified value. This is used with lookup plugins or for anything with formatting or templating. This must be provided when
state is present .aliases: key_content |
||
name
required |
The name of the key.
|
||
partition
(added in 2.5) |
Default: Common
|
Device partition to manage resources on.
|
|
passphrase |
Passphrase on key.
|
||
password
required |
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
provider
(added in 2.5) |
Default: None
|
A dict object containing connection details.
|
|
password
required |
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
server
required |
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port |
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
||
validate_certs
bool |
|
If
no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable
F5_VALIDATE_CERTS . |
|
timeout |
Default: 10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
ssh_keyfile |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable
ANSIBLE_NET_SSH_KEYFILE . |
||
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
server
required |
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port
(added in 2.2) |
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
state |
|
When
present , ensures that the key is uploaded to the device. When absent , ensures that the key is removed from the device. If the key is currently in use, the module will not be able to remove the key. |
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
||
validate_certs
bool (added in 2.0) |
|
If
no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable
F5_VALIDATE_CERTS . |
Note
pip install f5-sdk
.- name: Use a file lookup to import key
bigip_ssl_key:
name: key-name
server: lb.mydomain.com
user: admin
password: secret
state: present
content: "{{ lookup('file', '/path/to/key.key') }}"
delegate_to: localhost
- name: Delete key
bigip_ssl_key:
name: key-name
server: lb.mydomain.com
user: admin
password: secret
state: absent
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
key_checksum
string
|
changed and created |
SHA1 checksum of the key that was provided.
Sample:
cf23df2207d99a74fbe169e3eba035e633b65d94
|
key_filename
string
|
created |
The name of the SSL certificate key. The
key_filename and cert_filename will be similar to each other, however the key_filename will have a .key extension.Sample:
cert1.key
|
key_source_path
string
|
created |
Path on BIG-IP where the source of the key is stored
Sample:
/var/config/rest/downloads/cert1.key
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Hint
If you notice any issues in this documentation you can edit this document to improve it.