RESTAPI Manual
Visibility and Monitoring
INT
8 min
urls summary 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 examples show int session show int session post https //{switch ip}/rest/v1/rpc/show int session create int session create 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 int infomation get https //{switch ip}//rest/v1/running/int properties descriptions properties descriptions int int collector 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 dscp table of properties name name required required type/range type/range description 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 show int 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 name required required type/range type/range description 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)
