RESTAPI Manual
Layer 3
SLA & Track
12 min
service level agreement urls summary urls summary url get post patch put delete /rest/v1/rpc/show sla summary n y n n n /rest/v1/rpc/show track summary n y n n n /rest/v1/running/slas/{id} y y y n y /rest/v1/running/tracks/{id} y y y n y examples examples show sla summary show sla summary post https //{switch ip}/rest/v1/rpc/show sla summary show track summary show track summary post https //{switch ip}/rest/v1/rpc/show track summary create a sla create a sla post https //{switch ip}/rest/v1/running/slas { "id" 11, "type" "user define", "file path" "/test/user define", "user define args" "ethernet1,portchannel0001" } create a track create a track post rest/v1/running/tracks { "id" 11, "sla id" 11 } properties descriptions properties descriptions sla entry sla entry tree diagrams + rw slas \| + rw sla \[id] \| + rw id \| + rw type? \| + rw destination ip \| + rw source port? \| + rw interval? \| + rw timeout? \| + rw count? \| + rw frequency? \| + rw user define args? \| + rw file path? table of properties name required type/range description slas m path only node, has no configurable value service level agreement monitor(sla) configurations id m 1 4294967295 (sub property of slas) service level agreement monitor(sla) id type o "icmp echo" "user define" (sub property of slas) types cannot be changed once set default value "user define" destination ip cm a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of slas) only applicable when type = "icmp echo" destination ip address of icmp/icmp6 request of service level agreement monitor(sla) this field is mandatory for type of "icmp echo" cannot be changed once set source port co ethernet name ethernet sub interface name portchannel0000 9999 portchannel sub interface name loopback0 199 vlan1 4094 (sub property of slas) only applicable when type = "icmp echo" source port to send icmp/icmp6 request packets of service level agreement monitor(sla) interval co 200 3000 (sub property of slas) only applicable when type = "icmp echo" seconds between sending each icmp/icmp6 request packets of service level agreement monitor(sla) default value 200 timeout co 1 3600 (sub property of slas) only applicable when type = "icmp echo" time to wait for icmp/icmp6 response of service level agreement monitor(sla) default value 5 count co 1 100 (sub property of slas) only applicable when type = "icmp echo" stop sending icmp/icmp6 request packets when receives {count} icmp/icmp6 reply packets default value 5 frequency co 1 3600 (sub property of slas) only applicable when type = "icmp echo" interval between two consecutive detections of service level agreement monitor(sla) default value 10 user define args co string (sub property of slas) only applicable when type = "user define" user define arguments of service level agreement monitor(sla) file path co string (sub property of slas) only applicable when type = "user define" user define file path for service level agreement monitor(sla) cannot be changed once set default value "/var/run/sla user define/sla user define default" track entry track entry tree diagrams + rw tracks + rw track \[id] + rw id + rw sla id table of properties name required type/range description tracks m path only node, has no configurable value track configurations id m 1 4294967295 (sub property of tracks) track id sla id m 1 4294967295 (sub property of tracks) sla id show sla summary show sla summary tree diagrams + x show sla summary \| + ro output \| + ro result? table of properties name required type/range description show sla summary m path only node, has no configurable value result ro string (sub property of output) a table that shows information of all slas show track summary show track summary tree diagrams + x show track summary + ro output + ro result? table of properties name required type/range description show track summary m path only node, has no configurable value result ro string (sub property of output) a table that shows information of all tracks
