iCall::TriggeredHandler¶
Introduced : BIG-IP_v11.3.0
The TriggeredHandler interface allows you to create or delete
event-triggered handlers. These handlers contain a set of objects
called subscriptions; a subscription registers interest in an event of
a certain name. Each subscription also may optionally include a list
of filters to further reduce the set of events that come in. For
example, if a subscription exists to an event indicating that a pool
member goes down, then the filters might be set up to restrict
interest to pool members in a certain subnet. Triggered handlers do
not keep state between instances of their scripts running. If you
would like state to be saved, see the PerpetualHandler interface.
Methods¶
| Method | Description | Introduced |
| add_filter | Add the specified filters to the specified subscriptions. The initial match algorithms for these filters will all be MATCH_ALGORITHM_EXACT. | BIG-IP_v11.3.0 |
| add_subscription | Add new subscriptions to triggered handlers. | BIG-IP_v11.3.0 |
| create | Creates new triggered handlers. | BIG-IP_v11.3.0 |
| delete_all_handlers | Deletes all user-defined (non-root) triggered handlers. | BIG-IP_v11.3.0 |
| delete_handler | Deletes the specified triggered handlers. | BIG-IP_v11.3.0 |
| get_description | Gets the descriptions for the specified triggered handlers. | BIG-IP_v11.3.0 |
| get_filter | Gets a list of filter names for the specified subscriptions. | BIG-IP_v11.3.0 |
| get_filter_match_algorithm | Get the match algorithms for the specified filters. | BIG-IP_v11.3.0 |
| get_filter_value | Get the values for the specified filters. | BIG-IP_v11.3.0 |
| get_handler_state | Gets the states for the specified triggered handlers. | BIG-IP_v11.3.0 |
| get_list | Gets the list of triggered handlers. | BIG-IP_v11.3.0 |
| get_script | Gets the scripts for the specified triggered handlers. | BIG-IP_v11.3.0 |
| get_subscription | Gets a list of subscriptions. | BIG-IP_v11.3.0 |
| get_subscription_event | Get the event names from the specified subscriptions. | BIG-IP_v11.3.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.3.0 |
| remove_all_filters | Remove all filters from the given subscriptions. | BIG-IP_v11.3.0 |
| remove_all_subscriptions | Remove all subscriptions from triggered handlers. | BIG-IP_v11.3.0 |
| remove_filter | Remove filters from the given subscriptions. | BIG-IP_v11.3.0 |
| remove_subscription | Remove subscriptions from triggered handlers. | BIG-IP_v11.3.0 |
| set_description | Sets the description for the specified triggered handlers. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_filter_match_algorithm | Set the match algorithms for the specified filters. | BIG-IP_v11.3.0 |
| set_filter_value | Set the values for the specified filters. | BIG-IP_v11.3.0 |
| set_handler_state | Sets the states for the specified triggered handlers. This field describes whether the handler is running and accepting events. | BIG-IP_v11.3.0 |
| set_script | Sets the script for the specified triggered handlers. This is the name of a Tcl script that will be run when an event to which this handler subscribes fires. | BIG-IP_v11.3.0 |
| set_subscription_event | Set the event names for the specified subscriptions. | 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.