bigiq_application_https_offload - Manages BIG-IQ HTTPS offload applications¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with SSL offloading on BIG-IP.

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 bool			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.
client_ssl_profile				Specifies the SSL profile for managing client-side SSL traffic.
	name			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 `clientssl` will be used.
	cert_key_chain			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. Note that BIG-IPs can only have one of each type of each certificate/key type. This means that 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 will reject this. 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 of `inherit` will be used.
		key required		Specifies a key name.
		cert required		Specifies a cert name for use.
		chain		Specifies a certificate chain that is relevant to the certificate and key mentioned earlier. This key is optional.
		passphrase		Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device.
description				Description of the application.
inbound_virtual				Settings to configure the virtual which will receive the inbound connection. This virtual will be used to host the HTTPS endpoint of the application. Traffic destined to the `redirect_virtual` will be offloaded to this parameter to ensure that proper redirection from insecure, to secure, occurs.
	netmask			Specifies the netmask to associate with the given `address`. This parameter is required when creating a new application.
	port		Default: 443	The port that the virtual listens for connections on. When creating a new application, if this parameter is not specified, the default value of `443` will be used.
	address			Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application.
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: None	A dict object containing connection details.
	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.
	server required			The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	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`.
	server_port		Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	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
	validate_certs bool		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`.
	transport required		Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
redirect_virtual				Settings to configure the virtual which will receive the connection to be redirected. This virtual will be used to host the HTTP endpoint of the application. Traffic destined to this parameter will be offloaded to the `inbound_virtual` parameter to ensure that proper redirection from insecure, to secure, occurs.
	netmask			Specifies the netmask to associate with the given `address`. This parameter is required when creating a new application.
	port		Default: 80	The port that the virtual listens for connections on. When creating a new application, if this parameter is not specified, the default value of `80` will be used.
	address			Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application.
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.
	port		Default: 80	The port of the server.
	address			The IP address of the server.
service_environment				Specifies the name of service environment or the hostname of the BIG-IP that the application will be deployed to. When creating a new application, this parameter is required.
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 bool (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 bool			Choices: no yes ←	If the module should wait for the application to be created, deleted or updated.

Notes ¶

Note

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 an HTTPS application on port 443 with SSL offloading on BIG-IP
  bigiq_application_https_offload:
    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:
      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		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 int		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
	port int	changed	The port that the server listens on. Sample: 8080
	address string	changed	The IP address of the server. Sample: 2.3.4.5
service_environment string		changed	The environment which the service was deployed to. Sample: my-ssg1

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author ¶

Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.