New and Changed Information
The following table provides an overview of the significant changes to this guide up to this current release. The table does not provide an exhaustive list of all changes that are made to the guide or of the new features up to this release.
|
Cisco APIC Release Version |
Feature |
Description |
|---|---|---|
|
5.1(3) |
OpFlex support for ERSPAN with OVS |
This guide became available. |
|
5.2(1) |
OpFlex support for ERSPAN with OVS on Kubernetes |
Added a procedure for configuring OpFlex for ERSPAN with OVS on Kubernetes setups. |
About OpFlex support for ERSPAN with OVS
The OpFlex support for ERSPAN with OVS feature extends the basic port mirroring capability from Layer 2 to Layer 3 which allows the mirrored traffic to be sent through a routable IP network from specific interfaces.
Benefits of OpFlex support for ERSPAN with OVS
The OpFlex support for ERSPAN with OVS provides several benefits:
-
The ability to get mirrored traffic directly from specific interfaces providing visibility of local traffic.
-
Debugging network issues by tracking the control and data frames and security analysis.
OpFlex support for ERSPAN with OVS Limitations and Restrictions
Be aware of the following issues when configuring OpFlex support for ERSPAN with OVS:
-
Red Hat Enterprise Linux 7 (RHEL7) is not supported.
Prerequisites for Configuring OpFlex support for ERSPAN with OVS
You must complete the following tasks before you configure OpFlex support for ERSPAN with OVS on OpenStack/Kubernetes setups:
-
ERSPAN leverages support added to Open vSwitch (OVS). ERSPAN sessions are initialized on ports connected to a switch in OVS. In order to support ERSPAN, the hosts running OVS must meet the following requirements:
-
Linux kernel version 4.18 or later
-
OVS version 2.10 or later

Note
Red Hat Enterprise Linux 7 (RHEL7) does not meet these requirements, but Red Hat Enterprise Linux 8 (RHEL8) does.
-
-
You must have RHEL8 OS installed.
-
The host where OpenStack CLI commands are run must also have the Group Based Policy (GBP) python client library installed.
-
You must have basic working knowledge of an OpenStack environment.
-
(applicable only for ERSPAN with OVS on Kubernetes setups) You must have Ubuntu 20 installed.
OpFlex support for ERSPAN with OVS Configuration Workflow
This section describes a high-level overview of the tasks you perform to configure OpFlex support for ERSPAN with OVS:
Procedure
| Step 1 |
Get the neutron port that is used to create the ERSPAN source. The MAC address of this port will be the source of the configuration. For more information, see Configuring the OpFlex support for ERSPAN with OVS on OpenStack setups. |
| Step 2 |
Run the OpenStack CLI commands described in the next section to configure erspan source and destination sessions. For more information, see Configuring the OpFlex support for ERSPAN with OVS on OpenStack setups. |
| Step 3 |
Verify the configuration. For more information, see Verify the OpFlex support for ERSPAN with OVS. |
Configuring the OpFlex support for ERSPAN with OVS on OpenStack setups
This section describes how to configure the OpFlex support for ERSPAN with OVS on OpenStack setups.
Procedure
| Step 1 |
Configuring ERSPAN sessions. This release introduces support for ERSPAN sessions on OpenStack ports. ERSPAN sessions are configured using the
The
The |
||
| Step 2 |
Verifying ERSPAN configuration in OpenStack. The status of the ERSPAN session can be examined through the apic:synchronization_state property of the port. Run the following command to see the state:
The aggregate state of the ERSPAN configuration is reflected in the port's
ERSPAN traffic is sent from the local vSwitch to the host, and the host's IP stack forwards the encapsulated packet. ERSPAN sessions may experience some drop-out when live-migrating the ports with ERSPAN configuration, due to port rebinding. |
||
| Step 3 |
Verifying ERSPAN configuration in Open vSwitch. You can confirm the ERSPAN sessions on host vSwitches using the "
|
||
| Step 4 |
Removing ERSPAN configuration in OpenStack. When the port is unbound, the ERSPAN session is terminated. However, the ERSPAN configuration is still present in the port, and if the port is bound again, then the ERSPAN session will be resumed. The ERSPAN configuration state can only be removed explicitly or when the port is deleted. To remove all the ERSPAN configuration from the port, enter the following command:
Example:
|
Configuring OpFlex Support for ERSPAN with OVS on Kubernetes Setups
This section describes how to configure the OpFlex support for ERSPAN with OVS on Kubernetes setups.
Procedure
| Step 1 |
Verify if the Custom Resources Definition (CRD) is available. Check for faults and violations using the following commands:
|
| Step 2 |
Apply the CRD yaml file with valid inputs; using the $ kubectl apply -f <yaml_file> command. A sample CRD yaml file is shown below:
|
Verify the OpFlex support for ERSPAN with OVS
This section describes how to verify the OpFlex support for ERSPAN with OVS on OpenStack setups.
Procedure
| Step 1 |
Log in to the Cisco APIC GUI, on the menu bar, choose . |
| Step 2 |
You need to verify the successful creation of ERSPAN Source. In the Navigation pane, choose and click on a VSPAN session. |
| Step 3 |
You need to verify the successful creation of ERSPAN Destination. In the Navigation pane, choose and click on a VSPAN Destination Group. |
| Step 4 |
You need to verify the successful binding of ERSPAN session with VPCs. In the Navigation pane, choose and click on the VPC interface policy group. |
| Step 5 |
Inside the opflex_agent container, enter the following command:
|
| Step 6 |
On the compute nodes, check for the mirror, enter the following command:
|
Feedback