bigip_irule – Manage iRules across different modules on a BIG-IP

Synopsis

• Manage iRules across different modules on a BIG-IP.

Parameters

Parameter		Choices/Defaults	Comments
content string			When used instead of 'src', sets the contents of an iRule directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. Either one of src or content must be provided.
module string / required		Choices: ltm gtm	The BIG-IP module to add the iRule to.
name string / required			The name of the iRule.
partition string added in 2.5		Default: "Common"	Device partition to manage resources on.
provider dictionary added in 2.5			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.
	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.
	ssh_keyfile path		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 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: cli 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.
src path / required			The iRule file to interpret and upload to the BIG-IP. Either one of src or content must be provided.
state string		Choices: present ← absent	Whether the iRule should exist or not.

Notes

Note

• 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 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: Add the iRule contained in template irule.tcl to the LTM module
  bigip_irule:
    content: "{{ lookup('template', 'irule.tcl') }}"
    module: ltm
    name: MyiRule
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add the iRule contained in static file irule.tcl to the LTM module
  bigip_irule:
    module: ltm
    name: MyiRule
    src: irule.tcl
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
content string	changed and success	The content of the iRule that was managed Sample: when LB_FAILED { set wipHost [LB::server addr] }
module string	changed and success	The module that the iRule was added to Sample: gtm
src string	changed and success, when provided	The filename that included the iRule source Sample: /opt/src/irules/example1.tcl

Status

• This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
• This module is maintained by an Ansible Partner. [certified]

Authors

• Tim Rupp (@caphrim007)
• Wojciech Wypior (@wojtek0806)

Hint

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