bigiq_application_https_waf – Manages BIG-IQ HTTPS WAF applications
bigiq_application_https_waf – Manages BIG-IQ HTTPS WAF applications
New in version 2.6.
Synopsis
- Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with a Web Application Firewall (WAF) using an ASM Rapid Deployment policy.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
add_analytics boolean |
|
Collects statistics of the BIG-IP that the application is deployed to. This parameter is only relevant when specifying a | ||
client_ssl_profile - |
Specifies the SSL profile for managing client-side SSL traffic. | |||
cert_key_chain - |
One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain/passphrase combination. Note that BIG-IPs can only have one of each type of each certificate/key type. This means that you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device will reject this. This list is a complex list that specifies a number of keys. When creating a new profile, if this parameter is not specified, the default value of | |||
cert - / required |
Specifies a cert name for use. | |||
chain - |
Specifies a certificate chain that is relevant to the certificate and key mentioned earlier. This key is optional. | |||
key - / required |
Specifies a key name. | |||
passphrase - |
Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device. | |||
name - |
The name of the client SSL profile to created and used. When creating a new application, if this value is not specified, the default value of | |||
description - |
Description of the application. | |||
domain_names - |
Specifies host names that are used to access the web application that this security policy protects. When creating a new application, this parameter is required. | |||
inbound_virtual - |
Settings to configure the virtual which will receive the inbound connection. This virtual will be used to host the HTTPS endpoint of the application. Traffic destined to the | |||
address - |
Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. | |||
netmask - |
Specifies the netmask to associate with the given This parameter is required when creating a new application. | |||
port - |
Default: 443 |
The port that the virtual listens for connections on. When creating a new application, if this parameter is not specified, the default value of | ||
name - / required |
Name of the new application. | |||
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| |||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | ||
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| |||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | |||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | ||
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | |||
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. | ||
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | ||
user - / 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 | |||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | ||
redirect_virtual - |
Settings to configure the virtual which will receive the connection to be redirected. This virtual will be used to host the HTTP endpoint of the application. Traffic destined to this parameter will be offloaded to the | |||
address - |
Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. | |||
netmask - |
Specifies the netmask to associate with the given This parameter is required when creating a new application. | |||
port - |
Default: 80 |
The port that the virtual listens for connections on. When creating a new application, if this parameter is not specified, the default value of | ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | |||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | ||
servers - |
A list of servers that the application is hosted on. If you are familiar with other BIG-IP setting, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. | |||
address - |
The IP address of the server. | |||
port - |
Default: 80 |
The port of the server. | ||
service_environment - |
Specifies the name of service environment that the application will be deployed to. When creating a new application, this parameter is required. | |||
state - |
|
The state of the resource on the system. When When | ||
user - / 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 | |||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable | ||
wait boolean |
|
If the module should wait for the application to be created, deleted or updated. |
Notes
Note
- 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
. - 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 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: Load balance an HTTPS application on port 443 with a WAF using ASM
bigiq_application_https_waf:
name: my-app
description: Redirect HTTP to HTTPS via WAF
service_environment: my-ssg
servers:
- address: 1.2.3.4
port: 8080
- address: 5.6.7.8
port: 8080
inbound_virtual:
address: 2.2.2.2
netmask: 255.255.255.255
port: 443
redirect_virtual:
address: 2.2.2.2
netmask: 255.255.255.255
port: 80
provider:
password: secret
server: lb.mydomain.com
user: admin
state: present
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
description string |
changed |
The new description of the application of the resource.
Sample: My application | |
inbound_virtual_destination string |
changed |
The destination of the virtual that was created.
Sample: 6.7.8.9 | |
inbound_virtual_netmask string |
changed |
The network mask of the provided inbound destination.
Sample: 255.255.255.0 | |
inbound_virtual_port integer |
changed |
The port the inbound virtual address listens on.
Sample: 80 | |
servers complex |
changed |
List of servers, and their ports, that make up the application.
Sample: hash/dictionary of values | |
address string |
changed |
The IP address of the server.
Sample: 2.3.4.5 | |
port integer |
changed |
The port that the server listens on.
Sample: 8080 | |
service_environment string |
changed |
The environment which the service was deployed to.
Sample: my-ssg1 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigiq_application_https_waf_module.html