bigip_policy_rule – Manage LTM policy rules on a BIG-IP¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

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 `type` be specified. 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 `enable` type.
	pool -		Pool that you want to forward traffic to. This parameter is only valid with the `forward` type.
	type - / required	Choices: forward enable ignore	The action type. This value controls what below options are required. When `type` is `forward`, will associate a given `pool`, or `virtual` with this rule. When `type` is `enable`, will associate a given `asm_policy` with this rule. When `type` is `ignore`, will remove all existing actions from this rule.
	virtual -		Virtual Server that you want to forward traffic to. This parameter is only valid with the `forward` type.
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 `http_uri` type.
	type - / required	Choices: http_uri all_traffic	The condition type. This value controls what below options are required. When `type` is `http_uri`, will associate a given `path_begins_with_any` list of strings with which the HTTP URI should begin with. Any item in the list will provide a match. When `type` is `all_traffic`, will remove all existing conditions from this rule.
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 `F5_PASSWORD`. aliases: pass, pwd
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 `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`.
state -		Choices: present ← absent	When `present`, ensures that the key is uploaded to the device. When `absent`, ensures that the key is removed from the device. If the key is currently in use, the module will not be able to remove the key.
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`.

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)

Hint

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

bigip_policy_rule – Manage LTM policy rules on a BIG-IP¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