f5networks.f5_modules.bigiq_application_fasthttp module – Manages BIG-IQ FastHTTP applications
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
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_fasthttp
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages BIG-IQ applications used for load balancing an HTTP-based application, speeding up connections and reducing the number of connections to the back-end server.
Parameters
Parameter |
Comments |
---|---|
Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a Choices:
|
|
Description of the application. |
|
Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTP endpoint of the application. |
|
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: |
|
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 or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ 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: |
|
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 or the BIG-IQ. 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:
|
|
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. When creating a new application and specifying a server, if this parameter is not provided, the default is Default: |
|
Specifies the name of the service environment to which the application is. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial you maintain unique names for items in the different service environment types (at this time, SSGs and BIGIPs). |
|
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 support updating of your application (whether deployed or not). If you need to update the application, we recommended removing and re-creating it.
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: BIG-IQ CM an HTTP application on port 80 on BIG-IP
bigiq_application_fasthttp:
name: my-app
description: Fast HTTP
service_environment: my-ssg
servers:
- address: 1.2.3.4
port: 8080
- address: 5.6.7.8
port: 8080
inbound_virtual:
name: foo
address: 2.2.2.2
netmask: 255.255.255.255
port: 80
provider:
password: secret
server: cm.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: |
|
The destination of the virtual that was created. Returned: changed Sample: |
|
The network mask of the provided inbound destination. Returned: changed Sample: |
|
The port on which the inbound virtual address listens. Returned: changed Sample: |
|
List of servers and their ports that make up the application. Returned: changed Sample: |
|
The IP address of the server. Returned: changed Sample: |
|
The port the server listens on. Returned: changed Sample: |
|
The environment to which the service was deployed. Returned: changed Sample: |