ansible.builtin.bigip_device_httpd (v2.5.6) — module

Manage HTTPD related settings on BIG-IP

| "added in version" 2.5 of ansible.builtin"

Authors: Joe Reifel (@JoeReifel), Tim Rupp (@caphrim007)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.5.6

Description

Manages HTTPD related settings on the BIG-IP. These settings are interesting to change when you want to set GUI timeouts and other TMUI related settings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the BIG-IP authentication realm name
  bigip_device_httpd:
    auth_name: BIG-IP
    password: secret
    server: lb.mydomain.com
    user: admin
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the auth pam timeout to 3600 seconds
  bigip_device_httpd:
    auth_pam_idle_timeout: 1200
    password: secret
    server: lb.mydomain.com
    user: admin
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the validate IP settings
  bigip_device_httpd:
    auth_pam_validate_ip: on
    password: secret
    server: lb.mydomain.com
    user: admin
  delegate_to: localhost

Inputs

    
allow:
    choices:
    - all
    - IP address, such as 172.27.1.10
    - IP range, such as 172.27.*.* or 172.27.0.0/255.255.0.0
    description:
    - Specifies, if you have enabled HTTPD access, the IP address or address range for
      other systems that can communicate with this system.

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

ssl_port:
    description:
    - The HTTPS port to listen on.

auth_name:
    description:
    - Sets the BIG-IP authentication realm name.

log_level:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - error
    - info
    - notice
    - warn
    description:
    - Sets the minimum httpd log level.

max_clients:
    description:
    - Sets the maximum number of clients that can connect to the GUI at once.

hostname_lookup:
    description:
    - Sets whether or not to display the hostname, if possible.
    type: bool

fast_cgi_timeout:
    description:
    - Sets the timeout of FastCGI.

auth_pam_validate_ip:
    description:
    - Sets the authPamValidateIp setting.
    type: bool

auth_pam_idle_timeout:
    description:
    - Sets the GUI timeout for automatic logout, in seconds.

redirect_http_to_https:
    description:
    - Whether or not to redirect http requests to the GUI to https.
    type: bool

auth_pam_dashboard_timeout:
    description:
    - Sets whether or not the BIG-IP dashboard will timeout.
    type: bool

Outputs

auth_name:
  description: The new authentication realm name.
  returned: changed
  sample: foo
  type: string
auth_pam_dashboard_timeout:
  description: Whether or not the BIG-IP dashboard will timeout.
  returned: changed
  sample: false
  type: bool
auth_pam_idle_timeout:
  description: The new number of seconds for GUI timeout.
  returned: changed
  sample: 1200
  type: string
auth_pam_validate_ip:
  description: The new authPamValidateIp setting.
  returned: changed
  sample: true
  type: bool
fast_cgi_timeout:
  description: The new timeout of FastCGI.
  returned: changed
  sample: 500
  type: int
hostname_lookup:
  description: Whether or not to display the hostname, if possible.
  returned: changed
  sample: true
  type: bool
log_level:
  description: The new minimum httpd log level.
  returned: changed
  sample: crit
  type: string
max_clients:
  description: The new maximum number of clients that can connect to the GUI at once.
  returned: changed
  sample: 20
  type: int
redirect_http_to_https:
  description: Whether or not to redirect http requests to the GUI to https.
  returned: changed
  sample: true
  type: bool
ssl_port:
  description: The new HTTPS port to listen on.
  returned: changed
  sample: 10443
  type: int