Configuring NetFlow on an Ethernet Interface

Configuring a Flow Monitor for IPv4 Ingress Traffic

Configuring a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer3",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list>
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 no switchport
  ip flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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 Flow Monitor for IPv4 Ingress Traffic

Deleting a Flow Monitor for IPv4 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer3",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "status": "deleted",
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list xc:operation="delete">
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 no switchport
  no ip flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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 Flow Monitor for IPv6 Ingress Traffic

Configuring a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer3",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list>
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 no switchport
  ipv6 flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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 Flow Monitor for IPv6 Ingress Traffic

Deleting a Flow Monitor for IPv6 Ingress Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer3",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "status": "deleted",
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer3</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list xc:operation="delete">
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 no switchport
  no ipv6 flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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 Flow Monitor for Layer 2-Switched Traffic

Configuring the Flow Monitor for Layer 2-Switched Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list>
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 switchport
  layer2-switched flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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 Flow Monitor for Layer 2-Switched Traffic

Deleting the Flow Monitor for Layer 2-Switched Traffic
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      },
      {
        "analyticsHwTelemetry": {
          "children": [
            {
              "netflowNetflow": {
                "children": [
                  {
                    "netflowInst": {
                      "attributes": {
                        "mode": "netflow"
                      },
                      "children": [
                        {
                          "netflowFwdInstTarget": {
                            "attributes": {
                              "id": "436208128"
                            },
                            "children": [
                              {
                                "netflowRsMonitorAtt": {
                                  "attributes": {
                                    "status": "deleted",
                                    "tDn": "sys/hwtelemetry/netflow/inst-netflow/monitor-mon_1"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </PhysIf-list>
    </phys-items>
  </intf-items>
  <hwtelemetry-items>
    <netflow-items>
      <inst-items>
        <Inst-list>
          <mode>netflow</mode>
          <fwdinst-items>
            <FwdInstTarget-list>
              <id>436208128</id>
              <rsmonitorAtt-items>
                <RsMonitorAtt-list xc:operation="delete">
                  <tDn>/System/hwtelemetry-items/netflow-items/inst-items/Inst-list[mode='netflow']/monitor-items/Monitor-list[name='mon_1']</tDn>
                </RsMonitorAtt-list>
              </rsmonitorAtt-items>
            </FwdInstTarget-list>
          </fwdinst-items>
        </Inst-list>
      </inst-items>
    </netflow-items>
  </hwtelemetry-items>
</System>

Note: This example was added in Release 9.2(2).


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.

interface ethernet 1/2
 switchport
  no layer2-switched flow monitor mon_1 input

Note: The property information for this example was added in Release 9.3(3).


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
interfaceEntity sys/intf
l1PhysIf sys/intf/phys-{[id]}
analyticsHwTelemetry sys/hwtelemetry
netflowNetflow sys/hwtelemetry/netflow
netflowInst sys/hwtelemetry/netflow/inst-{mode}
netflowFwdInstTarget sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}
netflowRsMonitorAtt sys/hwtelemetry/netflow/inst-{mode}/fwdinst-{id}/rsmonitorAtt-{[tDn]}


l1PhysIf Properties

The following table contains information about the l1PhysIf 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)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
layerl1:Layer
(scalar:Enum8)
Administrative port layerSELECTION:
1 - Layer2
2 - Layer3
DEFAULT: Layer2
userCfgdFlagsl1:userCfgdFlags
(scalar:Bitmask8)
Port User Config FlagsSELECTION:
0 - none
1 - admin_state
2 - admin_layer
4 - admin_router_mac
8 - admin_dce_mode
16 - admin_mtu
DEFAULT: none


netflowInst Properties

The following table contains information about the netflowInst 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
modenetflow:ModeT
(scalar:Enum8)
It represents the mode in which netflow is runningSELECTION:
0 - netflow
DEFAULT: netflow


netflowFwdInstTarget Properties

The following table contains information about the netflowFwdInstTarget 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
idnetflow:FwdInstTargetId
(scalar:Uint32)
Identifier to the Forward Instance Target
RANGE: [0 , 4294967295]


netflowRsMonitorAtt Properties

The following table contains information about the netflowRsMonitorAtt 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)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced
tDn
reln:Dn
reference:BinRef
The distinguished name of the target.


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