f5networks.f5_modules.bigip_ssl_ocsp module – Manage OCSP configurations on BIG-IP
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_ssl_ocsp
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage OCSP configurations on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
Specifies the lifetime of an error response in the cache, in seconds. |
|
Specifies the lifetime of the OCSP response in the cache, in seconds. |
|
Specifies a certificate used to sign an OCSP request. |
|
Specifies the tolerable absolute difference in the clocks of the responder and the BIG-IP system, in seconds. |
|
Specifies the time interval the BIG-IP system waits for before ending the connection to the OCSP responder, in seconds. |
|
Specifies the maximum number of connections per second allowed for the OCSP certificate validator. |
|
Specifies the internal DNS resolver the BIG-IP system uses to fetch the OCSP response. This involves specifying one or more DNS servers in the DNS resolver configuration. Use this option when either there is a DNS server that can do the name-resolution of the OCSP responders, or the OCSP responder can be reached on one of BIG-IP system’s interfaces. |
|
Specifies a hash algorithm used to sign an OCSP request. Choices:
|
|
Specifies a key used to sign an OCSP request. |
|
Specifies the name of the OCSP certificate validator. |
|
Device partition to manage resources on. Default: |
|
Specifies a passphrase used to sign an OCSP request. |
|
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 or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ 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 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 or the BIG-IQ. 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:
|
|
Specifies the proxy server pool the BIG-IP system uses to fetch the OCSP response. This involves creating a pool with proxy-servers. Use this option when either the OCSP responder cannot be reached on any of BIG-IP system’s interfaces, or one or more servers can proxy an HTTP request to an external server and fetch the response. |
|
Specifies the absolute URL that overrides the OCSP responder URL obtained from the certificate’s AIA extensions. This should be an HTTP-based URL. |
|
Specifies the route domain for fetching an OCSP response using HTTP forward proxy. |
|
When When Choices:
|
|
Specifies the maximum allowed lag time the BIG-IP system accepts for the ‘thisUpdate’ time in the OCSP response. |
|
Specifies whether the responder’s certificate is checked for an OCSP signing extension. Choices:
|
|
Specifies the certificates used for validating the OCSP response when the responder’s certificate has been omitted from the response. |
|
Choices:
|
Notes
Note
Requires BIG-IP >= 13.x.
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: Create a OCSP validator
bigip_ssl_ocsp:
name: foo
proxy_server_pool: validators-pool
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new Response Caching Error Timeout value. Returned: changed Sample: |
|
The new Response Caching Timeout value. Returned: changed Sample: |
|
The new Request Signing Certificate value. Returned: changed Sample: |
|
The new Response Validation Clock Skew value. Returned: changed Sample: |
|
The new Connection Timeout value. Returned: changed Sample: |
|
The new Concurrent Connections Limit value. Returned: changed Sample: |
|
The new DNS Resolver value. Returned: changed Sample: |
|
The new Request Signing Hash Algorithm value. Returned: changed Sample: |
|
The new Request Signing Key value. Returned: changed Sample: |
|
The new Proxy Server Pool value. Returned: changed Sample: |
|
The new Connection Responder URL value. Returned: changed Sample: |
|
The new Route Domain value. Returned: changed Sample: |
|
The new Response Validation Status Age value. Returned: changed Sample: |
|
The new Response Validation Strict Responder Certificate Checking value. Returned: changed Sample: |
|
The new Response Validation Trusted Responders value. Returned: changed Sample: |