Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an ERSPAN Source

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "erspan-source"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>erspan-source</type>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

Configuring ERSPAN

Encapsulated Remote Switched Port Analyzer (ERSPAN) is used to transport mirrored traffic in an IP network. ERSPAN supports source ports, source VLANs, and destinations on different switches, which provide remote monitoring of multiple switches across your network.

To configure an ERSPAN source session, you associate a set of source ports or VLANs with a destination IP address, ERSPAN ID number, and virtual routing and forwarding (VRF) name.

The interfaces from which traffic can be monitored are called ERSPAN sources. Sources designate the traffic to monitor and whether to copy ingress, egress, or both directions of traffic. ERSPAN sources include the following:

Ethernet ports (but not subinterfaces)
Port channels
The inband interface to the control plane CPU
VLANs

When a VLAN is specified as an ERSPAN source, all supported interfaces in the VLAN are ERSPAN sources.

Note:

VLANs can be ERSPAN sources only in the ingress direction.
A single ERSPAN session can include mixed sources in any combination of the above.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring an ERSPAN Source

Note: This example was added in Release 9.3(3).

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

monitor session 1 type erspan-source

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

The following table contains information about the spanMonitor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an ERSPAN Source

Note: This example was added in Release 9.3(3).

CLI Commands

no monitor session 1 type erspan-source

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Global Origin IP Address in Default VDC Across all VDCs

Note: This example was added in Release 9.3(3).

CLI Commands

monitor erspan origin ip-address 1.2.3.4 global

Verifying a DME Configuration

MO	DN
topSystem	sys
spanErspanOriginIp	sys/originip

spanErspanOriginIp Properties

