bigip_device_httpd - Manage HTTPD related settings on BIG-IP
Synopsis
- 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
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.9
- requests
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| allow |
| Specifies, if you have enabled HTTPD access, the IP address or address range for other systems that can communicate with this system. | |
| auth_name | Sets the BIG-IP authentication realm name. | ||
| auth_pam_dashboard_timeout |
| Sets whether or not the BIG-IP dashboard will timeout. | |
| auth_pam_idle_timeout | Sets the GUI timeout for automatic logout, in seconds. | ||
| auth_pam_validate_ip |
| Sets the authPamValidateIp setting. | |
| fast_cgi_timeout | Sets the timeout of FastCGI. | ||
| hostname_lookup |
| Sets whether or not to display the hostname, if possible. | |
| log_level |
| Sets the minimum httpd log level. | |
| max_clients | Sets the maximum number of clients that can connect to the GUI at once. | ||
| password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
| provider (added in 2.5) | Default: None | A dict object containing connection details. | |
| ssh_keyfile | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
| timeout | Default: 10 | 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. | |
| server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
| user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
| server_port | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
| password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
| validate_certs |
| If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | |
| transport required |
| Configures the transport connection to use when connecting to the remote device. | |
| redirect_http_to_https |
| Whether or not to redirect http requests to the GUI to https. | |
| server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
| server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
| ssl_port | The HTTPS port to listen on. | ||
| user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
| validate_certs (added in 2.0) |
| If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | |
Notes
Note
- Requires the requests Python package on the host. This is as easy as
pip install requests. - For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk.
Examples
- 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
- 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
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| auth_name string | changed | The new authentication realm name. Sample: foo |
| auth_pam_dashboard_timeout bool | changed | Whether or not the BIG-IP dashboard will timeout. |
| auth_pam_idle_timeout string | changed | The new number of seconds for GUI timeout. Sample: 1200 |
| auth_pam_validate_ip bool | changed | The new authPamValidateIp setting. Sample: True |
| fast_cgi_timeout int | changed | The new timeout of FastCGI. Sample: 500 |
| hostname_lookup bool | changed | Whether or not to display the hostname, if possible. Sample: True |
| log_level string | changed | The new minimum httpd log level. Sample: crit |
| max_clients int | changed | The new maximum number of clients that can connect to the GUI at once. Sample: 20 |
| redirect_http_to_https bool | changed | Whether or not to redirect http requests to the GUI to https. Sample: True |
| ssl_port int | changed | The new HTTPS port to listen on. Sample: 10443 |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Joe Reifel (@JoeReifel)
- Tim Rupp (@caphrim007)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_device_httpd_module.html