New in version 2.6.
The below requirements are needed on the host that executes this module.
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
F5_PASSWORD .aliases: pass, pwd |
||
provider
(added in 2.5) |
Default: None
|
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 . |
|
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
bool |
|
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 . |
|
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.
|
|
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 . |
||
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
rules |
Rules that you want assigned to the timer policy
|
||
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
tcp , udp or sctp .Only flows matching the configured protocol will make use of this rule.
When
all-other is specified, if there are no specific ip-protocol rules that match the flow, the flow matches all the other ip-protocol rules.When specifying rules, if this parameter is not specified, the default of
all-other will be used. |
|
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
sctp , tcp , or udp protocol. |
||
idle_timeout |
Specifies an idle timeout, in seconds, for protocol and port pairs that match the timer policy rule.
When
infinite , specifies that the protocol and port pairs that match the timer policy rule have no idle timeout.When specifying rules, if this parameter is not specified, the default of
unspecified will be used. |
||
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 |
|
When
present , ensures that the resource exists.When
absent , ensures the resource is removed. |
|
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
bool (added in 2.0) |
|
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 . |
Note
pip install f5-sdk
.- 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
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
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.