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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring a Local Session

DME

YANG

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

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

Configuring SPAN

SPAN analyzes all traffic between source ports by directing the SPAN session traffic to a destination port with an external analyzer attached to it. You can define the sources and destinations to monitor in a SPAN session on the local device.

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 a Local Session

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

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 local

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 a Local Session

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

CLI Commands

no monitor session 1 type local

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)	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 All Sessions to Shut

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

CLI Commands

no monitor session all shut

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

spanMonitor Properties

Property Name	Data Type	Description	Values
configState	span:State (scalar:Enum8)	State of the current session as configured by the user	SELECTION: 1 - up 2 - down DEFAULT: down
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]

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 All Sessions Configured to Shut

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

CLI Commands

no monitor session all shut

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

spanMonitor Properties

Property Name	Data Type	Description	Values
configState	span:State (scalar:Enum8)	State of the current session as configured by the user	SELECTION: 1 - up 2 - down DEFAULT: down
id	span:SsnId (scalar:Uint16)	Session identification number for current monitor session.	RANGE: [1 , 32]

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
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

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
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 Source VLAN (Ingress)

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

CLI Commands

monitor session 1
source vlan 2406 rx

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

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 Source VLAN (Ingress)

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

CLI Commands

monitor session 1
no source vlan 2406 rx

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

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
source vlan 2406 both

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

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
no source vlan 2406 both

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

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
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
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
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
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 Source Interface

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

CLI Commands

monitor session 1
source interface ethernet 1/2

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
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 Source Interface (Ingress and Egress)

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

CLI Commands

monitor session 1
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
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
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

Shutting a Monitor Session

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

CLI Commands

monitor session 1
shut

Verifying a DME Configuration

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

spanMonitor Properties

Property Name	Data Type	Description	Values
configState	span:State (scalar:Enum8)	State of the current session as configured by the user	SELECTION: 1 - up 2 - down DEFAULT: down
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

Unconfiguring a Monitor Session Shut

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

CLI Commands

monitor session 1
no shut

Verifying a DME Configuration

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

spanMonitor Properties

Property Name	Data Type	Description	Values
configState	span:State (scalar:Enum8)	State of the current session as configured by the user	SELECTION: 1 - up 2 - down DEFAULT: down
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 Source Interface

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

CLI Commands

monitor session 1 type local
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 a Source Interface (Egress)

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

CLI Commands

monitor session 1 type local
source interface ethernet 1/2 tx

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 local
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 local
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