W3cubDocs

/Ansible 2.11

f5networks.f5_modules.bigip_policy_rule – Manage LTM policy rules on a BIG-IP

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_policy_rule.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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

Parameters

Parameter		Choices/Defaults	Comments
actions list / elements=dictionary			The actions you want the policy rule to perform. The available attributes vary by the action, however, each action requires you specify a `type`. These conditions can be specified in any order. Despite the fact they are in a list, the order in the list does not matter to the BIG-IP.
	asm_policy string		ASM policy to enable. This parameter is only valid with the `enable` type.
	cookie_expiry integer added in 1.1.0 of f5networks.f5_modules		Optional argument, specifying the time for which the session will be persisted. This parameter is only valid with the `persist` type.
	cookie_insert string added in 1.1.0 of f5networks.f5_modules		Cookie name on which you want to persist. This parameter is only valid with the `persist` type.
	event string		Events on which actions, such as reset, can be triggered. With the `set_variable` action, it is used for specifying an action event, such as request or response.
	expression string		A tcl expression used with the `set_variable` action.
	location string		The new URL for which a redirect response will be sent. A Tcl command substitution can be used for this field.
	node string added in 1.2.0 of f5networks.f5_modules		Node to which you want to forward traffic. This parameter is only valid with the `forward` type.
	pool string		Pool to which you want to forward traffic. This parameter is only valid with the `forward` type.
	type string / required	Choices: forward enable ignore redirect reset persist set_variable	The action type. This value controls which of the following options are required. When `type` is `forward`, the system associates a given `pool`, or `virtual`, or `node` with this rule. When `type` is `enable`, the system associates a given `asm_policy` with this rule. When `type` is `ignore`, the system removes all existing actions from this rule. When `type` is `redirect`, the system redirects an HTTP request to a different URL. When `type` is `reset`, the system resets the connection upon `event`. When `type` is `persist`, the system associates `cookie_insert` and `cookie_expiry` with this rule. When `type` is `set_variable`, the system sets a variable based on the evaluated Tcl `expression` based on `event`.
	variable_name string		Variable name used with the `set_variable` action.
	virtual string		Virtual Server to which you want to forward traffic. This parameter is only valid with the `forward` type.
conditions list / elements=dictionary			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 the fact they are in a list, the order in the list does not matter to the BIG-IP.
	event string		Events on which conditions such as SSL Extension can be triggered.
	host_begins_with_any list / elements=string		A list of strings of characters the HTTP Host should start with. This parameter is only valid with the `http_host` type.
	host_is_any list / elements=string		A list of strings of characters the HTTP Host should match. This parameter is only valid with the `http_host` type.
	host_is_not_any list / elements=string		A list of strings of characters the HTTP Host should not match. This parameter is only valid with the `http_host` type.
	path_begins_with_any list / elements=string		A list of strings of characters the HTTP URI should start with. This parameter is only valid with the `http_uri` type.
	server_name_is_any list / elements=string		A list of strings of characters the SSL Extension should match. This parameter is only valid with the `ssl_extension` type.
	type string / required	Choices: http_uri all_traffic http_host ssl_extension	The condition type. This value controls which of the following options are required. When `type` is `http_uri`, the system associates a given `path_begins_with_any` list of strings with which the HTTP URI should begin. Any item in the list will provide a match. When `type` is `all_traffic`, the system removes all existing conditions from this rule.
description string			Description of the policy rule.
name string / required			The name of the rule.
partition string		Default: "Common"	Device partition to manage resources on.
policy string / required			The name of the policy you want to associate this rule with.
provider dictionary added in 1.0.0 of f5networks.f5_modules			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.
	no_f5_teem boolean	Choices: no yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TEEM`.
	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`.
	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: 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`.
state string		Choices: present ← absent	When `present`, ensures the key is uploaded to the device. When `absent`, ensures the key is removed from the device. If the key is currently in use, the module will not be able to remove the key.

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 f5networks.f5_modules.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
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  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
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  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 }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost
  loop:
    - name: rule1
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_begins_with_any:
            - /euro
    - name: rule2
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_begins_with_any:
            - /HomePage/
    - name: rule3
      actions:
        - type: set_variable
          variable_name: user-agent
          expression: tcl:[HTTP::header User-Agent]
          event: request
      conditions:
        - type: http_uri
          path_begins_with_any:
            - /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
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  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 forwarding 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 / elements=string	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

Authors

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)
Greg Crosby (@crosbygw)
Nitin Khanna (@nitinthewiz)
Andrey Kashcheev (@andreykashcheev)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_policy_rule_module.html