Docs4dev
Docs
ansible / latest / collections / f5networks / f5_modules / bigip_firewall_schedule_module.html

f5networks.f5_modules.bigip_firewall_schedule – Manage BIG-IP AFM schedule configurations

Note

This plugin is part of the f5networks.f5_modules collection (version 1.12.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_firewall_schedule.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manage BIG-IP AFM (Avanced Firewall Manager) schedule configurations.

Parameters

Parameter Choices/Defaults Comments
daily_hour_end
string
Specifies the time of day the rule will stop being used.
When not defined, the default of 24:00 is used when creating a new schedule.
The time zone is always assumed to be UTC and values must be provided as HH:MM using 24hour clock format.
daily_hour_start
string
Specifies the time of day the rule will start to be in use.
The value must be a time before daily_hour_end.
When not defined, the default of 0:00 is used when creating a new schedule.
When the value is set to all-day both daily_hour_end and daily_hour_start are reset to their respective defaults.
The time zone is always assumed to be UTC and values must be provided as HH:MM using 24hour clock format.
date_valid_end
string
Specifies the end date/time this schedule will apply to the rule.
The date must be after date_valid_start
When not defined, the default of indefinite is used when creating a new schedule.
The time zone is always assumed to be UTC.
The datetime format should always be in YYYY-MM-DD:HH:MM:SS format.
date_valid_start
string
Specifies the start date/time this schedule will apply to the rule.
When not defined the default of epoch is used when creating a new schedule.
The time zone is always assumed to be UTC.
The datetime format should always be in YYYY-MM-DD:HH:MM:SS format.
days_of_week
list / elements=string
    Choices:
  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • all
Specifies which days of the week the rule will be applied.
When not defined, the default value of all is used when creating a new schedule.
The all value is mutually exclusive with other choices.
description
string
Specifies the user defined description text.
name
string / required
Specifies the name of the AFM schedule configuration.
partition
string
Default:
"Common"
Device partition to manage resources on.
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_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
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 resource exists.
When absent, ensures the resource is removed.

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 6 hour two day schedule, no start/end date
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: 13:00
    daily_hour_end: 19:00
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a seven day schedule with start/end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "{{ lookup('pipe','date -d \"now + 7 days\" +%Y-%m-%d:%H:%M:%S') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify created schedule to all-day
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: all-day
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a schedule to have no end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "indefinite"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove created schedule
  bigip_firewall_schedule:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      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
daily_hour_end
string
changed
The time of day the rule will stop being used.

Sample:
18:00
daily_hour_start
string
changed
The time of day the rule will start to be in use.

Sample:
13:00
date_valid_end
string
changed
The end date/time schedule will apply to the rule.

Sample:
2019-03-11:15:30:00
date_valid_start
string
changed
The start date/time schedule will apply to the rule.

Sample:
2019-03-01:15:30:00
days_of_week
list / elements=string
changed
The days of the week the rule will be applied.

Sample:
['monday', 'tuesday']
description
string
changed
The user defined description text.

Sample:
Foo is bar


Authors

  • Wojciech Wypior (@wojtek0806)

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