RESTAPI Manual
Visibility and Monitoring
sFlow
12 min
urls summary 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 examples update sflow configuration update sflow configuration patch https //{switch ip}/rest/v1/running/sflow { "enabled" "false", "polling interval" 20 } create a sflow collector 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 create a sflow session post https //{switch ip}/rest/v1/running/sflow/session { "port" "ethernet6", "sampling rate" 8888, "enabled" "false" } show sflow interface show sflow interface post https //{switch ip}/rest/v1/rpc/show sflow interface properties descriptions properties descriptions sflow global 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 "eth0" (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 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 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 "eth0" (sub property of collector) source interface for collector mutually exclusive with \ source show sflow interface 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)
