HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

/system/mirrors

post
https://switch-ip/rest/v10.16/system/mirrors
Body Params
string of strings
required

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

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.

string
length ≤ 64

Descriptive comment for the session.

int64
required
1 to 4294967295

Reference Resource: Mirror
The Mirror Session ID.

string
enum

Origin of the Mirror, i.e., how the Mirror is provisioned: synthesized: Mirror has been dynamically synthesized by the system. static : Mirror is provisioned by the administrator via CLI or REST.

Allowed:
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
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'.

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
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated over 4 years ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated over 4 years ago