Telemetry

\<font color="#1d50a2">urls summary\</font> 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 \<font color="#1d50a2">examples\</font> \<font color="#1d50a2">delete telemetry client\</font> post https //{switch ip}/rest/v1/rpc/delete client \<font color="#1d50a2">get telemetry client \</font> get https //{switch ip}/rest/v1/running/telemetry client \<font color="#1d50a2">create a destination group \</font> 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} ] } \<font color="#1d50a2">create a destination for a destination group \</font> post https //{switch ip}/rest/v1/running/telemetry client/destination group/test/destination { "ip" "1 1 1 1", "port" 1 } \<font color="#1d50a2">modify global telemetry client configuration \</font> patch rest/v1/running/telemetry client/global { "encoding" "json", "retry interval" 30, "unidirectional" "true" } \<font color="#1d50a2">create a telemetry client subscription \</font> 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"} ] } \<font color="#1d50a2">delete a path from a subscription \</font> delete https //{switch ip}/rest/v1/running/telemetry client/subscription/test/path/proc%2fparts stat \<font color="#1d50a2">properties descriptions\</font> \<font color="#1d50a2">telemetry client global\</font> tree diagrams + rw telemetry client + rw global \| + ro encoding? \| + ro retry interval? \| + ro src ip? \| + ro unidirectional? table of properties \<font color="#2166ae">name\</font> \<font color="#2166ae">required\</font> \<font color="#2166ae">type/range\</font> \<font color="#2166ae">description\</font> 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" \<font color="#1d50a2">telemetry client destination groups\</font> 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 \<font color="#1d50a2">telemetry client global\</font> 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 \<font color="#1d50a2">delete client\</font> 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