bigip_timer_policy – Manage timer policies on a BIG-IP
bigip_timer_policy – Manage timer policies on a BIG-IP
New in version 2.6.
Synopsis
- Manage timer policies on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description - |
Specifies descriptive text that identifies the timer policy. | ||
name - / required |
Specifies the name of the timer policy. | ||
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
| ||
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 | |
rules - |
Rules that you want assigned to the timer policy | ||
destination_ports - |
The list of destination ports to match the rule on. Specify a port range by specifying start and end ports separated by a dash (-). This field is only available if you have selected the | ||
idle_timeout - |
Specifies an idle timeout, in seconds, for protocol and port pairs that match the timer policy rule. When When specifying rules, if this parameter is not specified, the default of | ||
name - / required |
The name of the rule. | ||
protocol - |
|
Specifies the IP protocol entry for which the timer policy rule is being configured. This could be a layer-4 protocol (such as Only flows matching the configured protocol will make use of this rule. When When specifying rules, if this parameter is not specified, the default of | |
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 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 a timer policy
bigip_timer_policy:
name: timer1
description: My timer policy
rules:
- name: rule1
protocol: tcp
idle_timeout: indefinite
destination_ports:
- 443
- 80
- name: rule2
protocol: 200
- name: rule3
protocol: sctp
idle_timeout: 200
destination_ports:
- 21
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove a timer policy and all its associated rules
bigip_timer_policy:
name: timer1
description: My timer policy
password: secret
server: lb.mydomain.com
state: absent
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 |
---|---|---|
description string |
changed |
The new description of the timer policy.
Sample: True |
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_timer_policy_module.html