bigiq_application_fastl4_tcp – Manages BIG-IQ FastL4 TCP applications  New in version 2.6.   Synopsis Requirements Parameters Notes Examples Return Values Status  Synopsis  Manages BIG-IQ applications used for load balancing a TCP-based application with a FastL4 profile.  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    
Choices: 
no ← yes    Collects statistics of the BIG-IP that the application is deployed to. This parameter is only relevant when specifying a service_environment which is a BIG-IP; not an SSG.     description  -      Description of the application.     inbound_virtual  -      Settings to configure the virtual which will receive the inbound connection.      address  - / required      Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application.      netmask  - / required      Specifies the netmask to associate with the given destination. This parameter is required when creating a new application.      port  -    Default:8080   The port that the virtual listens for connections on. When creating a new application, if this parameter is not specified, the default value of 8080 will be used.     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 F5_PASSWORD. 
aliases: pass, pwd     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 F5_PASSWORD. 
aliases: pass, pwd      server  - / required      The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.      server_port  -    Default:443   The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT.      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 ANSIBLE_NET_SSH_KEYFILE.      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    
Choices: rest 
cli ←    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 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.     server  - / required      The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.     server_port  -  added in 2.2   Default:443   The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT.     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  - / required      The IP address of the server.      port  -    Default:8000   The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default of 8000 will be used.     service_environment  -      Specifies the name of service environment that the application will be deployed to. When creating a new application, this parameter is required. The service environment type will be discovered by this module automatically. 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  -    
Choices: absent 
present ←    The state of the resource on the system. When present, guarantees that the resource exists with the provided attributes. When absent, removes the resource from the system.     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 F5_USER.     validate_certs  boolean  added in 2.0   
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.     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, the recommended practice is to remove and re-create. Requires BIG-IQ version 6.0 or greater. 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 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: (209)981-8256
        port: 8080
      - address: (209)981-8256
        port: 8080
    inbound_virtual:
      name: foo
      address: (209)981-8256
      netmask: (209)981-8256
      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: (209)981-8256     inbound_virtual_netmask string  changed  The network mask of the provided inbound destination.  Sample: (209)981-8256     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: (209)981-8256       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)   Hint If you notice any issues in this documentation you can edit this document to improve it. 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.7/modules/bigiq_application_fastl4_tcp_module.html', 'source': 'DevDocs.IO'}