f5networks.f5_modules.bigiq_application_fastl4_tcp – Manages BIG-IQ FastL4 TCP applications

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigiq_application_fastl4_tcp.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manages BIG-IQ applications used for load balancing a TCP-based application with a FastL4 profile.

Parameters

Parameter Choices/Defaults Comments
add_analytics
boolean
    Choices:
  • no ←
  • yes
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.
description
string
Description of the application.
inbound_virtual
dictionary
Settings to configure the virtual which will receive the inbound connection.
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
Default:
8080
The port on which the virtual listens for connections.
When creating a new application, if this parameter is not specified, the default value is 8080.
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
    Choices:
  • no
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM.
password
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.

aliases: pass, pwd
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
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
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
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
    Choices:
  • no
  • yes ←
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.
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
Default:
8000
The port of the server.
When creating a new application and specifying a server, if this parameter is not provided, the default is 8000.
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.
SSGs are not supported for this type of application.
state
string
    Choices:
  • absent
  • present ←
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.
wait
boolean
    Choices:
  • no
  • yes ←
If the module should wait for the application to be created, deleted, or updated.

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 re-creating 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 a TCP-based application with a FastL4 profile
  bigiq_application_fastl4_tcp:
    name: my-app
    description: My description
    service_environment: my-bigip-device
    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 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 on which the inbound virtual address listens.

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 on which the server listens.

Sample:
8080
service_environment
string
changed
The environment to which the service was deployed.

Sample:
my-ssg1


Authors

  • Tim Rupp (@caphrim007)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigiq_application_fastl4_tcp_module.html