SLA & Track
Service Level Agreement.
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
Show sla summary
POST HTTPS://{switch IP}/rest/v1/rpc/show-sla-summaryShow track summary
POST HTTPS://{switch IP}/rest/v1/rpc/show-track-summaryCreate a sla
POST HTTPS://{switch IP}/rest/v1/running/slas
{
"id": 11,
"type": "user_define",
"file-path": "/test/user_define",
"user-define-args": "Ethernet1,Lag1"
}Create a track
POST rest/v1/running/tracks
{
"id": 11,
"sla-id": 11
}Properties Descriptions
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 Lag1..9999 Link-aggregation 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
Tree Diagrams
+--rw tracks
+--rw track* [id]
+--rw id
+--rw sla-idTable 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
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
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 |