Security::FirewallWeeklySchedule

Introduced : BIG-IP_v11.3.0
The FirewallWeeklySchedule interface enables you to set a schedule at which firewall rules are active, based on days of the week as well as times of day. You can also set a date and time at which the schedule begins and ceases to be valid.

Methods

Method Description Introduced
create Creates a firewall weekly schedule. BIG-IP_v11.3.0
delete_all_weekly_schedules Deletes all firewall weekly schedules on this device. BIG-IP_v11.3.0
delete_weekly_schedule Deletes a set of firewall weekly schedules. BIG-IP_v11.3.0
get_daily_hour_end Gets the time of day, in hours and minutes, that the specified firewall weekly schedules cease to be active. BIG-IP_v11.3.0
get_daily_hour_start Gets the time of day, in hours and minutes, that the specified firewall weekly schedules begin to be active. BIG-IP_v11.3.0
get_date_valid_end Gets the dates at which the specified firewall weekly schedules are no longer valid. BIG-IP_v11.3.0
get_date_valid_start Gets the start dates at which the specified firewall weekly schedules are valid. BIG-IP_v11.3.0
get_days_of_week Gets the days of the week that the specified firewall weekly schedules are active. BIG-IP_v11.3.0
get_description Gets the descriptions for a set of firewall weekly schedules. BIG-IP_v11.3.0
get_list Gets the list of firewall weekly schedules on this device. BIG-IP_v11.3.0
get_version Gets the version information for this interface. BIG-IP_v11.3.0
set_daily_hour_end Sets the time of day, in hours and minutes, that the specified firewall weekly schedules cease to be active. It ceases to be active at this time on all days of the week specified in get/set_days_of_week; if you would like to have certain days active at different times, you will need to create a separate weekly schedule. BIG-IP_v11.3.0
set_daily_hour_start Sets the time of day, in hours and minutes, that the specified firewall weekly schedules begin to be active. It becomes active at this time on all days of the week specified in get/set_days_of_week; if you would like to have certain days active at different times than others, you will need to create a separate weekly schedule. Note that daily_hour_start cannot be set to later than daily_hour_end, so daily_hour_end must be set first. BIG-IP_v11.3.0
set_date_valid_end Sets the dates at which the specified firewall weekly schedules are no longer valid, as a TimeStampExpiry. If the expires flag in the TimeStampExpiry is set to false, the weekly schedule does not expire. Otherwise, the expiry_time field specifies the date and time at which the specified weekly schedules will cease to be valid. Note that if expires is set to false, any value held in expiry_time will be lost. BIG-IP_v11.3.0
set_date_valid_start Sets the start dates at which the specified firewall weekly schedules are valid, as a TimeStamp. This is the date and time at which the specified wekly schedule will begin to be valid. BIG-IP_v11.3.0
set_days_of_week Sets the days of the week that the specified firewall weekly schedules are active. If a sequence of FWWeekDays contains duplicates (eg. [&aposFW_SUNDAY&apos, &aposFW_SUNDAY&apos]) these will be deduplicated. You must set at least one weekday for the schedule to be valid; &aposnone&apos or no days is not acceptable. Note also that if setting FW_ALL_DAYS, a subsequent query will return all seven days, rather than one FW_ALL_DAYS value. BIG-IP_v11.3.0
set_description Sets the description for a set of firewall weekly schedules. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.3.0

Structures

Structure

Description

DailyTime

A struct describing a time of day in hours/minutes.


Enumerations

Enumeration Description
FWWeekDay An enum describing days of the week, for use in weekly schedules.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
DailyTimeSequence DailyTime [] A sequence of daily times.
FWWeekDaySequence FWWeekDay [] A sequence of firewall week days.
FWWeekDaySequenceSequence FWWeekDay [] [] A sequence of firewall week day sequences.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.