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

New in version 2.2.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Manage iRules across different modules on a BIG-IP.

Requirements ¶

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.9

Parameters ¶

Parameter	Choices/Defaults	Comments
content		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 required	Choices: ltm gtm	The BIG-IP module to add the iRule to.
name required		The name of the iRule.
partition (added in 2.5)	Default: Common	Device partition to manage resources on.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
provider (added in 2.5)		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. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
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 can omit this option if the environment variable `F5_SERVER` is set.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
validate_certs	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
src required		The iRule file to interpret and upload to the BIG-IP. Either one of `src` or `content` must be provided.
state	Choices: present ← absent	Whether the iRule should exist or not.
user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

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.

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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Add the iRule contained in static file irule.tcl to the LTM module
  bigip_irule:
    module: ltm
    name: MyiRule
    password: secret
    server: lb.mydomain.com
    src: irule.tcl
    state: present
    user: admin
  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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Tim Rupp (@caphrim007)

Hint

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