f5networks.f5_modules.bigip_ssl_ocsp – Manage OCSP configurations on BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.12.0).
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 version 1.0.0: of f5networks.f5_modules
Synopsis
- Manage OCSP configurations on a BIG-IP system.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| cache_error_timeout
integer
|
Specifies the lifetime of an error response in the cache, in seconds.
|
||
| cache_timeout
string
|
Specifies the lifetime of the OCSP response in the cache, in seconds.
|
||
| certificate
string
|
Specifies a certificate used to sign an OCSP request.
|
||
| clock_skew
integer
|
Specifies the tolerable absolute difference in the clocks of the responder and the BIG-IP system, in seconds.
|
||
| connection_timeout
integer
|
Specifies the time interval the BIG-IP system waits for before ending the connection to the OCSP responder, in seconds.
|
||
| connections_limit
integer
|
Specifies the maximum number of connections per second allowed for the OCSP certificate validator.
|
||
| dns_resolver
string
|
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.
|
||
| hash_algorithm
string
|
|
Specifies a hash algorithm used to sign an OCSP request.
|
|
| key
string
|
Specifies a key used to sign an OCSP request.
|
||
| name
string / required
|
Specifies the name of the OCSP certificate validator.
|
||
| partition
string
|
Default:
"Common"
|
Device partition to manage resources on.
|
|
| passphrase
string
|
Specifies a passphrase used to sign an OCSP request.
|
||
| provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
A dict object containing connection details.
|
||
| auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
||
| no_f5_teem
boolean
|
|
If
yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable
F5_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
|
|
| password
string / 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
string / required
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
|
||
| server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
|
|
| timeout
integer
|
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.
|
||
| transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
| user
string / 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
boolean
|
|
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.
|
|
| proxy_server_pool
string
|
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.
|
||
| responder_url
string
|
Specifies the absolute URL that overrides the OCSP responder URL obtained from the certificate's AIA extensions. This should be an HTTP-based URL.
|
||
| route_domain
string
|
Specifies the route domain for fetching an OCSP response using HTTP forward proxy.
|
||
| state
string
|
|
When
present, ensures the resource exists.
When absent, ensures the resource does not exist.
|
|
| status_age
integer
|
Specifies the maximum allowed lag time the BIG-IP system accepts for the 'thisUpdate' time in the OCSP response.
|
||
| strict_responder_checking
boolean
|
|
Specifies whether the responder's certificate is checked for an OCSP signing extension.
|
|
| trusted_responders
string
|
Specifies the certificates used for validating the OCSP response when the responder's certificate has been omitted from the response.
|
||
| update_password
string
|
|
always allows the user to update passwords. on_create only sets the password for newly created OCSP validators.
|
|
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 | Returned | Description |
|---|---|---|
| cache_error_timeout
integer
|
changed |
The new Response Caching Error Timeout value.
Sample:
3600
|
| cache_timeout
string
|
changed |
The new Response Caching Timeout value.
Sample:
indefinite
|
| certificate
string
|
changed |
The new Request Signing Certificate value.
Sample:
/Common/cert1
|
| clock_skew
integer
|
changed |
The new Response Validation Clock Skew value.
Sample:
300
|
| connection_timeout
integer
|
changed |
The new Connection Timeout value.
Sample:
8
|
| connections_limit
integer
|
changed |
The new Concurrent Connections Limit value.
Sample:
50
|
| dns_resolver
string
|
changed |
The new DNS Resolver value.
Sample:
/Common/resolver1
|
| hash_algorithm
string
|
changed |
The new Request Signing Hash Algorithm value.
Sample:
sha256
|
| key
string
|
changed |
The new Request Signing Key value.
Sample:
/Common/key1
|
| proxy_server_pool
string
|
changed |
The new Proxy Server Pool value.
Sample:
/Common/pool1
|
| responder_url
string
|
changed |
The new Connection Responder URL value.
Sample:
http://responder.site.com
|
| route_domain
string
|
changed |
The new Route Domain value.
Sample:
/Common/0
|
| status_age
integer
|
changed |
The new Response Validation Status Age value.
|
| strict_responder_checking
boolean
|
changed |
The new Response Validation Strict Responder Certificate Checking value.
Sample:
True
|
| trusted_responders
integer
|
changed |
The new Response Validation Trusted Responders value.
Sample:
/Common/default
|
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_ssl_ocsp_module.html