bigip_policy_rule – Manage LTM policy rules on a BIG-IP
bigip_policy_rule – Manage LTM policy rules on a BIG-IP
New in version 2.5.
Synopsis
- This module will manage LTM policy rules on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- BIG-IP >= v12.1.0
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
actions - |
The actions that you want the policy rule to perform. The available attributes vary by the action, however, each action requires that a These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special. | ||
asm_policy - |
ASM policy to enable. This parameter is only valid with the | ||
pool - |
Pool that you want to forward traffic to. This parameter is only valid with the | ||
type - / required |
|
The action type. This value controls what below options are required. When When When | |
virtual - |
Virtual Server that you want to forward traffic to. This parameter is only valid with the | ||
conditions - |
A list of attributes that describe the condition. See suboptions for details on how to construct each list entry. The ordering of this list is important, the module will ensure the order is kept when modifying the task. The suboption options listed below are not required for all condition types, read the description for more details. These conditions can be specified in any order. Despite them being a list, the BIG-IP does not treat their order as anything special. | ||
path_begins_with_any - |
A list of strings of characters that the HTTP URI should start with. This parameter is only valid with the | ||
type - / required |
|
The condition type. This value controls what below options are required. When When | |
description - |
Description of the policy rule. | ||
name - / required |
The name of the rule. | ||
partition - |
Default: "Common" |
Device partition to manage resources on. | |
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
| ||
policy - / required |
The name of the policy that you want to associate this rule with. | ||
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
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
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 |
|
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
When | |
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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
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: Create policies
bigip_policy:
name: Policy-Foo
state: present
delegate_to: localhost
- name: Add a rule to the new policy
bigip_policy_rule:
policy: Policy-Foo
name: rule3
conditions:
- type: http_uri
path_begins_with_any: /ABC
actions:
- type: forward
pool: pool-svrs
delegate_to: localhost
- name: Add multiple rules to the new policy
bigip_policy_rule:
policy: Policy-Foo
name: "{{ item.name }}"
conditions: "{{ item.conditions }}"
actions: "{{ item.actions }}"
delegate_to: localhost
loop:
- name: rule1
actions:
- type: forward
pool: pool-svrs
conditions:
- type: http_uri
path_starts_with: /euro
- name: rule2
actions:
- type: forward
pool: pool-svrs
conditions:
- type: http_uri
path_starts_with: /HomePage/
- name: Remove all rules and confitions from the rule
bigip_policy_rule:
policy: Policy-Foo
name: rule1
conditions:
- type: all_traffic
actions:
- type: ignore
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
actions complex |
changed |
The new list of actions applied to the rule
Sample: hash/dictionary of values | |
pool string |
changed |
Pool for forward to
Sample: foo-pool | |
type string |
changed |
The action type
Sample: forward | |
conditions complex |
changed |
The new list of conditions applied to the rule.
Sample: hash/dictionary of values | |
path_begins_with_any list |
changed |
List of strings that the URI begins with.
Sample: ['foo', 'bar'] | |
type string |
changed |
The condition type.
Sample: http_uri | |
description string |
changed |
The new description of the rule.
Sample: My rule |
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_policy_rule_module.html