sFlow
URLs Summary
URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
/rest/v1/running/sflow | Y | N | Y | N | N |
/rest/v1/running/sflow/collector/{name} | Y | Y | Y | N | Y |
/rest/v1/running/sflow/session/{port} | Y | Y | Y | N | Y |
/rest/v1/rpc/show-sflow-interface | N | Y | N | N | N |
Examples
Update sFlow configuration.
PATCH HTTPS://{switch IP}/rest/v1/running/sflow
{
"enabled": "false",
"polling-interval": 20
}Create a sFlow collector.
POST HTTPS://{switch IP}/rest/v1/running/sflow/collector
{
"name": "test",
"ip": "160.160.160.1",
"port": 10,
"vrf": "mgmt",
"source": "175.0.0.1"
}Create a sFlow session.
POST HTTPS://{switch IP}/rest/v1/running/sflow/session
{
"port": "Ethernet6",
"sampling-rate": 8888,
"enabled": "false"
}Show sFlow interface
POST HTTPS://{switch IP}/rest/v1/rpc/show-sflow-interfaceProperties Descriptions
sFlow global
Tree Diagrams
+--rw sflow
+--rw enabled?
+--rw polling-interval?
+--rw agent-id?
+--rw sampling-rate?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
sflow | M | | Path-only node, has no configurable value. Global sFlow configuration |
enabled | O | "true" "false" | (sub-property of sflow) Global admin state of sFlow Default value: "false" |
polling-interval | O | 5..300 | (sub-property of sflow) Counter sampling polling interval Default value: 20 |
agent-id | O | Interface name "Mgmt0" | (sub-property of sflow) Sflow agent-id |
sampling-rate | O | 4096..1000000 | (sub-property of sflow) Global sampling rate (1/N packets) Default value: 10000 |
sFlow Seesions
Tree Diagrams
+--rw sflow
+--rw session* [port]
| +--rw port
| +--rw enabled?
| +--rw sampling-rate?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
sflow | M | | Path-only node, has no configurable value. Global sFlow configuration |
session | M | | (sub-property of sflow) Path-only node, has no configurable value. Interface-level sFlow configuration |
port | M | Ethernet name | (sub-property of session) port name |
enabled | O | "true" "false" | (sub-property of session) Interface-level admin state of sFlow collector Default value: "true" |
sampling-rate | O | 4096..1000000 | (sub-property of session) Sampling rate (1/N packets) Default value: 10000 |
sFlow Collectors
Tree Diagrams
+--rw sflow
+--rw collector* [name]
+--rw name
+--rw ip
+--rw port?
+--rw vrf?
+--rw source?
+--rw source-interface?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
sflow | M | | Path-only node, has no configurable value. Global sFlow configuration |
collector | M | | (sub-property of sflow) Path-only node, has no configurable value. Collector configuration |
name | M | string | (sub-property of collector) Collector name |
ip | M | A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of collector) Collector IP address |
port | O | 1..65535 | (sub-property of collector) Collector destination UDP port (default 6343) Default value: 6343 |
vrf | O | "mgmt" "default" vrf name | (sub-property of collector) Specify the Collector VRF. |
source | O | A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of collector) Source IP address for collector Mutually exclusive with: - source-interface |
source-interface | O | Interface name "Mgmt0" | (sub-property of collector) Source interface for collector Mutually exclusive with: - source |
show-sflow-interface
Tree Diagrams
+---x show-sflow-interface
+---w input
| +---w port?
+--ro output
+--ro port-config* [port]
+--ro port
+--ro enabled?
+--ro sampling-rate?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
show-sflow-interface | M | | Path-only node, has no configurable value. Display Sflow Interface information |
port | O | Ethernet name | (sub-property of input) determining display specific interface information or all interface information |
port-config | RO | | (sub-property of output) Path-only node, has no configurable value. sFlow interface status entries |
port | RO | Ethernet name | (sub-property of port-config) Port name |
enabled | RO | "true" "false" | (sub-property of port-config) Admin status |
sampling-rate | RO | 0..4294967295 | (sub-property of port-config) Configured sampling rate (1/N) |