f5networks.f5_modules.bigip_device_certificate module – Manage self-signed device certificates
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_device_certificate
.
New in f5networks.f5_modules 1.0.0
Synopsis
Module used to create and/or renew self-signed device certificates for BIG-IP.
Parameters
Parameter |
Comments |
---|---|
Specifies if the certificate should be added to the trusted client and server certificate files. Choices:
|
|
Specifies the full name of the certificate file. If the name is not default Default: |
|
Specifies the interval for which the self-signed certificate is valid. The maximum value is 25 years: |
|
When When Generally should be This option is also needed when generating a new certificate to replace non-expired one. Choices:
|
|
Certificate properties, required when generating new certificates. |
|
Specifies the Common Name attribute for the certificate. |
|
Specifies the Country name attribute for the certificate. |
|
Specifies the department name attribute for the certificate. |
|
Specifies the email address of the domain administrator. |
|
Specifies the city or town name for the certificate. |
|
Specifies the Organization attribute for the certificate. |
|
Specifies the State or Province attribute for the certificate. |
|
Specifies the full name of the key file. If the name is not default Default: |
|
Specifies the desired key size in bits. Mandatory option when generating a new certificate. Choices:
|
|
Specifies if the module should generate a new certificate. When Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
Notes
Note
When using this module make sure SSH type is not set to libssh. To do this you could either set the environment variable like this
ANSIBLE_NETWORK_CLI_SSH_TYPE=paramiko
or setadd ssh_type = paramiko
under section persistent_connection in ansible.cfg.For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Update expired certificate
bigip_device_certificate:
days_valid: 365
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Update expired certificate non-default names
bigip_device_certificate:
days_valid: 60
cert_name: custom.crt
key_name: custom.key
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Force update not expired certificate
bigip_device_certificate:
days_valid: 365
force: true
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Create a new certificate to replace expired certificate
bigip_device_certificate:
days_valid: 365
new_cert: true
issuer:
country: US
state: WA
common_name: foobar.foo.local
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Force create a new custom named certificate to replace not expired certificate
bigip_device_certificate:
days_valid: 365
cert_name: custom.crt
key_name: custom.key
new_cert: true
force: true
issuer:
country: US
state: WA
common_name: foobar.foo.local
key_size: 2048
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full name of the certificate file. Returned: changed Sample: |
|
The interval for which the self-signed certificate is valid. Returned: changed Sample: |
|
Specifies certificate properties. Returned: changed |
|
The Common Name attribute of the certificate. Returned: changed Sample: |
|
The Country name attribute of the certificate. Returned: changed Sample: |
|
The department name attribute of the certificate. Returned: changed Sample: |
|
The domain administrator’s email address. Returned: changed Sample: |
|
The city or town name attribute of the certificate. Returned: changed Sample: |
|
The Organization attribute of the certificate. Returned: changed Sample: |
|
The State or Province attribute of the certificate. Returned: changed Sample: |
|
The full name of the key file. Returned: changed Sample: |
|
The desired key size in bits. Returned: changed Sample: |