HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/sflows/{sFlow.name}

Path Params
string
required

Reference Resource: sFlow
sFlow identifier for the configuration. Should be alphanumeric.

Body Params
string
length ≤ 45

IPv4 or IPv6 address used in sFlow datagrams to identify the device that sent the sFlow data to the sFlow collector. It is usually set to an IP address on the device that is reachable from the collector. This field is mandatory for sFlow to be enabled.If not configured,sFlow will not be programmed and sFlow datagrams will not be transmitted.

collectors
array of strings
length ≤ 3

Reference Resource: sFlow_collector
sFlow collectors that should receive the samples.

collectors
boolean

Enables sFlow globally in the system

integer
64 to 256

Number of bytes of a sampled packet to send to the collector.

integer
200 to 1400

Maximum number of bytes that will be send in the sFlow datagram.

integer
10 to 3600

Specifies the interval in seconds at which counter statistics are sent to the collector.

boolean

The device periodically probes all configured collectors using ICMP echo. When reachability_check is enabled,the device will send SFLOW datagrams only to those collectors which respond to ICMP request.When not enabled, it will disregard the ICMP echo check outcome and will send SFLOW datagrams to the configured collectors.

integer
1 to 1000000000

Specifies the rate at which packets should be sampled and sent to the collector.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!