f5networks.f5_modules.bigiq_application_https_waf – Manages BIG-IQ HTTPS WAF applications
Note
This plugin is part of the f5networks.f5_modules collection (version 1.13.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.bigiq_application_https_waf
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with a Web Application Firewall (WAF) using an ASM (Application Security Manager) Rapid Deployment policy.
Parameters
Parameter |
Comments |
---|---|
Collects statistics of the BIG-IP that the application is deployed to. This parameter is only relevant when specifying a Choices:
|
|
Specifies the SSL profile for managing client-side SSL traffic. |
|
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. BIG-IPs can only have one of each type of each certificate/key type. This means 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 rejects it. 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 is |
|
Specifies a cert name for use. |
|
Specifies a certificate chain that is relevant to the certificate and key. This key is optional. |
|
Specifies a key name. |
|
Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device. |
|
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 Default: “clientssl” |
|
Description of the application. |
|
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. |
|
Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTPS endpoint of the application. Traffic destined to the |
|
Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. |
|
Specifies the netmask to associate with the given This parameter is required when creating a new application. |
|
The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is Default: 443 |
|
Name of the new application. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: 443 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Settings to configure the virtual which receives the connection to be redirected. This virtual is used to host the HTTP endpoint of the application. Traffic destined to this parameter is offloaded to the |
|
Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. |
|
Specifies the netmask to associate with the given This parameter is required when creating a new application. |
|
The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value of Default: 80 |
|
A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. |
|
The IP address of the server. |
|
The port of the server. Default: 80 |
|
Specifies the name of service environment the application will be deployed to. When creating a new application, this parameter is required. |
|
The state of the resource on the system. When When Choices:
|
|
If the module should wait for the application to be created, deleted, or updated. Choices:
|
Notes
Note
This module does not work on BIG-IQ version 6.1.x or greater.
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: 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 |
Description |
---|---|
The new description of the application of the resource. Returned: changed Sample: “My application” |
|
The destination of the virtual that was created. Returned: changed Sample: “6.7.8.9” |
|
The network mask of the provided inbound destination. Returned: changed Sample: “255.255.255.0” |
|
The port on which the inbound virtual address listens. Returned: changed Sample: 80 |
|
List of servers, and their ports, that make up the application. Returned: changed Sample: “hash/dictionary of values” |
|
The IP address of the server. Returned: changed Sample: “2.3.4.5” |
|
The port on which the server listens. Returned: changed Sample: 8080 |
|
The environment to which the service was deployed. Returned: changed Sample: “my-ssg1” |
Authors
Tim Rupp (@caphrim007)