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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling OpenFlow

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmOpenFlow": {
          "attributes": {
            "adminSt": ""
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <fm-items>
    <openflow-items>
      <adminSt></adminSt>
    </openflow-items>
  </fm-items>
</System>

Configuring OpenFlow

OpenFlow is an open standardized interface that allows a software-defined networking (SDN) controller to manage the forwarding plane of a network. Cisco OpenFlow Agent provides better control over networks making them more open, programmable, and application-aware and supports the following specifications defined by the Open Networking Foundation (ONF) standards organization:

OpenFlow Switch Specification Version 1.0.1 (Wire Protocol 0x01) (referred to as OpenFlow 1.0)
OpenFlow Switch Specification Version 1.3.0 (Wire Protocol 0x04), referred to as OpenFlow 1.3 These specifications are based on the concept of an Ethernet switch, with an internal flow table and standardized interface to allow traffic flows on a device to be added or removed. OpenFlow 1.3 defines the communication channel between Cisco OpenFlow Agent and controllers. A controller can be Cisco Open SDN Controller, or any controller compliant with OpenFlow 1.3. In an OpenFlow network, Cisco OpenFlow Agent exists on the device and controllers exist on a server that is external to the device. Flow management and any network management are either part of a controller or accomplished through a controller. Flow management includes the addition, modification, or removal of flows, and the handling of OpenFlow error messages.

For more information, see the Cisco OpenFlow Agent for Nexus 3000 and 9000 Series Switches:

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

Enabling OpenFlow

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.

feature openflow

Verifying a DME Configuration

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

MO	DN
fmEntity	sys/fm
fmOpenFlow	sys/fm/openflow

fmOpenFlow Properties

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

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - 2 - disabled DEFAULT: disabled

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

Disabling OpenFlow

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

CLI Commands

no feature openflow

Verifying a DME Configuration

MO	DN
fmEntity	sys/fm
fmOpenFlow	sys/fm/openflow

fmOpenFlow Properties

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - 2 - disabled DEFAULT: disabled

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 OpenFlow

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

CLI Commands

openflow

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow

openflowEntity Properties

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

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

Disabling OpenFlow

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

CLI Commands

no openflow

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

Choosing a Forwarding Profile

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

CLI Commands

openflow
switch 1 pipeline 201

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

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

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

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

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

CLI Commands

openflow
no switch 1 pipeline 201

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 an OpenFlow Controller

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

CLI Commands

openflow
switch 1 pipeline 201
controller ipv4 1.2.3.4

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

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

Enabling Logging for Flow-Modify

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

CLI Commands

openflow
switch 1 pipeline 201
logging flow-mod

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

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

Property Name	Data Type	Description	Values
logFlowMod	scalar:Bool	OpenFlow Mod Requests Logging Enable	SELECTION: true or 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

Disabling Logging for Flow-Modify

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

CLI Commands

openflow
switch 1 pipeline 201
no logging flow-mod

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
logFlowMod	scalar:Bool	OpenFlow Mod Requests Logging Enable	SELECTION: true or 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

Adding an Interface to an OpenFlow Switch

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

CLI Commands

openflow
switch 1 pipeline 201
of-port interface ethernet 1/2

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowIf	sys/openflow/pipeline-201/if-[eth1/2]

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowIf Properties

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

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	To hold openflow port interface id	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
ofPort	nw:AdminSt (scalar:Enum8)	Track whether Openflow is enabled on the Interface	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

Removing an Interface to an OpenFlow Switch

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

CLI Commands

openflow
switch 1 pipeline 201
no of-port interface ethernet 1/2

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowIf	sys/openflow/pipeline-201/if-[eth1/2]

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	To hold openflow port interface id	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
ofPort	nw:AdminSt (scalar:Enum8)	Track whether Openflow is enabled on the Interface	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 an OpenFlow Switch Shutdown

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

CLI Commands

openflow
switch 1 pipeline 201
shutdown

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
shutdown	nw:AdminSt (scalar:Enum8)	Shutdown OpenFlow Switch Instance	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

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

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

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

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

Unconfiguring an OpenFlow Switch Shutdown

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

CLI Commands

openflow
switch 1 pipeline 201
no shutdown

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
shutdown	nw:AdminSt (scalar:Enum8)	Shutdown OpenFlow Switch Instance	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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

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

CLI Commands

openflow
switch 1 pipeline 201
datapath-id 123

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
datapathId	string:Basic	OpenFlow Protocol Datapath Id	RANGE: [1 , 20]

Related Documentation

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

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

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

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

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

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

Unconfiguring a Datapath Id

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

CLI Commands

openflow
switch 1 pipeline 201
no datapath-id

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
datapathId	string:Basic	OpenFlow Protocol Datapath Id	RANGE: [1 , 20]

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 Forward to Normal Dataplane

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

CLI Commands

openflow
switch 1 pipeline 201
default-miss normal

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
defaultMiss	scalar:Enum8	Openflow Default Miss flow action	DEFAULT: drop

Related Documentation

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

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

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

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

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

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

Unconfiguring Forward to Normal Dataplane

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

CLI Commands

openflow
switch 1 pipeline 201
no default-miss

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
defaultMiss	scalar:Enum8	Openflow Default Miss flow action	DEFAULT: drop

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 Max-Backoff Timer

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

CLI Commands

openflow
switch 1 pipeline 201
max-backoff 123

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
maxBackOff	scalar:Uint16	Openflow Protocol Max Backoff Timer	RANGE: [1 , 65535]

Related Documentation

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

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

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

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

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

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

Unconfiguring Max-Backoff Timer

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

CLI Commands

openflow
switch 1 pipeline 201
no max-backoff

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
maxBackOff	scalar:Uint16	Openflow Protocol Max Backoff Timer	RANGE: [1 , 65535]

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 OpenFlow Controller Probe Interval Timer

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

CLI Commands

openflow
switch 1 pipeline 201
probe-interval 567

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
probeInterval	scalar:Uint16	Openflow Protocol Probe Interval	RANGE: [5 , 65535]

Related Documentation

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

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

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

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

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

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

Unconfiguring OpenFlow Controller Probe Interval Timer

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

CLI Commands

openflow
switch 1 pipeline 201
no probe-interval

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
probeInterval	scalar:Uint16	Openflow Protocol Probe Interval	RANGE: [5 , 65535]

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 OpenFlow Protocol Version

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

CLI Commands

openflow
switch 1 pipeline 201
protocol-version 1.0

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
protoVersion	scalar:Enum8	Openflow Protocol Version	DEFAULT: Negotiate

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

Unonfiguring OpenFlow Protocol Version

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

CLI Commands

openflow
switch 1 pipeline 201
no protocol-version

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
protoVersion	scalar:Enum8	Openflow Protocol Version	DEFAULT: Negotiate

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 Address for Connection to Controllers

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

CLI Commands

openflow
switch 1 pipeline 201
source 1.2.3.4

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
sourceIpAddr	address:Ip	Source IP Addr for Connection to OpenFlow Controller	Value must match ipv4 or ipv6 known format

Related Documentation

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

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

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

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

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

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

Unconfiguring the Source Address for Connection to Controllers

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

CLI Commands

openflow
switch 1 pipeline 201
no source 1.2.3.4

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
sourceIpAddr	address:Ip	Source IP Addr for Connection to OpenFlow Controller	Value must match ipv4 or ipv6 known format

Related Documentation

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

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

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

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

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

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

Configuring Statistics-Related Commands

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

CLI Commands

openflow
switch 1 pipeline 201
statistics collection-interval 123

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
statsCollectInterval	scalar:Uint16	OpenFlow Statistics Collection Interval	RANGE: [0 , 600]

Related Documentation

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

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

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

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

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

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

Unconfiguring Statistics-Related Commands

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

CLI Commands

openflow
switch 1 pipeline 201
no statistics collection-interval

Verifying a DME Configuration

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-201
openflowAgent	sys/openflow/pipeline-201/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
statsCollectInterval	scalar:Uint16	OpenFlow Statistics Collection Interval	RANGE: [0 , 600]

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 Burst Rate-limit

Code section - 28

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

CLI Commands

openflow
switch 1 pipeline 201
rate-limit packet_in 1000 burst 2000
username sample_user keypair generate dsa 1024

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

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-{pipelineId}
openflowAgent	sys/openflow/pipeline-{pipelineId}/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
controllerBurstPPS	scalar:Uint16	Openflow Channel Packets to Controller In PPS	RANGE: [0 , 65535] DEFAULT: 0
packetInPPS	scalar:Uint16	Openflow Channel Packets In Rate in PPS	RANGE: [0 , 65535] DEFAULT: 0

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

Code section - 29

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

CLI Commands

openflow switch 1 pipeline 201 no rate-limit

MO	DN
topSystem	sys
openflowEntity	sys/openflow
openflowInst	sys/openflow/pipeline-{pipelineId}
openflowAgent	sys/openflow/pipeline-{pipelineId}/agent

openflowEntity Properties

Property Name	Data Type	Description	Values
ofAdminSt	nw:AdminSt (scalar:Enum8)	OpenFlow Admin State	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

openflowInst Properties

Property Name	Data Type	Description	Values
pipelineId	scalar:Uint16	Openflow Forwarding pipeline-id	RANGE: [1 , 65535]

openflowAgent Properties

Property Name	Data Type	Description	Values
controllerBurstPPS	scalar:Uint16	Openflow Channel Packets to Controller In PPS	RANGE: [0 , 65535] DEFAULT: 0
packetInPPS	scalar:Uint16	Openflow Channel Packets In Rate in PPS	RANGE: [0 , 65535] DEFAULT: 0

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