Management::EventSubscription¶
Methods¶
| Method | Description | Introduced |
| create | Create a new subscription. This takes an an input a list of subscription details, one for each subscription requested. | BIG-IP_v9.0 |
| create_v2 | Create a new subscription. This takes an an input a list of subscription details, one for each subscription requested. | BIG-IP_v11.0.0 |
| get_authentication | Gets the credentials for the URL&aposs associated with a set of subscription identifiers. | BIG-IP_v11.0.0 |
| get_available_event_types | Retrieve a list of event types available on this system. | BIG-IP_v9.0 |
| get_list | Retrieve the list of configured subscription identifiers. | BIG-IP_v9.0 |
| get_max_timeslice | Get the maximum timeslice (in seconds) between event notifications for the list of subscription identifiers. | BIG-IP_v9.0 |
| get_min_events_per_timeslice | Get the minimum number of events needed to trigger a notification message. | BIG-IP_v9.0 |
| get_proxy_url | Gets the proxy URL required for accessing the notification service for a set of subscriptions. | BIG-IP_v11.0.0 |
| get_state | Get the enabled state of a list of subscription identifiers. | BIG-IP_v9.0 |
| get_statistics | Get the statistics for the given list of subscription identifiers. | BIG-IP_v9.0 |
| get_ttl | Get the time to live (ttl) in seconds for the list of subscription identifiers. | BIG-IP_v9.0 |
| get_url | Get the url endpoint that implements the EventNotification interface. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| modify | Modify a list of subscriptions. This takes a list of subscription definitions representing the subscriptions that are to be modified. | BIG-IP_v9.0 |
| modify_v2 | Modify a list of subscriptions. This takes a list of subscription definitions representing the subscriptions that are to be modified. | BIG-IP_v11.0.0 |
| ping | A lightweight ping to determine the event notification service&aposs health. | BIG-IP_v9.0 |
| query | Retrieve the subscription definitions for a list of subscription identifiers. | BIG-IP_v9.0 |
| query_v2 | Retrieve the subscription definitions for a list of subscription identifiers. | BIG-IP_v11.0.0 |
| remove | Remove a list of subscriptions. This takes as input a list of subscription id&aposs and returns a list of status structures with the associated status code for each item in the id_list. | BIG-IP_v9.0 |
| reset_statistics | Reset the statistics for the given list of subscription identifiers. | BIG-IP_v9.0 |
| set_authentication | Set the credentials for the url&aposs associated with the given list of subscription identifiers. | BIG-IP_v9.0 |
| set_max_timeslice | Set the maximum timeslice (in seconds) between event notifications. This value is used to ensure that notifications are sent despite the minimum event attribute not reaching its threashold. | BIG-IP_v9.0 |
| set_min_events_per_timeslice | Set the minimum number of events needed to trigger a notification message. This value is used to force a notification message to occur even if the max timeslice attribute is not reached yet. | BIG-IP_v9.0 |
| set_proxy_url | Sets the proxy URL required for accessing the notification service for a set of subscriptions. | BIG-IP_v11.0.0 |
| set_state | Set the enabled state of a list of subscriptions identifiers | BIG-IP_v9.0 |
| set_ttl | Set the time to live (ttl) in seconds for the list of subscription identifiers. | BIG-IP_v9.0 |
| set_url | Set the url endpoint that implements the EventNotification interface. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A subscription definition. This includes a subscription identifier and the subscription details.
The configuration of a specific Event Subscription. This includes the name, registered events, the enabled state, and delivery configuration values. Event messages will be queued up and sent in a bulk manner as described by the min_events_per_timeslice and max_timeslice variables.
The configuration of a specific Event Subscription. This includes the name, registered events, the enabled state, and delivery configuration values. Event messages will be queued up and sent in a bulk manner as described by the min_events_per_timeslice and max_timeslice variables.
A set of statistics for a given subscription.
A struct containing a numeric and string representation of a given SubscriptionStatusCode.
A user credential included authentication mode, and optionally a username and password.
Enumerations¶
| Enumeration | Description |
| AuthenticationMode | The authentication modes used for http(s) based communications. |
| EventType | The category event that a given subscription is listening on. when the subscription sees an event occur that fits one of these flags, a notification is triggered. |
| ObjectType | The object types that are included in a event notification event. |
| SubscriptionStatusCode | Status codes specific to the EventSubscription interface. |
Aliases¶
| Alias | Type | Description |
| AuthenticationModeSequence | AuthenticationMode [] | A Sequence of AuthenticationMode enumeration values. |
| EventTypeSequence | EventType [] | A Sequence of EventType enumeration values. |
| ObjectTypeSequence | ObjectType [] | A Sequence of ObjectType enumeration values. |
| SubscriptionDefinitionSequence | SubscriptionDefinition [] | A Sequence of SubscriptionDefinition structures. |
| SubscriptionDefinitionV2Sequence | SubscriptionDefinitionV2 [] | A Sequence of SubscriptionDefinitionV2 structures. |
| SubscriptionDetailsSequence | SubscriptionDetails [] | A Sequence of SubscriptionDetails structures. |
| SubscriptionDetailsV2Sequence | SubscriptionDetailsV2 [] | A Sequence of SubscriptionDetailsV2 structures. |
| SubscriptionStatisticsSequence | SubscriptionStatistics [] | A Sequence of SubscriptionStatistics structures. |
| SubscriptionStatusCodeSequence | SubscriptionStatusCode [] | A Sequence of SubscriptionStatusCode enumeration values. |
| SubscriptionStatusSequence | SubscriptionStatus [] | A Sequence of SubscriptionStatus structures. |
| UserCredentialSequence | UserCredential [] | A Sequence of UserCredential structures. |
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.