INT
URLs Summary
URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
/rest/v1/running/int | Y | Y | Y | N | Y |
rest/v1/running/int/collector/{type} | Y | Y | N | N | Y |
rest/v1/running/int/ipt-session | Y | Y | N | N | Y |
rest/v1/running/int/ipt-instance | Y | Y | N | N | Y |
rest/v1/rpc/show-int-session | N | Y | N | N | N |
Examples
Show INT session
POST HTTPS://{switch IP}/rest/v1/rpc/show-int-sessionCreate INT Session
POST HTTPS://{switch IP}/rest/v1/running/int
{
"enabled": True,
"switch-id": "123",
"collector": [
{
"type": "buffer-drop",
"sip": "10.250.0.164",
"dip": "10.250.0.113",
"cos": "0",
"vrf": "Vrf10",
"tc": 2,
"sampler-mode": "all",
"collection-mode": "local",
"cpu-queue-rate": 1000,
"cpu-queue-burst-size": 1000
}
],
"ipt-session": {
"sip": "1.1.1.1",
"dip": "2.2.2.2",
"smac": "00:00:00:00:00:01",
"dmac": "00:00:00:00:00:02",
"vlan": 100,
"ttl": 20
},
"ipt-instance": {
"node-role": "ingress",
"probe-marker": "0x0000000000000001",
"trigger-type": "sampling",
"port": "Ethernet5,Ethernet6,Ethernet7"
},
}Get INT Infomation
GET HTTPS://{switch IP}/rest/v1/running/intProperties Descriptions
INT Collector
Tree Diagrams
+--rw int
+--rw enabled?
+--rw switch-id?
+--rw collector* [type]
| +--rw type
| +--rw sip
| +--rw dip
| +--rw vrf?
| +--rw ttl?
| +--rw dscp?
| +--rw cos
| +--rw tc?
| +--rw df?
| +--rw sampler-mode
| +--rw capture-rate?
| +--rw max-packets-rate?
| +--rw max-packets-per-burst?
| +--rw collection-mode
| +--rw cpu-queue-rate?
| +--rw cpu-queue-burst-size?
| +--rw port
| +--rw delay-threshold
+--rw ipt-session
| +--rw sip
| +--rw dip
| +--rw vrf?
| +--rw ttl?
| +--rw dscp?
| +--rw smac?
| +--rw dmac?
| +--rw vlan?
| +--rw port?
+--rw ipt-instance
+--rw node-role
+--rw probe-marker
+--rw port?
+--rw trigger-type?
+--rw sampling-rate?
+--rw dscpTable of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
int | M | | Path-only node, has no configurable value. |
enabled | O | "true" "false" | (sub-property of int) Whether to enable in-band network telemetry (INT) Default value: false |
switch-id | O | string | (sub-property of int) Switch ID to be included in INT packets |
collector | M | | (sub-property of int) Path-only node, has no configurable value. |
type | M | "buffer-drop" "high-delay" | (sub-property of collector) Type of the collector, e.g. buffer-drop, high-delay |
sip | M | A.B.C.D | (sub-property of collector) Source IP address for collector |
dip | M | A.B.C.D | (sub-property of collector) Destination IP address for collector |
vrf | O | "default" or vrf name | (sub-property of collector) VRF for collector |
ttl | O | 0..255 | (sub-property of collector) TTL value for collector Default value: 255 |
dscp | O | 0..63 | (sub-property of collector) DSCP value for collector Default value: 0 |
cos | M | string | (sub-property of collector) List of cos to monitor, buffer_drop is supported only on lossy cos |
tc | O | 0..7 | (sub-property of collector) TC value for collector Default value: 0 |
df | O | 0..1 | (sub-property of collector) Whether to set DF flag for collector Default value: 0 |
sampler-mode | M | ^(all|probabilistic|microburst)$ | (sub-property of collector) Sampler mode for collector, valid values are: all, probabilistic and microburst |
capture-rate | CO | 10..16777215 | (sub-property of collector) Only applicable when sampler-mode = 'probabilistic'. Capture rate for probabilistic sampler mode, in packets per second, valid when sampler-mode is probabilistic Default value: 10000 |
max-packets-rate | CO | 122..100000 | (sub-property of collector) Only applicable when sampler-mode = 'microburst'. Max packets rate for microburst sampler mode, in packets per second, valid when sampler-mode is microburst Default value: 8192 |
max-packets-per-burst | CO | 64..16384 | (sub-property of collector) Only applicable when sampler-mode = 'microburst'. Max packets per burst for microburst sampler mode, valid when sampler-mode is microburst Default value: 256 |
collection-mode | M | ^(local|remote)$ | (sub-property of collector) Collection mode for collector, valid values are: local and remote |
cpu-queue-rate | CO | 122..60000000 | (sub-property of collector) Only applicable when collection-mode = 'local'. CPU queue rate for local collection mode, in packets per second, valid when collection-mode is local Default value: 1000 |
cpu-queue-burst-size | CO | 1..1000000000 | (sub-property of collector) Only applicable when collection-mode = 'local'. CPU queue burst size for local collection mode, in packets, valid when collection-mode is local Default value: 512 |
port | CM | string | (sub-property of collector) Only applicable when type = 'high-delay'. List of interfaces, e.g. 0/0-0/32,0/64, use 'all' to enable on all ports |
delay-threshold | CM | 100..16000000 | (sub-property of collector) Only applicable when type = 'high-delay'. Delay threshold for high delay collector, in milliseconds, valid when type is high-delay |
ipt-session | M | | (sub-property of int) Path-only node, has no configurable value. |
sip | M | A.B.C.D | (sub-property of ipt-session) Source IP address for collector |
dip | M | A.B.C.D | (sub-property of ipt-session) Destination IP address for collector |
vrf | O | "default" or vrf name | (sub-property of ipt-session) VRF for collector |
ttl | O | 0..255 | (sub-property of ipt-session) TTL value for collector Default value: 255 |
dscp | O | 0..63 | (sub-property of ipt-session) DSCP value for collector Default value: 0 |
smac | O | A:B:C:D:E:F | (sub-property of ipt-session) Source MAC address for Innovium Path Telemetry packets |
dmac | O | A:B:C:D:E:F | (sub-property of ipt-session) Destination MAC address for Innovium Path Telemetry packets |
vlan | O | 1..4094 | (sub-property of ipt-session) VLAN ID for Innovium Path Telemetry packets |
port | O | string | (sub-property of ipt-session) Interface on which IPT packets are output |
ipt-instance | M | | (sub-property of int) Path-only node, has no configurable value. |
node-role | M | ^(ingress|egress|transit)$ | (sub-property of ipt-instance) Node role for Innovium Path Telemetry instance, valid values are: ingress, egress, and transit |
probe-marker | M | string | (sub-property of ipt-instance) IPT Probe Marker (64-bit) in hex (0x...) and MSB 2 bytes of the probe marker must be 0 |
port | O | string | (sub-property of ipt-instance) List of interfaces, e.g. 0/0-0/32,0/64, use 'all' to enable on all ports |
trigger-type | O | ^(sampling|dscp)$ | (sub-property of ipt-instance) Trigger type for Innovium Path Telemetry instance, valid values are: sampling and dscp |
sampling-rate | CO | 1..16777215 | (sub-property of ipt-instance) Only applicable when trigger-type = 'sampling'. Sampling rate for Innovium Path Telemetry instance, valid when trigger-type is sampling |
dscp | CM | string | (sub-property of ipt-instance) Only applicable when trigger-type = 'dscp'. List of DSCP values to monitor, valid when trigger-type is dscp |
Show INT Session
Tree Diagrams
+---x show-int-session
+--ro output
+--ro switch-id?
+--ro session* [type]
| +--ro type
| +--ro sip?
| +--ro dip?
| +--ro vrf?
| +--ro ttl?
| +--ro dscp?
| +--ro cos?
| +--ro tc?
| +--ro df?
| +--ro sampler-mode?
| +--ro capture-rate?
| +--ro max-packets-rate?
| +--ro max-packets-per-burst?
| +--ro collection-mode?
| +--ro cpu-queue-rate?
| +--ro cpu-queue-burst-size?
| +--ro port?
| +--ro delay-threshold?
+--ro ipt-session
| +--ro sip?
| +--ro dip?
| +--ro vrf?
| +--ro ttl?
| +--ro dscp?
| +--ro smac?
| +--ro dmac?
| +--ro vlan?
| +--ro port?
+--ro ipt-instance
+--ro node-role?
+--ro probe-marker?
+--ro port?
+--ro trigger-type?
+--ro sampling-rate?
+--ro dscp?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
show-int-session | M | | Path-only node, has no configurable value. Show all active INT sessions |
switch-id | RO | string | (sub-property of output) |
session | RO | | (sub-property of output) Path-only node, has no configurable value. |
type | RO | "buffer-drop" "high-delay" | (sub-property of session) |
sip | RO | A.B.C.D | (sub-property of session) |
dip | RO | A.B.C.D | (sub-property of session) |
vrf | RO | "default" or vrf name | (sub-property of session) |
ttl | RO | 0..255 | (sub-property of session) |
dscp | RO | 0..255 | (sub-property of session) |
cos | RO | string | (sub-property of session) |
tc | RO | 0..255 | (sub-property of session) |
df | RO | 0..255 | (sub-property of session) |
sampler-mode | RO | string | (sub-property of session) |
capture-rate | RO | 0..4294967295 | (sub-property of session) |
max-packets-rate | RO | 0..4294967295 | (sub-property of session) |
max-packets-per-burst | RO | 0..4294967295 | (sub-property of session) |
collection-mode | RO | string | (sub-property of session) |
cpu-queue-rate | RO | 0..4294967295 | (sub-property of session) |
cpu-queue-burst-size | RO | 0..4294967295 | (sub-property of session) |
port | RO | string | (sub-property of session) |
delay-threshold | RO | 0..4294967295 | (sub-property of session) |
ipt-session | RO | | (sub-property of output) Path-only node, has no configurable value. |
sip | RO | A.B.C.D | (sub-property of ipt-session) |
dip | RO | A.B.C.D | (sub-property of ipt-session) |
vrf | RO | "default" or vrf name | (sub-property of ipt-session) |
ttl | RO | 0..255 | (sub-property of ipt-session) |
dscp | RO | 0..255 | (sub-property of ipt-session) |
smac | RO | A:B:C:D:E:F | (sub-property of ipt-session) |
dmac | RO | A:B:C:D:E:F | (sub-property of ipt-session) |
vlan | RO | 1..4094 | (sub-property of ipt-session) |
port | RO | string | (sub-property of ipt-session) |
ipt-instance | RO | | (sub-property of output) Path-only node, has no configurable value. |
node-role | RO | string | (sub-property of ipt-instance) |
probe-marker | RO | string | (sub-property of ipt-instance) |
port | RO | string | (sub-property of ipt-instance) |
trigger-type | RO | string | (sub-property of ipt-instance) |
sampling-rate | RO | 0..4294967295 | (sub-property of ipt-instance) |
dscp | RO | string | (sub-property of ipt-instance) |