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

Configuring an ERSPAN Source
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "erspan-source"
}}}]}}
{
    imdata:[]
}
<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>erspan-source</type>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

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.

MODN
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 NameData TypeDescriptionValues
idspan:SsnId
(scalar:Uint16)
Session identification number for current monitor session.
RANGE: [1 , 32]
typespan:Type
(scalar:Enum8)
Type of the current monitor sessionSELECTION:
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

Deleting an ERSPAN Source
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <span-items>
    <monitor-items>
      <Monitor-list nc:operation="delete">
        <id>1</id>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

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.

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

MODN
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 NameData TypeDescriptionValues
idspan:SsnId
(scalar:Uint16)
Session identification number for current monitor session.
RANGE: [1 , 32]
statusmo: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

Configuring Global Origin IP Address in Default VDC Across all VDCs
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "spanErspanOriginIp": {
          "attributes": {
            "isGlobal": "yes",
            "originIp": "1.2.3.4"
}}}]}}
{
    imdata:[]
}
<System>
  <originip-items>
    <isGlobal>true</isGlobal>
    <originIp>1.2.3.4</originIp>
  </originip-items>
</System>

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 erspan origin ip-address 1.2.3.4 global


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.

MODN
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 NameData TypeDescriptionValues
isGlobalscalar:Bool
Denotes whether origin ip is global across all erspan sessionsSELECTION: true or false
DEFAULT: false
originIpaddress:Ip
Global origin IP address for all erspan sessionsValue 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

Configuring the Number of Access Control Groups Allowed on the Same Source Interface
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "aclName": "SampleString_123",
            "allowSharing": "yes",
            "id": "1",
            "type": "erspan-source"
}}}]}}
{
    imdata:[]
}
<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <aclName>SampleString_123</aclName>
        <allowSharing>true</allowSharing>
        <type>erspan-source</type>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

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

MODN
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 NameData TypeDescriptionValues
aclNamespan:AclName
(string:Basic)
Name of the Access Control List applied on the current monitor session
MAX SIZE: 64
DEFAULT:
allowSharingscalar:Bool
Denotes whether sharing is enabled for the given filter ACLSELECTION: true or false
DEFAULT: false
idspan:SsnId
(scalar:Uint16)
Session identification number for current monitor session.
RANGE: [1 , 32]
typespan:Type
(scalar:Enum8)
Type of the current monitor sessionSELECTION:
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

Deleting the Number of Access Control Groups Allowed on the Same Source Interface
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "aclName": "",
            "allowSharing": "no",
            "id": "1",
            "type": "erspan-source"
}}}]}}
{
    imdata:[]
}
<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <aclName></aclName>
        <allowSharing>false</allowSharing>
        <type>erspan-source</type>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

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 erspan-source
 no 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.

MODN
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 NameData TypeDescriptionValues
aclNamespan:AclName
(string:Basic)
Name of the Access Control List applied on the current monitor session
MAX SIZE: 64
DEFAULT:
allowSharingscalar:Bool
Denotes whether sharing is enabled for the given filter ACLSELECTION: true or false
DEFAULT: false
idspan:SsnId
(scalar:Uint16)
Session identification number for current monitor session.
RANGE: [1 , 32]
typespan:Type
(scalar:Enum8)
Type of the current monitor sessionSELECTION:
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)

