f5networks.f5_modules.bigip_firewall_schedule module – Manage BIG-IP AFM schedule configurations
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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 f5networks.f5_modules 1.0.0
Synopsis
Manage BIG-IP AFM (Avanced Firewall Manager) schedule configurations.
Parameters
Parameter |
Comments |
---|---|
Specifies the time of day the rule will stop being used. When not defined, the default of The time zone is always assumed to be UTC and values must be provided as |
|
Specifies the time of day the rule will start to be in use. The value must be a time before When not defined, the default of When the value is set to The time zone is always assumed to be UTC and values must be provided as |
|
Specifies the end date/time this schedule will apply to the rule. The date must be after When not defined, the default of The time zone is always assumed to be UTC. The datetime format should always be in |
|
Specifies the start date/time this schedule will apply to the rule. When not defined the default of The time zone is always assumed to be UTC. The datetime format should always be in |
|
Specifies which days of the week the rule will be applied. When not defined, the default value of The Choices:
|
|
Specifies the user defined description text. |
|
Specifies the name of the AFM schedule configuration. |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
When When Choices:
|
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 |
Description |
---|---|
The time of day the rule will stop being used. Returned: changed Sample: |
|
The time of day the rule will start to be in use. Returned: changed Sample: |
|
The end date/time schedule will apply to the rule. Returned: changed Sample: |
|
The start date/time schedule will apply to the rule. Returned: changed Sample: |
|
The days of the week the rule will be applied. Returned: changed Sample: |
|
The user defined description text. Returned: changed Sample: |