Management::EventSubscription::SubscriptionDetails

Introduced : BIG-IP_v9.0
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.
Member Type Description
name String A user friendly name for the subscription.
event_type_list EventType [] A list of event types to be notified of.
url String The url endpoint for the EventNotification inteface to receive event notifications.
url_credentials UserCredential The credenials for the url endpoint.
ttl long The time to live (in seconds) for this subscription. After the ttl is reached, the subscription will be removed from the system. A value of -1 indicates an infinite life time.
min_events_per_timeslice long The minimum number of events needed to trigger a notification. If this value is 50, then this means that when 50 events are queued up they will be sent to the notification endpoint no matter what the max_timeslice is set to.
max_timeslice long This maximum time to wait (in seconds) before event notifications are sent to the notification endpoint. If this value is 30, then after 30 seconds a notification will be sent with the events in the subscription queue.
enabled_state EnabledState Whether the subscription is enabled or disabled.

See Also

iControl ::
iControl :: Management :: EventSubscription

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.