/system/mirrors/{Mirror.id}

patch

https://switch-ip/rest/v10.16/system/mirrors/{Mirror.id}

Path Params

Mirror.id

string

required

Reference Resource: Mirror
The Mirror Session ID.

Body Params

string of strings

required

Reference Resource: Mirror
Mirror references for sessions configured in this bridge.

active

boolean

The intended state of the mirror session: active or inactive. The operation_state value contains the actual state in hardware (e.g. active, inactive, or error). When missing or false, the state is inactive.

comment

string

length ≤ 64

Descriptive comment for the session.

output_port

string

Reference Resource: Port
Ethernet port reference in Port used to transmit the mirror packets. There must be a valid Ethernet port for the session operation state to become active. The output port should be reserved exclusively for transmitting mirror packets for this session. It should not participate in any other network activity (e.g. Spanning Tree, LACP etc).

select_dst_port

array of strings

length ≤ 4

Reference Resource: Port
Set of Ethernet port or LAG references in Port on which transmitted packets are selected to be mirrored.

select_dst_port

select_src_port

array of strings

length ≤ 4

Reference Resource: Port
Set of Ethernet port or LAG references in Port on which received packets are selected to be mirrored.

select_src_port

session_type

string

enum

Mirror Session output/destination type. 'none' : session doesn't have defined destination 'port' : session mirrors to the physical interface 'cpu' : session mirrors to the internal CPU 'tunnel' : session mirrors into a tunnel

Allowed:

tunnel

object

Tunnel parameters. Only considered if the session_type is 'tunnel'.

tunnel_vrf

string

Reference Resource: VRF
VRF to be used for reaching the tunnel destination IP address. If not specified, 'default' VRF will be used instead.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!