System::PerformanceSFlow

Introduced : BIG-IP_v11.2.0
The Performance sFlow interface implements the sFlow monitoring standard. The monitoring has two major components: Packet Flow Sampling, a random selection of a fraction of the Packet Flows observed at a data source, and Counter Sampling, a periodic sampling or polling of counters associated with a data source. Samples are sent out, as soon as they are taken, with at most a second of intentional delay, to offline sFlow receivers, through UDP datagrams. It is the responsibility of receivers to maintain the collected data, in any proprietary format. sFlow analyzers, which understand the receivers or their storage format, could be used to analyze the collected data, to represent network usage, over a period of time. This interface allows you to configure one or more sFlow receivers, by providing the IPv4 or IPv6 address and port on which they are listening, along with maximum datagram size and datagram revision they support. One or more data sources can be selected to monitor for counter/packet-flow sampling along with sampling rate. Samples would start to flow to the offline receivers at a rate less than or equal to the set sampling rate.

Methods

Method Description Introduced
create Creates a set of sFlow receivers. BIG-IP_v11.2.0
delete_all_sflow_receivers Deletes all sFlow receivers on this device. BIG-IP_v11.2.0
delete_sflow_receiver Deletes a set of sFlow receivers. BIG-IP_v11.2.0
get_address Gets the IP addresses of the specified sFlow receivers. BIG-IP_v11.2.0
get_datagram_version Gets the sFlow Datagram versions used by the specified sFlow receivers. BIG-IP_v11.2.0
get_list Gets a list of sFlow receivers on this device. BIG-IP_v11.2.0
get_maximum_datagram_size Gets the maximum datagram size allowed by the specified sFlow receivers. BIG-IP_v11.2.0
get_poll_interval Gets the polling intervals of the specified sFlow receivers. BIG-IP_v11.2.0
get_port Gets the listening port numbers of the specified sFlow receivers. BIG-IP_v11.2.0
get_version Gets the version information for this interface. BIG-IP_v11.2.0
set_address Sets the IP addresses of the specified sFlow receivers. IP addresses can be either IPv4 or IPv6. BIG-IP_v11.2.0
set_maximum_datagram_size Sets the maximum datagram size allowed by the specified sFlow receivers, from 512 to 1500. Default is 1400. BIG-IP_v11.2.0
set_poll_interval Sets the polling intervals of the specified sFlow receivers. This is the time period between successive Counter Samples, in seconds. Each counter polling instance can have its own independent polling interval. Default is 10, but it can be set to a max of 1500. BIG-IP_v11.2.0
set_port Sets the listening port numbers for the specified sFlow receivers. Defaults to the sFlow standard, which is port 6343. BIG-IP_v11.2.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

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.