iCall::PeriodicHandler¶
Introduced : BIG-IP_v11.3.0
The PeriodicHandler interface allows you to create or delete periodic
handlers. These handlers do not subscribe to events. Rather, they have
three parameters: a start and end time, and an interval in seconds.
The script attached to the handler will be run on the interval between
the start and end times.
Methods¶
| Method | Description | Introduced |
| create | Creates new periodic handlers. | BIG-IP_v11.3.0 |
| delete_all_handlers | Deletes all user-defined (non-root) periodic handlers. | BIG-IP_v11.3.0 |
| delete_handler | Deletes the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_description | Gets the descriptions for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_first_occurrence | Gets the first occurrences for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_handler_state | Gets the states for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_interval | Gets the interval for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_last_occurrence | Gets the last occurrence for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_list | Gets the list of periodic handlers. | BIG-IP_v11.3.0 |
| get_script | Gets the scripts for the specified periodic handlers. | BIG-IP_v11.3.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.3.0 |
| set_description | Sets the description for the specified periodic handlers. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_first_occurrence | Sets the first occurrence for the specified periodic handlers. This field tells the first time at which the handler will start its associated script. | BIG-IP_v11.3.0 |
| set_handler_state | Sets the states for the specified periodic handlers. This field describes whether the handler is running and accepting events. | BIG-IP_v11.3.0 |
| set_interval | Sets the interval for the specified periodic handlers. This field tells the interval, in seconds, at which the handler will start its associated script. | BIG-IP_v11.3.0 |
| set_last_occurrence | Sets the last occurrence for the specified periodic handlers. This field tells the last time at which the handler will start its associated script. | BIG-IP_v11.3.0 |
| set_script | Sets the script for the specified periodic handlers. This is the name of a Tcl script that will be run on the handler&aposs specified interval. | BIG-IP_v11.3.0 |
See Also¶
iControl ::
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.