Telemetry

urls summary urls summary url get post patch put delete /rest/v1/running/telemetry client y n n n n /rest/v1/running/telemetry client/destination group/{name} y y y n y /rest/v1/running/telemetry client/destination group/{name}/destination/{ip}/{port} n y y n y /rest/v1/running/telemetry client/global y n y n n /rest/v1/running/telemetry client/subscription/{name} y y y n y /rest/v1/running/telemetry client/ subscription/{name}/paths/{sub path} n n n n y /rest/v1/rpc/delete client n y n n n examples examples delete telemetry client delete telemetry client post https //{switch ip}/rest/v1/rpc/delete client get telemetry client get telemetry client get https //{switch ip}/rest/v1/running/telemetry client create a destination group create a destination group post https //{switch ip}/rest/v1/running/telemetry client/destination group { "name" "createnew", "destination" \[ {"ip" "11 11 11 11","port" 11}, {"ip" "22 22","port" 11} ] } create a destination for a destination group create a destination for a destination group post https //{switch ip}/rest/v1/running/telemetry client/destination group/test/destination { "ip" "1 1 1 1", "port" 1 } modify global telemetry client configuration modify global telemetry client configuration patch rest/v1/running/telemetry client/global { "encoding" "json", "retry interval" 30, "unidirectional" "true" } create a telemetry client subscription create a telemetry client subscription post https //{switch ip}/rest/v1/running/telemetry client/subscription { "name" "test", "dst group" "test1", "sensor target" "state db", "report interval" 10000, "report type" "stream", "paths" \[ {"sub path" "counters/ethernet "}, {"sub path" "proc/parts stat"} ] } delete a path from a subscription delete a path from a subscription delete https //{switch ip}/rest/v1/running/telemetry client/subscription/test/path/proc%2fparts stat properties descriptions properties descriptions telemetry client global telemetry client global tree diagrams + rw telemetry client + rw global \| + ro encoding? \| + ro retry interval? \| + ro src ip? \| + ro unidirectional? table of properties name required type/range description telemetry client m path only node, has no configurable value global m (sub property of telemetry client) path only node, has no configurable value encoding ro "json" "gpb" (sub property of global) encoding method default value "json" retry interval ro 0 65535 (sub property of global) time interval to retry default value 30 src ip ro a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of global) source ip address unidirectional ro "true" "false" (sub property of global) unidirectional link to remote default value "true" telemetry client destination groups telemetry client destination groups tree diagrams + rw telemetry client + rw destination group \[name] \| + rw name \| + rw destination \[ip port] \| + rw ip \| + rw port table of properties name required type/range description telemetry client m path only node, has no configurable value destination group m (sub property of telemetry client) path only node, has no configurable value name m string (sub property of destination group) name of destination group destination m (sub property of destination group) path only node, has no configurable value one destination group contain multiple destination ip m a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of destination) destination ip address port m 1 65535 (sub property of destination) destination port telemetry client global telemetry client global tree diagrams + rw telemetry client + rw subscription \[name] + rw name + rw dst group? + rw sensor target? + rw paths \[sub path] \| + rw sub path + rw report interval? + rw report type? table of properties name required type/range description telemetry client m path only node, has no configurable value subscription m (sub property of telemetry client) path only node, has no configurable value name m string (sub property of subscription) name of subscription dst group o string (sub property of subscription) name of destination group to subscribe sensor target o "counters db" "state db" "others" (sub property of subscription) sensor target to report paths m (sub property of subscription) path only node, has no configurable value sub path m string (sub property of paths) sensor path to report report interval o 100 1800000 (sub property of subscription) report interval report type o "periodic" "stream" (sub property of subscription) report type delete client delete client tree diagrams + x delete client table of properties name required type/range description delete client m path only node, has no configurable value delete all telemetry client configuration