Management::SFlowReceiver

Introduced : BIG-IP_v11.4.0
The SFlowReceiver interface contains the methods for creating and manipulating the sFlow receiver. It 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 the maximum datagram size they support and their current state (enabled or disabled). One or more data sources can be selected to monitor for counter/packet-flow sampling. Data samples would start to flow to the offline receivers after you enable them. The sFlow monitoring standard 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. Data 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 the 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. Thus, the collected data can be used to analyze the BIG-IP system performance.

Methods

Method Description Introduced
create Creates a set of sFlow receivers. BIG-IP_v11.4.0
delete_all_sflow_receivers Deletes all sFlow receivers. BIG-IP_v11.4.0
delete_sflow_receiver Deletes a set of sFlow receivers. BIG-IP_v11.4.0
get_address Gets the IP addresses for the specified sFlow receivers. BIG-IP_v11.4.0
get_datagram_version Gets the sFlow datagram versions used for the specified sFlow receivers. BIG-IP_v11.4.0
get_description Gets the descriptions for the specified sFlow receivers. BIG-IP_v11.4.0
get_enabled_state Gets the states for the specified sFlow receivers. BIG-IP_v11.4.0
get_list Gets a list of names for all sFlow receivers. BIG-IP_v11.4.0
get_maximum_datagram_size Gets the maximum datagram sizes allowed for the specified sFlow receivers. BIG-IP_v11.4.0
get_port Gets the listening port numbers for the specified sFlow receivers. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v11.4.0
set_address Sets the IP addresses for the specified sFlow receivers. IP addresses can be either IPv4 or IPv6. BIG-IP_v11.4.0
set_description Sets the descriptions for the specified sFlow receivers. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.4.0
set_enabled_state Sets the states for the specified sFlow receivers to enabled or disabled. The default is disabled. BIG-IP_v11.4.0
set_maximum_datagram_size Sets the maximum datagram sizes allowed for the specified sFlow receivers, from 512 to 1500 inclusive. The default is 1400. BIG-IP_v11.4.0
set_port Sets the listening port numbers for the specified sFlow receivers. The default is the sFlow standard port 6343. BIG-IP_v11.4.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.