Configuring a Local Source Session

Configuring a Destination Ethernet Interface

Configuring a Destination Ethernet Interface

POST http://<mgmt0_IP>/api/mo/sys/span.json

{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "destinationPorts": "eth1/2",
            "id": "1",
            "type": "local"
}}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <destinationPorts>eth1/2</destinationPorts>
        <type>local</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 local
 destination 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


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
destinationPortsnw:IfId
(base:IfIndex)		Destination ports for the current sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 Destination Ethernet Interface

Deleting a Destination Ethernet Interface

POST http://<mgmt0_IP>/api/mo/sys/span.json

{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "local"
}}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</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 local
 no destination 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


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

Configuring a Destination Port Channel Interface

Configuring a Destination Port Channel Interface

POST http://<mgmt0_IP>/api/mo/sys/span.json

{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "destinationPorts": "po123",
            "id": "1",
            "type": "local"
}}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <destinationPorts>po123</destinationPorts>
        <type>local</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 local
 destination interface port-channel 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
destinationPortsnw:IfId
(base:IfIndex)		Destination ports for the current sessionMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 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": "local"
}}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <aclName>SampleString_123</aclName>
        <allowSharing>true</allowSharing>
        <type>local</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 local
 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": "local"
}}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <aclName></aclName>
        <allowSharing>false</allowSharing>
        <type>local</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 local
 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 Source VLAN (Ingress)

Configuring Source VLAN (Ingress) 

POST http://<mgmt0_IP>/api/mo/sys/span.json

{
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "local"
          },
          "children": [
            {
              "spanSourceVlan": {
                "attributes": {
                  "direction": "rx",
                  "isSingleDirDel": "no",
                  "vlan": "vlan-3730"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</type>
        <src-items>
          <SourceVlan-list>
            <vlan>vlan-3730</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 local
 source vlan 3730 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-3730]


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 (Egress)

    Deleting a Source VLAN (Egress) 

    POST http://<mgmt0_IP>/api/mo/sys/span.json

    {
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "type": "local"
          },
          "children": [
            {
              "spanSourceVlan": {
                "attributes": {
                  "status": "deleted",
                  "vlan": "vlan-3730"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</type>
        <src-items>
          <SourceVlan-list nc:operation="delete">
            <vlan>vlan-3730</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 local
     no source vlan 3730 tx


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


    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": "local"
          },
          "children": [
            {
              "spanSourceVlan": {
                "attributes": {
                  "direction": "both",
                  "isSingleDirDel": "no",
                  "vlan": "vlan-3730"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</type>
        <src-items>
          <SourceVlan-list>
            <vlan>vlan-3730</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 local
     source vlan 3730 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-3730]


    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": "local"
          },
          "children": [
            {
              "spanSourceVlan": {
                "attributes": {
                  "status": "deleted",
                  "vlan": "vlan-3730"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</type>
        <src-items>
          <SourceVlan-list nc:operation="delete">
            <vlan>vlan-3730</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 local
     no source vlan 3730 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-3730]


    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": "local"
          },
          "children": [
            {
              "spanSourceIntf": {
                "attributes": {
                  "direction": "rx",
                  "id": "eth1/2",
                  "isSingleDirDel": "no"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</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 local
     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": "local"
          },
          "children": [
            {
              "spanSourceIntf": {
                "attributes": {
                  "id": "eth1/2",
                  "status": "deleted"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</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 local
     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": "local"
          },
          "children": [
            {
              "spanSourceIntf": {
                "attributes": {
                  "direction": "rx",
                  "id": "supeth0"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</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 local
     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": "local"
          },
          "children": [
            {
              "spanSourceIntf": {
                "attributes": {
                  "id": "supeth0",
                  "status": "deleted"
}}}]}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <type>local</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 local
     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 MTU

    Configuring MTU

    POST http://<mgmt0_IP>/api/mo/sys/span.json

    {
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "mtu": "65",
            "type": "local"
}}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <mtu>65</mtu>
        <type>local</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 local
     mtu 65


    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 an MTU Configuration

    Deleting an MTU Configuration

    POST http://<mgmt0_IP>/api/mo/sys/span.json

    {
  "spanEntity": {
    "children": [
      {
        "spanMonitor": {
          "attributes": {
            "id": "1",
            "mtu": "10240",
            "type": "local"
}}}]}}

    {
    imdata:[]
}

    <System>
  <span-items>
    <monitor-items>
      <Monitor-list>
        <id>1</id>
        <mtu>10240</mtu>
        <type>local</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 local
     no mtu 65


    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