f5networks.f5_modules.bigip_timer_policy module – Manage timer policies on a BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.39.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in f5networks.f5_modules 1.0.0

Synopsis

  • Manage timer policies on a BIG-IP system.

Parameters

Parameter

Comments

description

string

Specifies descriptive text that identifies the timer policy.

name

string / required

Specifies the name of the timer policy.

partition

string

Device partition to manage resources on.

Default: "Common"

provider

dictionary

added in f5networks.f5_modules 1.0.0

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

If yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • false ← (default)

  • true

password

aliases: pass, pwd

string / required

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 F5_PASSWORD.

server

string / required

The BIG-IP host or the BIG-IQ host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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

Configures the transport connection to use when connecting to the remote device.

Choices:

  • "rest" ← (default)

user

string / required

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 F5_USER.

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

rules

list / elements=dictionary

Rules you want assigned to the timer policy.

destination_ports

list / elements=string

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 sctp, tcp, or udp protocol.

idle_timeout

string

Specifies an idle timeout, in seconds, for protocol and port pairs that match the timer policy rule.

When 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 unspecified.

Default: "unspecified"

name

string / required

The name of the rule.

protocol

string

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 is all-other.

Choices:

  • "all-other" ← (default)

  • "ah"

  • "bna"

  • "esp"

  • "etherip"

  • "gre"

  • "icmp"

  • "ipencap"

  • "ipv6"

  • "ipv6-auth"

  • "ipv6-crypt"

  • "ipv6-icmp"

  • "isp-ip"

  • "mux"

  • "ospf"

  • "sctp"

  • "tcp"

  • "udp"

  • "udplite"

state

string

When present, ensures the resource exists.

When absent, ensures the resource is removed.

Choices:

  • "present" ← (default)

  • "absent"

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 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

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

description

string

The new description of the timer policy.

Returned: changed

Sample: "True"

Authors

  • Tim Rupp (@caphrim007)