org.onosproject.net.behaviour

Interface MirroringDescription

All Superinterfaces:

Annotated, Description

All Known Implementing Classes:

DefaultMirroringDescription

@Beta
public interface MirroringDescription
extends Description, Annotated

The abstraction of a mirroring. Port mirroring is a method of monitoring network traffic that forwards a copy of each incoming or outgoing packet from one port (Monitor port) on a network switch to another port (Mirror port) where the packet can be analyzed.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	mirrorPort() Returns mirror port.
java.util.Optional<VlanId>	mirrorVlan() Returns mirror vlan.
java.util.List<java.lang.String>	monitorDstPorts() Returns dst ports to monitor.
java.util.List<java.lang.String>	monitorSrcPorts() Returns src ports to monitor.
java.util.List<VlanId>	monitorVlans() Returns vlans to monitor.
MirroringName	name() Returns mirroring name.

Methods inherited from interface org.onosproject.net.Description

annotations

Method Detail

name

MirroringName name()

Returns mirroring name.

Returns:

mirroring name

monitorSrcPorts

java.util.List<java.lang.String> monitorSrcPorts()

Returns src ports to monitor. If it is empty, then no src port has to be monitored.

Returns:

set of src ports to monitor

monitorDstPorts

java.util.List<java.lang.String> monitorDstPorts()

Returns dst ports to monitor. If it is empty, then no dst port has to be monitored.

Returns:

set of dst ports to monitor

monitorVlans

java.util.List<VlanId> monitorVlans()

Returns vlans to monitor. If it is empty, then no vlan has to be monitored.

Returns:

monitored vlan

mirrorPort

java.util.Optional<java.lang.String> mirrorPort()

Returns mirror port. If it is not set, then no destination port for mirrored packets.

Returns:

mirror port

mirrorVlan

java.util.Optional<VlanId> mirrorVlan()

Returns mirror vlan. If it is not set then no destination vlan for mirrored packets.

Returns:

mirror vlan