The following table contains information about the spanErspanOriginIp properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
isGlobal	scalar:Bool	Denotes whether origin ip is global across all erspan sessions	SELECTION: true or false DEFAULT: false
originIp	address:Ip	Global origin IP address for all erspan sessions	Value must match ipv4 or ipv6 known format

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Number of Access Control Groups Allowed on the Same Source Interface

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
filter access-group SampleString_123 allow-sharing

Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
aclName	span:AclName (string:Basic)	Name of the Access Control List applied on the current monitor session	MAX SIZE: 64 DEFAULT:
allowSharing	scalar:Bool	Denotes whether sharing is enabled for the given filter ACL	SELECTION: true or false DEFAULT: false
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Number of Access Control Groups Allowed on the Same Source Interface

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
no filter access-group SampleString_123 allow-sharing

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
aclName	span:AclName (string:Basic)	Name of the Access Control List applied on the current monitor session	MAX SIZE: 64 DEFAULT:
allowSharing	scalar:Bool	Denotes whether sharing is enabled for the given filter ACL	SELECTION: true or false DEFAULT: false
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Source VLAN (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
source vlan 1817 rx

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceVlan	sys/span/monitor-1/src-[vlan-1817]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceVlan Properties

The following table contains information about the spanSourceVlan properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source VLAN - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
isSingleDirDel	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)
vlan	base:Encap	VLAN id for Source VLAN	SELECTION: unknown, vlan-%d or vxlan-%d

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Source VLAN (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
no source vlan 1817 rx

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceVlan	sys/span/monitor-1/src-[vlan-1817]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceVlan Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
vlan	base:Encap	VLAN id for Source VLAN	SELECTION: unknown, vlan-%d or vxlan-%d

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Source VLAN (Both Directions)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
source vlan 1817 both

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceVlan	sys/span/monitor-1/src-[vlan-1817]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceVlan Properties

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source VLAN - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
isSingleDirDel	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)
vlan	base:Encap	VLAN id for Source VLAN	SELECTION: unknown, vlan-%d or vxlan-%d

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Source VLAN (Both Directions)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
no source vlan 1817 both

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceVlan	sys/span/monitor-1/src-[vlan-1817]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceVlan Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
vlan	base:Encap	VLAN id for Source VLAN	SELECTION: unknown, vlan-%d or vxlan-%d

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring SPAN on PFC Frames for an Ethernet Source Interface (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
source interface ethernet 1/2 rx allow-pfc

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[1]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

The following table contains information about the spanSourceIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source interface - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
isSingleDirDel	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting SPAN on PFC Frames for an Ethernet Source Interface (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
no source interface ethernet 1/2 rx allow-pfc

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[1]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Sup-Eth Source Interface (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
source interface sup-eth 0 rx

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[1]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source interface - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Sup-Eth Source Interface (Ingress)

Note: This example was added in Release 9.3(1).

CLI Commands

monitor session 1 type erspan-source
no source interface sup-eth 0 rx

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[1]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Remote IP Address

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
destination ip 1.2.3.4

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
destinationIp	address:Ip	Destination IP address for the current erspan session	Value must match ipv4 or ipv6 known format
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Remote IP Address

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no destination ip 1.2.3.4

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
destinationIp	address:Ip	Destination IP address for the current erspan session	Value must match ipv4 or ipv6 known format
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring IP DSCP

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
ip dscp 1

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
ipDscp	span:IpDscp (scalar:Uint16)	ERSPAN IP DSCP value	RANGE: [0 , 63] DEFAULT: 0
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting IP DSCP

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no ip dscp 1

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
ipDscp	span:IpDscp (scalar:Uint16)	ERSPAN IP DSCP value	RANGE: [0 , 63] DEFAULT: 0
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the IP Time-to-Live Value

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
ip ttl 196

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
ipTtl	span:IpTtl (scalar:Uint16)	ERSPAN IP time-to-live value	RANGE: [1 , 255] DEFAULT: 255
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the IP Time-to-Live Value

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no ip ttl 196

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
ipTtl	span:IpTtl (scalar:Uint16)	ERSPAN IP time-to-live value	RANGE: [1 , 255] DEFAULT: 255
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Source Interface

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
source interface ethernet 1/2

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[eth1/2]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source interface - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
isSingleDirDel	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Source Interface (Ingress and Egress)

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
source interface ethernet 1/2 both

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1
spanSourceIntf	sys/span/monitor-1/srcintf-[eth1/2]

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

spanSourceIntf Properties

Property Name	Data Type	Description	Values
direction	span:SrcDirection (scalar:Enum8)	The direction of the source interface - Rx, Tx, Both	SELECTION: 0 - invalid 1 - rx 2 - tx 3 - both 4 - any DEFAULT: both
id	nw:IfId (base:IfIndex)	The interface id for the session	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
isSingleDirDel	scalar:Bool	NO COMMENTS	SELECTION: false - no true - yes DEFAULT: no(false)

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Drop SPAN Session as Low Priority

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
source forward-drops rx priority-low

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
isFwdDropsRx	scalar:Bool	Denotes whether source forwarding drops rx is enabled for the given erspan-source session	SELECTION: true or false DEFAULT: false
isFwdDropsRxLowPriority	scalar:Bool	Denotes whether source forwarding drops rx has low priority for the given erspan-source session	SELECTION: true or false DEFAULT: false
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Drop SPAN Session as Low Priority

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no source forward-drops rx priority-low

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
isFwdDropsRx	scalar:Bool	Denotes whether source forwarding drops rx is enabled for the given erspan-source session	SELECTION: true or false DEFAULT: false
isFwdDropsRxLowPriority	scalar:Bool	Denotes whether source forwarding drops rx has low priority for the given erspan-source session	SELECTION: true or false DEFAULT: false
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a VRF Membership

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
vrf SampleString_123

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local
vrfName	span:VrfName (string:Basic)	VRF name for the erspan-source session.(user specified name / default / manangement)	MAX SIZE: 32 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a VRF Membership

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no vrf SampleString_123

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local
vrfName	span:VrfName (string:Basic)	VRF name for the erspan-source session.(user specified name / default / manangement)	MAX SIZE: 32 DEFAULT:

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the ERSPAN Id

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan
erspan-id 736

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
erspanId	span:ErspanId (scalar:Uint16)	ERSPAN identification number	RANGE: [0 , 1023] DEFAULT: 0
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the ERSPAN Id

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan
no erspan-id 736

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
erspanId	span:ErspanId (scalar:Uint16)	ERSPAN identification number	RANGE: [0 , 1023] DEFAULT: 0
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the MTU size for SPAN Packets

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
mtu 1333

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
mtu	span:MtuValue (scalar:Uint16)	Value of Maximum transmission unit truncation size for SPAN packets	RANGE: [64 , 10240] DEFAULT: 10240
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the MTU size for SPAN Packets

Note: This example was added in Release 9.3(3).

CLI Commands

monitor session 1 type erspan-source
no mtu 1333

Verifying a DME Configuration

MO	DN
spanEntity	sys/span
spanMonitor	sys/span/monitor-1

spanMonitor Properties

Property Name	Data Type	Description	Values
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]
mtu	span:MtuValue (scalar:Uint16)	Value of Maximum transmission unit truncation size for SPAN packets	RANGE: [64 , 10240] DEFAULT: 10240
type	span:Type (scalar:Enum8)	Type of the current monitor session	SELECTION: 0 - local 1 - erspan-source 2 - erspanDst 3 - aclCapture 4 - fcIsolaLocal 7 - ethSpanWarp 18 - spanWarp 63 - invalid DEFAULT: local

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html