You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

f5networks.f5_modules.bigiq_application_http module – Manages BIG-IQ HTTP applications

Note

This module is part of the f5networks.f5_modules collection (version 1.17.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_http.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis 

Manages BIG-IQ applications used for load balancing an HTTP application on port 80 on BIG-IP systems.

Parameters 

Parameter	Comments
add_analytics boolean	Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. Choices: no ← (default) yes
description string	Description of the application.
inbound_virtual dictionary	Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTP endpoint of the application.
address string / required	Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application.
netmask string / required	Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application.
port string	The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `80`. Default: 80
name string / required	Name of the new application.
provider dictionary added in 1.0.0 of f5networks.f5_modules	A dict object containing connection details.
auth_provider string	Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
no_f5_teem boolean	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. Choices: no ← (default) yes
password aliases: pass, pwd string / required	The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`.
server string / required	The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port integer	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. Default: 443
timeout integer	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 string	Configures the transport connection to use when connecting to the remote device. Choices: rest ← (default)
user string / 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 `F5_USER`.
validate_certs boolean	If `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 `F5_VALIDATE_CERTS`. Choices: no yes ← (default)
servers list / elements=dictionary	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.
address string / required	The IP address of the server.
port string	The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default is `80`. Default: 80
service_environment string	Specifies the name of service environment to which the application is deployed. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial that you maintain unique names for items in the different service environment types (at this time, SSGs and BIG-IPs).
state string	The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. Choices: absent present ← (default)
wait boolean	If the module should wait for the application to be created, deleted, or updated. Choices: no yes ← (default)

Notes 

Note

This module does not support updating of your application (whether deployed or not). If you need to update the application, we recommend removing and recreating it.
This module will 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 HTTP application on port 80 on BIG-IP
  bigiq_application_http:
    name: my-app
    description: Redirect HTTP to HTTPS
    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: 443
    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
description string	The new description of the application of the resource. Returned: changed Sample: “My application”
inbound_virtual_destination string	The destination of the virtual that was created. Returned: changed Sample: “6.7.8.9”
inbound_virtual_netmask string	The network mask of the provided inbound destination. Returned: changed Sample: “255.255.255.0”
inbound_virtual_port integer	The port on which the inbound virtual address listens. Returned: changed Sample: 80
servers complex	List of servers, and their ports, that make up the application. Returned: changed Sample: “hash/dictionary of values”
address string	The IP address of the server. Returned: changed Sample: “2.3.4.5”
port integer	The port on which the server listens. Returned: changed Sample: 8080
service_environment string	The environment to which the service was deployed. Returned: changed Sample: “my-ssg1”

Authors

Tim Rupp (@caphrim007)

Collection links

Issue Tracker Homepage Repository (Sources)

f5networks.f5_modules.bigiq_application_http module – Manages BIG-IQ HTTP applications

Synopsis

Parameters

Notes

Examples

Return Values