Steampunk Ansible Documentation - f5networks.f5_modules.bigip_timer_policy (1.28.0) - module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage timer policies on a BIG-IP system.

Usage examples

Scanned by Steampunk Spotter

- 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
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Remove a timer policy and all its associated rules
  bigip_timer_policy:
    name: timer1
    description: My timer policy
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Inputs

name:
description:
- Specifies the name of the timer policy.
required: true
type: str

rules:
description:
- Rules you want assigned to the timer policy.
elements: dict
suboptions:
destination_ports:
description:
- The list of destination ports on which to match the rule.
- Specify a port range by specifying start and end ports separated by a dash (-).
- This field is only available if you have selected the C(sctp), C(tcp), or C(udp)
protocol.
elements: str
type: list
idle_timeout:
default: unspecified
description:
- Specifies an idle timeout, in seconds, for protocol and port pairs that match
the timer policy rule.
- When C(infinite), specifies 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 is C(unspecified).
type: str
name:
description:
- The name of the rule.
required: true
type: str
protocol:
choices:
- all-other
- ah
- bna
- esp
- etherip
- gre
- icmp
- ipencap
- ipv6
- ipv6-auth
- ipv6-crypt
- ipv6-icmp
- isp-ip
- mux
- ospf
- sctp
- tcp
- udp
- udplite
default: all-other
description:
- Specifies the IP protocol entry for which the timer policy rule is being configured.
This could be a layer-4 protocol (such as C(tcp), C(udp) or C(sctp).
- Only flows matching the configured protocol will make use of this rule.
- When C(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 is C(all-other).
type: str
type: list

state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the resource exists.
- When C(absent), ensures the resource is removed.
type: str

provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules

partition:
default: Common
description:
- Device partition to manage resources on.
type: str

description:
description:
- Specifies descriptive text that identifies the timer policy.
type: str

Outputs

description:
  description: The new description of the timer policy.
  returned: changed
  sample: true
  type: str