RESTAPI Manual
Visibility and Monitoring
Mirror
8 min
urls summary urls summary url get post patch put delete /rest/v1/running/mirror y n y n n /rest/v1/running/mirror/session/{name} y y y n y /rest/v1/rpc/show mirror n y n n n examples examples show mirror show mirror post https //{switch ip}/rest/v1/rpc/show mirror get all mirror sessions get all mirror sessions get https //{switch ip}/rest/v1/running/mirror create a mirror session create a mirror session post https //{switch ip}/rest/v1/running/mirror/session { "name" 3, "type" "span", "direction" "tx", "dst port" "ethernet11", "egress queue" 3 } properties descriptions properties descriptions mirror session mirror session tree diagrams + rw mirror + rw session \[name] + rw name + rw type + rw commit? + rw direction? + rw dst port + rw src port + rw dst ip + rw gre type? + rw ip dscp + rw ip ttl + rw src ip + rw egress queue? table of properties name required type/range description mirror m path only node, has no configurable value top level configuration for the mirror session m (sub property of mirror) path only node, has no configurable value name m 1 63 (sub property of session) identify different mirror sessions type m "span" "erspan" (sub property of session) mirror type direction co "rx" "tx" "both" (sub property of session) only applicable when type = "span" direction of mirror(default both) default value "both" dst port cm ethernet name "cpu" (sub property of session) only applicable when type = "span" set span mirror destination src port co ethernet name (sub property of session) only applicable when type = "span" set span mirror session source dst ip cm a b c d (sub property of session) only applicable when type = "erspan" set erspan mirror destination ip gre type co a 4 digit hex number prefixed with '0x' (e g , 0x1a3f) (sub property of session) only applicable when type = "erspan" set erspan gre type ip dscp cm 0 63 (sub property of session) only applicable when type = "erspan" set erspan ip differentiated services code point ip ttl cm 1 255 (sub property of session) only applicable when type = "erspan" set erspan ip ttl src ip cm a b c d (sub property of session) only applicable when type = "erspan" set erspan mirror source ip egress queue o 0 7 (sub property of session) set erspan port egress queue show mirror show mirror tree diagrams + x show mirror + w input \| + w session name? + ro output + ro session \[name] + ro name + ro type? + ro status? + ro dst port? + ro src port + ro direction? + ro egress queue? + ro src ip? + ro dst ip? + ro gre type? + ro dscp? + ro ttl? table of properties name required type/range description show mirror m path only node, has no configurable value show mirror sessions information session name o 1 63 (sub property of input) identify different mirror sessions session ro (sub property of output) path only node, has no configurable value name ro 1 63 (sub property of session) identify different mirror sessions type ro "span" "erspan" (sub property of session) mirror type status ro string (sub property of session) mirror session active status dst port ro string (sub property of session) span mirror destination src port ro string (sub property of session) span mirror source direction ro string (sub property of session) direction of mirror egress queue ro 0 7 (sub property of session) egress queue src ip ro a b c d (sub property of session) erspan mirror source ip dst ip ro a b c d (sub property of session) erspan mirror destination ip gre type ro a 4 digit hex number prefixed with '0x' (e g , 0x1a3f) (sub property of session) erspan gre type dscp ro 0 63 (sub property of session) erspan ip differentiated services code point ttl ro 1 255 (sub property of session) erspan ip ttl
