Telemetry

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

Delete telemetry client

POST HTTPS://{switch IP}/rest/v1/rpc/delete-client

Get telemetry client.

GET HTTPS://{switch IP}/rest/v1/running/telemetry-client

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.

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.

PATCH rest/v1/running/telemetry-client/global
{
    "encoding": "JSON",
    "retry-interval": 30,
    "unidirectional": "true"
}

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 HTTPS://{switch IP}/rest/v1/running/telemetry-client/subscription/test/path/proc%2Fparts_stat

Properties Descriptions

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

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

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

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