f5networks.f5_modules.bigip_ssl_ocsp (1.28.0) — module

Manage OCSP configurations on BIG-IP

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Tim Rupp (@caphrim007)

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0


Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage OCSP configurations on a BIG-IP system.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
key:
    description:
    - Specifies a key used to sign an OCSP request.
    type: str

name:
    description:
    - Specifies the name of the OCSP certificate validator.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the resource exists.
    - When C(absent), ensures the resource does not exist.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - 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 C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - 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 C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

clock_skew:
    description:
    - Specifies the tolerable absolute difference in the clocks of the responder and the
      BIG-IP system, in seconds.
    type: int

passphrase:
    description:
    - Specifies a passphrase used to sign an OCSP request.
    type: str

status_age:
    description:
    - Specifies the maximum allowed lag time the BIG-IP system accepts for the 'thisUpdate'
      time in the OCSP response.
    type: int

certificate:
    description:
    - Specifies a certificate used to sign an OCSP request.
    type: str

dns_resolver:
    description:
    - 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.
    type: str

route_domain:
    description:
    - Specifies the route domain for fetching an OCSP response using HTTP forward proxy.
    type: str

cache_timeout:
    description:
    - Specifies the lifetime of the OCSP response in the cache, in seconds.
    type: str

responder_url:
    description:
    - Specifies the absolute URL that overrides the OCSP responder URL obtained from the
      certificate's AIA extensions. This should be an HTTP-based URL.
    type: str

hash_algorithm:
    choices:
    - sha256
    - sha1
    description:
    - Specifies a hash algorithm used to sign an OCSP request.
    type: str

update_password:
    choices:
    - always
    - on_create
    default: always
    description:
    - C(always) allows the user to update passwords. C(on_create) only sets the password
      for newly created OCSP validators.
    type: str

connections_limit:
    description:
    - Specifies the maximum number of connections per second allowed for the OCSP certificate
      validator.
    type: int

proxy_server_pool:
    description:
    - 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.
    type: str

connection_timeout:
    description:
    - Specifies the time interval the BIG-IP system waits for before ending the connection
      to the OCSP responder, in seconds.
    type: int

trusted_responders:
    description:
    - Specifies the certificates used for validating the OCSP response when the responder's
      certificate has been omitted from the response.
    type: str

cache_error_timeout:
    description:
    - Specifies the lifetime of an error response in the cache, in seconds.
    type: int

strict_responder_checking:
    description:
    - Specifies whether the responder's certificate is checked for an OCSP signing extension.
    type: bool

Outputs

cache_error_timeout:
  description: The new Response Caching Error Timeout value.
  returned: changed
  sample: 3600
  type: int
cache_timeout:
  description: The new Response Caching Timeout value.
  returned: changed
  sample: indefinite
  type: str
certificate:
  description: The new Request Signing Certificate value.
  returned: changed
  sample: /Common/cert1
  type: str
clock_skew:
  description: The new Response Validation Clock Skew value.
  returned: changed
  sample: 300
  type: int
connection_timeout:
  description: The new Connection Timeout value.
  returned: changed
  sample: 8
  type: int
connections_limit:
  description: The new Concurrent Connections Limit value.
  returned: changed
  sample: 50
  type: int
dns_resolver:
  description: The new DNS Resolver value.
  returned: changed
  sample: /Common/resolver1
  type: str
hash_algorithm:
  description: The new Request Signing Hash Algorithm value.
  returned: changed
  sample: sha256
  type: str
key:
  description: The new Request Signing Key value.
  returned: changed
  sample: /Common/key1
  type: str
proxy_server_pool:
  description: The new Proxy Server Pool value.
  returned: changed
  sample: /Common/pool1
  type: str
responder_url:
  description: The new Connection Responder URL value.
  returned: changed
  sample: http://responder.site.com
  type: str
route_domain:
  description: The new Route Domain value.
  returned: changed
  sample: /Common/0
  type: str
status_age:
  description: The new Response Validation Status Age value.
  returned: changed
  sample: 0
  type: int
strict_responder_checking:
  description: The new Response Validation Strict Responder Certificate Checking value.
  returned: changed
  sample: true
  type: bool
trusted_responders:
  description: The new Response Validation Trusted Responders value.
  returned: changed
  sample: /Common/default
  type: int