Configuring a Source VLAN (Ingress) 
POST http://<mgmt0_IP>/api/mo/sys/span.json
{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "erspan-source"
          },
          "children": [
            {
              "spanSourceVlan": {
                "attributes": {
                  "direction": "rx",
                  "isSingleDirDel": "no",
                  "vlan": "vlan-1817"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>erspan-source</type>
        <src-items>
          <SourceVlan-list>
            <vlan>vlan-1817</vlan>
            <direction>rx</direction>
            <isSingleDirDel>false</isSingleDirDel>
          </SourceVlan-list>
        </src-items>
      </Monitor-list>
    </monitor-items>
  </span-items>
</System>

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 erspan-source
 source vlan 1817 rx


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.

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


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 NameData TypeDescriptionValues
idspan:SsnId
(scalar:Uint16)
Session identification number for current monitor session.
RANGE: [1 , 32]
typespan:Type
(scalar:Enum8)
Type of the current monitor sessionSELECTION:
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 NameData TypeDescriptionValues
directionspan:SrcDirection
(scalar:Enum8)
The direction of the source VLAN - Rx, Tx, BothSELECTION:
0 - invalid
1 - rx
2 - tx
3 - both
4 - any
DEFAULT: both
isSingleDirDel
scalar:Bool
NO COMMENTSSELECTION:
  • false - no
  • true - yes
  • DEFAULT: no(false)
  • vlanbase:Encap
    VLAN id for Source VLANSELECTION: 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)

    Deleting a Source VLAN (Ingress) 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceVlan": {
                    "attributes": {
                      "status": "deleted",
                      "vlan": "vlan-1817"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <src-items>
              <SourceVlan-list nc:operation="delete">
                <vlan>vlan-1817</vlan>
              </SourceVlan-list>
            </src-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     no source vlan 1817 rx


    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.

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


    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    Modification statusSELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    vlanbase:Encap
    VLAN id for Source VLANSELECTION: 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)

    Configuring a Source VLAN (Both Directions) 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceVlan": {
                    "attributes": {
                      "direction": "both",
                      "isSingleDirDel": "no",
                      "vlan": "vlan-1817"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <src-items>
              <SourceVlan-list>
                <vlan>vlan-1817</vlan>
                <direction>both</direction>
                <isSingleDirDel>false</isSingleDirDel>
              </SourceVlan-list>
            </src-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     source vlan 1817 both


    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.

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


    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    directionspan:SrcDirection
    (scalar:Enum8)
    The direction of the source VLAN - Rx, Tx, BothSELECTION:
    0 - invalid
    1 - rx
    2 - tx
    3 - both
    4 - any
    DEFAULT: both
    isSingleDirDel
    scalar:Bool
    NO COMMENTSSELECTION:
  • false - no
  • true - yes
  • DEFAULT: no(false)
  • vlanbase:Encap
    VLAN id for Source VLANSELECTION: 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)

    Deleting a Source VLAN (Both Directions) 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceVlan": {
                    "attributes": {
                      "status": "deleted",
                      "vlan": "vlan-1817"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <src-items>
              <SourceVlan-list nc:operation="delete">
                <vlan>vlan-1817</vlan>
              </SourceVlan-list>
            </src-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

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


    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.

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


    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    Modification statusSELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    vlanbase:Encap
    VLAN id for Source VLANSELECTION: 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)

    Configuring SPAN on PFC Frames for an Ethernet Source Interface (Ingress)
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "direction": "rx",
                      "id": "eth1/2",
                      "isSingleDirDel": "no"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list>
                <id>eth1/2</id>
                <direction>rx</direction>
                <isSingleDirDel>false</isSingleDirDel>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     source interface ethernet 1/2 rx allow-pfc


    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.

    MODN
    spanEntity sys/span
    spanMonitor sys/span/monitor-1
    spanSourceIntf sys/span/monitor-1/srcintf-[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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    directionspan:SrcDirection
    (scalar:Enum8)
    The direction of the source interface - Rx, Tx, BothSELECTION:
    0 - invalid
    1 - rx
    2 - tx
    3 - both
    4 - any
    DEFAULT: both
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    isSingleDirDel
    scalar:Bool
    NO COMMENTSSELECTION:
  • 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)

    Deleting SPAN on PFC Frames for an Ethernet Source Interface (Ingress)
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "id": "eth1/2",
                      "status": "deleted"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list nc:operation="delete">
                <id>eth1/2</id>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     no source interface ethernet 1/2 rx allow-pfc


    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.

    MODN
    spanEntity sys/span
    spanMonitor sys/span/monitor-1
    spanSourceIntf sys/span/monitor-1/srcintf-[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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    Modification statusSELECTION:
    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)

    Configuring a Sup-Eth Source Interface (Ingress)
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "direction": "rx",
                      "id": "supeth0"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list>
                <id>supeth0</id>
                <direction>rx</direction>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     source interface sup-eth 0 rx


    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.

    MODN
    spanEntity sys/span
    spanMonitor sys/span/monitor-1
    spanSourceIntf sys/span/monitor-1/srcintf-[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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    directionspan:SrcDirection
    (scalar:Enum8)
    The direction of the source interface - Rx, Tx, BothSELECTION:
    0 - invalid
    1 - rx
    2 - tx
    3 - both
    4 - any
    DEFAULT: both
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust 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)

    Deleting a Sup-Eth Source Interface (Ingress)
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "id": "supeth0",
                      "status": "deleted"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list nc:operation="delete">
                <id>supeth0</id>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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 erspan-source
     no source interface sup-eth 0 rx


    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.

    MODN
    spanEntity sys/span
    spanMonitor sys/span/monitor-1
    spanSourceIntf sys/span/monitor-1/srcintf-[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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    Modification statusSELECTION:
    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

    Configuring a Remote IP Address
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "destinationIp": "1.2.3.4",
                "id": "1",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <destinationIp>1.2.3.4</destinationIp>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      destination ip 1.2.3.4


    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.

    MODN
    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 NameData TypeDescriptionValues
    destinationIpaddress:Ip
    Destination IP address for the current erspan sessionValue must match ipv4 or ipv6 known format
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting a Remote IP Address
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "destinationIp": "0.0.0.0",
                "id": "1",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <destinationIp>0.0.0.0</destinationIp>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no destination ip 1.2.3.4


    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.

    MODN
    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 NameData TypeDescriptionValues
    destinationIpaddress:Ip
    Destination IP address for the current erspan sessionValue must match ipv4 or ipv6 known format
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Configuring IP DSCP
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "ipDscp": "1",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <ipDscp>1</ipDscp>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      ip dscp 1


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    ipDscpspan:IpDscp
    (scalar:Uint16)
    ERSPAN IP DSCP value
    RANGE: [0 , 63]
    DEFAULT: 0
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting IP DSCP
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "ipDscp": "0",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <ipDscp>0</ipDscp>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no ip dscp 1


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    ipDscpspan:IpDscp
    (scalar:Uint16)
    ERSPAN IP DSCP value
    RANGE: [0 , 63]
    DEFAULT: 0
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Configuring the IP Time-to-Live Value 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "ipTtl": "196",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <ipTtl>196</ipTtl>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      ip ttl 196


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    ipTtlspan:IpTtl
    (scalar:Uint16)
    ERSPAN IP time-to-live value
    RANGE: [1 , 255]
    DEFAULT: 255
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting the IP Time-to-Live Value 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "ipTtl": "255",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <ipTtl>255</ipTtl>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no ip ttl 196


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    ipTtlspan:IpTtl
    (scalar:Uint16)
    ERSPAN IP time-to-live value
    RANGE: [1 , 255]
    DEFAULT: 255
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Configuring the Source Interface
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "direction": "both",
                      "id": "eth1/2",
                      "isSingleDirDel": "no"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list>
                <id>eth1/2</id>
                <direction>both</direction>
                <isSingleDirDel>false</isSingleDirDel>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

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

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


    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    directionspan:SrcDirection
    (scalar:Enum8)
    The direction of the source interface - Rx, Tx, BothSELECTION:
    0 - invalid
    1 - rx
    2 - tx
    3 - both
    4 - any
    DEFAULT: both
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    isSingleDirDel
    scalar:Bool
    NO COMMENTSSELECTION:
  • 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)

    Configuring the Source Interface (Ingress and Egress) 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source"
              },
              "children": [
                {
                  "spanSourceIntf": {
                    "attributes": {
                      "direction": "both",
                      "id": "eth1/2",
                      "isSingleDirDel": "no"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <srcintf-items>
              <SourceIntf-list>
                <id>eth1/2</id>
                <direction>both</direction>
                <isSingleDirDel>false</isSingleDirDel>
              </SourceIntf-list>
            </srcintf-items>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      source interface ethernet 1/2 both


    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.

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


    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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 NameData TypeDescriptionValues
    directionspan:SrcDirection
    (scalar:Enum8)
    The direction of the source interface - Rx, Tx, BothSELECTION:
    0 - invalid
    1 - rx
    2 - tx
    3 - both
    4 - any
    DEFAULT: both
    idnw:IfId
    (base:IfIndex)
    The interface id for the sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    isSingleDirDel
    scalar:Bool
    NO COMMENTSSELECTION:
  • 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

    Configuring a Drop SPAN Session as Low Priority
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "isFwdDropsRx": "yes",
                "isFwdDropsRxLowPriority": "yes",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <isFwdDropsRx>true</isFwdDropsRx>
            <isFwdDropsRxLowPriority>true</isFwdDropsRxLowPriority>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      source forward-drops rx priority-low


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    isFwdDropsRxscalar:Bool
    Denotes whether source forwarding drops rx is enabled for the given erspan-source sessionSELECTION: true or false
    DEFAULT: false
    isFwdDropsRxLowPriorityscalar:Bool
    Denotes whether source forwarding drops rx has low priority for the given erspan-source sessionSELECTION: true or false
    DEFAULT: false
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting a Drop SPAN Session as Low Priority
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "isFwdDropsRx": "no",
                "isFwdDropsRxLowPriority": "no",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <isFwdDropsRx>false</isFwdDropsRx>
            <isFwdDropsRxLowPriority>false</isFwdDropsRxLowPriority>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no source forward-drops rx priority-low


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    isFwdDropsRxscalar:Bool
    Denotes whether source forwarding drops rx is enabled for the given erspan-source sessionSELECTION: true or false
    DEFAULT: false
    isFwdDropsRxLowPriorityscalar:Bool
    Denotes whether source forwarding drops rx has low priority for the given erspan-source sessionSELECTION: true or false
    DEFAULT: false
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Configuring a VRF Membership
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source",
                "vrfName": "SampleString_123"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <vrfName>SampleString_123</vrfName>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

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


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    0 - local
    1 - erspan-source
    2 - erspanDst
    3 - aclCapture
    4 - fcIsolaLocal
    7 - ethSpanWarp
    18 - spanWarp
    63 - invalid
    DEFAULT: local
    vrfNamespan: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

    Deleting a VRF Membership
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "type": "erspan-source",
                "vrfName": ""
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <type>erspan-source</type>
            <vrfName></vrfName>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no vrf SampleString_123


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    0 - local
    1 - erspan-source
    2 - erspanDst
    3 - aclCapture
    4 - fcIsolaLocal
    7 - ethSpanWarp
    18 - spanWarp
    63 - invalid
    DEFAULT: local
    vrfNamespan: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

    Configuring the ERSPAN Id 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "erspanId": "736",
                "id": "1",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <erspanId>736</erspanId>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      erspan-id 736


    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.

    MODN
    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 NameData TypeDescriptionValues
    erspanIdspan:ErspanId
    (scalar:Uint16)
    ERSPAN identification number
    RANGE: [0 , 1023]
    DEFAULT: 0
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting the ERSPAN Id 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "erspanId": "0",
                "id": "1",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <erspanId>0</erspanId>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no erspan-id 736


    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.

    MODN
    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 NameData TypeDescriptionValues
    erspanIdspan:ErspanId
    (scalar:Uint16)
    ERSPAN identification number
    RANGE: [0 , 1023]
    DEFAULT: 0
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Configuring the MTU size for SPAN Packets 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "mtu": "1333",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <mtu>1333</mtu>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

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


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    mtuspan:MtuValue
    (scalar:Uint16)
    Value of Maximum transmission unit truncation size for SPAN packets
    RANGE: [64 , 10240]
    DEFAULT: 10240
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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

    Deleting the MTU size for SPAN Packets 
    
    POST http://<mgmt0_IP>/api/mo/sys/span.json
    
    {
      "spanEntity": {
        "children": [
          {
            "spanMonitor": {
              "attributes": {
                "id": "1",
                "mtu": "10240",
                "type": "erspan-source"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <span-items>
        <monitor-items>
          <Monitor-list>
            <id>1</id>
            <mtu>10240</mtu>
            <type>erspan-source</type>
          </Monitor-list>
        </monitor-items>
      </span-items>
    </System>
    

    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
      no mtu 1333


    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.

    MODN
    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 NameData TypeDescriptionValues
    idspan:SsnId
    (scalar:Uint16)
    Session identification number for current monitor session.
    RANGE: [1 , 32]
    mtuspan:MtuValue
    (scalar:Uint16)
    Value of Maximum transmission unit truncation size for SPAN packets
    RANGE: [64 , 10240]
    DEFAULT: 10240
    typespan:Type
    (scalar:Enum8)
    Type of the current monitor sessionSELECTION:
    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