OpenFlow Commands

protocol openflow
no protocol openflow

Unhides the OpenFlow commands.
The no form of the command hides the OpenFlow commands.

Syntax Description

N/A

Default

no protocol openflow

Configuration Mode

config

History

3.3.4200

Example

switch (config) # protocol openflow

Related Commands

Notes

openflow mode hybrid
no openflow mode

Enables OpenFlow on the port.
The no form of the command returns the port to its default state.

Syntax Description

N/A

Default

no openflow mode

Configuration Mode

config interface ethernet
config interface port-channel
config interface mlag-port-channel

History

3.3.4200

3.6.2100

Updated notes

3.9.2000

Updated example and notes

3.9.2400

Added mlag-port-channel configuration option and updated note

Example

switch (config interface ethernet 1/1)# openflow mode hybrid
switch (config interface port-channel 1)# openflow mode hybrid
switch (config interface mlag-port-channel 1)# openflow mode hybrid

Related Commands

protocol openflow

Notes

Running OpenFlow on the MLAG interface has several limitations. Please see them in the section "Support of MLAG Interface in OpenFlow" section

openflow del-flows [<flow-id>]

Deletes OpenFlow flow.

Syntax Description

flow-id

ID number to give this flow
Range: 0-65535

Default

N/A

Configuration Mode

config

History

3.6.4006

3.9.1000

Updated note

Example

switch (config)# openflow del-flows 1

Related Commands

Notes

If flow ID "all" is provided, the command deletes all configured OpenFlow flows

openflow add-group <group-id> <group-type> <bucket-parameter1>[,...,<bucket-parameterN>]

Adds an OpenFlow group.

Syntax Description

group-id

Group ID number

group-type

For a list of supported group types, see the group column in “OpenFlow 1.3 Pipeline Capabilities Summary Table”

bucket parameter

Possible values:

• actions=output,...,output

• bucket_id=<id-number>

• watch_group=<group_id>

• watch_port=<port>

• weight=<value>

Default

N/A

Configuration Mode

config

History

3.6.4006

3.9.1600

Added note

Example

switch (config) # openflow add-group group_id=3,type=ff,bucket=watch_port:117,output:123,bucket=watch_port:123,output:119,bucket=watch_port:111,output:119,113,121,115,123,109,117

Related Commands

Notes

The maximum number of ports in one OpenFlow group is as follows:

• 64 ports in Spectrum-based systems

• 128 ports in Spectrum-2 and Spectrum-3 systems

openflow del-group <group-id>

Deletes matching OpenFlow group ID.

Syntax Description

group-id

Group ID number

Default

N/A

Configuration Mode

config

History

3.6.4006

3.9.1000

Updated note

Example

switch (config)# openflow del-group

Related Commands

Notes

If group ID "all" is provided, the command deletes all configured OpenFlow groups.

openflow mod-group <group-id> <group-type> <bucket-parameter1>[,...,<bucket-parameterN>]

Modifies matching OpenFlow group ID.

Syntax Description

group-id

Group ID number

group-type

For a list of supported group types, see the group column in “OpenFlow 1.3 Pipeline Capabilities Summary Table”

bucket parameter

Possible values:

• actions=output,...,output

• bucket_id=<id-number>

• watch_group=<group_id>

• watch_port=<port>

• weight=<value>

Default

N/A

Configuration Mode

config

History

3.6.4006

Example

switch (config)# openflow mod-group group_id=3,type=ff,bucket=watch_port:117,output:123,bucket=watch_port:123,output:119,bucket=watch_port:111,output:119,113,121,115,123,109,117,119

Related Commands

openflow add-group

Notes

A group must exist in order to execute this command

openflow add-meter <meter-id> <meter-rule> <band-parameter1>[,...,<band-parameterN>]

Adds OpenFlow meter.

Syntax Description

meter-id

Meter ID number

meter-rule

For a list of supported meters types, see the meter column in “OpenFlow 1.3 Pipeline Capabilities Summary Table”

band-parameter

Possible values:

• type={type | drop}

• rate=<value>

• burst_size=<size>

Default

N/A

Configuration Mode

config

History

3.6.4006

Example

switch (config)# openflow add-meter meter=6,pktps,band=type=drop,rate=10

Related Commands

Notes

openflow del-meter <meter-id>

Deletes matching OpenFlow meter ID.

Syntax Description

meter-id

Meter ID number

Default

N/A

Configuration Mode

config

History

3.6.4006

3.9.1000

Updated note

Example

switch (config)# openflow del-meter meter=6

Related Commands

Notes

If meter ID "all" is provided, the command deletes all configured OpenFlow meters.

openflow fail-mode secure
no openflow fail-mode secure

Enables the “fail secure mode” of the switch.
The no form of the command disables the “fail secure mode” of the switch.

Syntax Description

N/A

Default

Enabled

Configuration Mode

Config

History

3.8.2100

3.9.1600

Added note below

Example

switch (config) # no openflow fail-mode secure

Related Commands

Notes

In the case that a switch loses contact with all controllers as a result of echo request timeouts, TLS session timeouts, or other disconnections, the switch should immediately enter either “fail secure mode” or “fail standalone mode" (depending upon the switch implementation and configuration). "Fail secure mode" only affects the switch behavior in that packets and messages destined to go to the controllers are dropped. Flow entries should continue to expire according to their timeouts in “fail secure mode." In “fail standalone mode," the switch processes all packets using the OFPP_NORMAL reserved port and the switch acts as a legacy Ethernet switch or router.

openflow mod-meter <meter-id> <meter-rule> <band-parameter1>[,...,<band-parameterN>]

Modifies matching OpenFlow meter ID.

Syntax Description

meter-id

Meter ID number

meter-rule

For a list of supported meters types, see the meter column in “OpenFlow 1.3 Pipeline Capabilities Summary Table”

band-parameter

Possible values:

• type={type | drop}

• rate=<value>

• burst_size=<size>

Default

N/A

Configuration Mode

config

History

3.6.4006

Example

switch (config)# openflow mod-meter meter=6,pktps,band=type=drop,rate=10

Related Commands

Notes

openflow re-apply flows <flow-id>

Reapplies matching flow ID.

Syntax Description

flow-id

Range: 0-65535

Default

N/A

Configuration Mode

config

History

3.6.4006

Example

switch (config)# openflow re-apply flows 58

Related Commands

Notes

openflow re-apply groups <group-id>

Reapplies matching group ID.

Syntax Description

group-id

Range: 0-65535

Default

N/A

Configuration Mode

config

History

3.6.4006

Example

switch (config)# openflow re-apply groups group_id=2

Related Commands

Notes

openflow re-apply meters <meter-id>

Reapplies matching meters ID.

Syntax Description

meter-id

Range: 0-65535

Default

N/A

Configuration Mode

config interface ethernet

History

3.6.4006

Example

switch (config interface ethernet 1/1)# openflow re-apply meters 13

Related Commands

Notes

openflow controller-ip <ip-address> [tls] [tcp-port <tcp-port>]
no openflow controller-ip <ip-address> [tls] [tcp-port <tcp-port>]

Configures the OpenFlow controller’s IP & TCP port.
The command “no openflow controller-ip <ip-address>” deletes all OpenFlow controller configurations related to its IP address.
The command “no openflow controller-ip <ip-address> tcp-port” deletes all the OpenFlow controller configurations related to IP address, and any tcp-port except for TLS ones.
The command “no openflow controller-ip <ip-address> [tls] tcp-port <tcp-port>” deletes the entry for the OpenFlow controller IP address, TLS (if applicable), and the TCP port

Syntax Description

ip-address

The IPv4 address of the OpenFlow controller

tls

Configures secure connection to OpenFlow controller

tcp-port

Sets the TCP port number of the OpenFlow controller

Default

TCP port 6633

Configuration Mode

config openflow

History

3.6.1002

3.6.2002

Added “tls” parameter

Example

switch (config openflow) # controller-ip 10.10.10.10 tls tcp-port 6633

Related Commands

Notes

datapath-id <value>
no datapath-id

Sets a specific identifier for the switch with which the controller is communicating.
The no form of the command resets the parameter to its default value.

Syntax Description

value

The most significant 16 bits of the agent data-path ID
Range: 0x0000-0xFFFF in hexa

Default

0x0000

Configuration Mode

config openflow

History

3.3.4200

Example

switch (config openflow) # datapath-id 0x1234

Related Commands

Notes

openflow table <table_id[-table_id]> match-keys <key_list>
no openflow table <table_id[-table_id]> match-keys [<key_list>]

Adds ACL keys to an OpenFlow table.
The no form of the command removes ACL keys from the OpenFlow table.

Syntax Description

table_id

OpenFlow table ID for adding/removing key values. Can be one ID or range. Range: 0-249.

key_list

Key value(s)

Default

0x0000

Configuration Mode

config

History

3.3.4200

3.9.0300

Added note of supported keys

Example

switch (config) # openflow table 1 match-keys metadata ip_proto

Related Commands

Notes

• OpenFlow match rules are installed according to the configured match keys

• New match keys are configured only when the table is empty (i.e. does not contain any rules)

• The following are the supported keys in this command:

 Key name       Description
 -------------------------------
 in_port        Source port
 dl_src         Source MAC address
 dl_dst         Destination MAC address
 dl_type        Ethernet protocol type
 vlan_vid       Virtual LAN tag
 vlan_pcp       Priority Code Point
 ip_src         Source IPv4 address
 ip_dst         Destination IPv4 address
 ip_proto       IPV4 - Next protocol, IPV6 - Next header
 ip_dscp        IP ToS/DSCP or IPv6 traffic class field dscp
 ip_ecn         ECN bits from IP header
 ip_ttl         IP TTL or IPv6 hop limit
 l4_src_port    Source L4 port
 l4_dst_port    Destination L4 port

openflow acl table <id/range> counter disable
no openflow acl table <id/range> counter disable

Disables counter for a specific ACL or range of ACL OpenFlow tables.
The no form of the command enables counter for ACL table.

Syntax Description

id/range

Specific ACL or range of ACL OpenFlow tables.

Default

Enabled counter for all ACL tables.

Configuration Mode

config

History

3.9.2000

Example

switch (config) # openflow acl table 10 counter disable
switch (config) # openflow acl table 0-249 counter disable
switch (config) # no openflow acl table 0-10 counter disable

Related Commands

Notes

show openflow flows

Displays information about the OpenFlow flows.

Syntax Description

N/A

Default

N/A

Configuration Mode

Any command mode

History

3.3.4302

3.6.1002

Updated example

Example

switch (config) # show openflow flows
OFPST_FLOW reply (OF1.3) (xid=0x2):
cookie=0x0, duration=467.993s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=8,in_port=125 actions=output:123
cookie=0x0, duration=439.218s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=9999,in_port=125 actions=output:123
cookie=0x0, duration=467.984s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=1000 actions=drop
cookie=0x0, duration=467.975s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=200,dl_vlan=222 actions=pop_vlan,output:123
cookie=0x0, duration=467.987s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=10,dl_vlan=10 actions=output:123
cookie=0x0, duration=468.013s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=8,dl_dst=01:01:01:01:01:01 actions=output:123
cookie=0x0, duration=467.991s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=8,dl_src=01:01:01:01:01:01 actions=output:123
cookie=0x0, duration=467.992s, table=0, n_packets=0, n_bytes=0, send_flow_rem priority=5,arp actions=output:123

Related Commands

Notes

show openflow meters [<ID>]

Displays all/specified OpenFlow meters.

Syntax Description

ID

Requested meter ID

Default

N/A

Configuration Mode

Any command mode

History

3.6.3004

Example

switch (config) # show openflow meters
OFPST_METER_CONFIG reply (OF1.3) (xid=0x2):
meter=20 kbps bands=
type=drop rate=300
meter=100 kbps bands=
type=drop rate=500
meter=200 kbps bands=
type=drop rate=500
switch (config) # show openflow meters 20
OFPST_METER_CONFIG reply (OF1.3) (xid=0x2):
meter=20 kbps bands=
type=drop rate=300

Related Commands

Notes

show openflow table <table_id[-table_id]> match-keys

Displays configured ACL keys in OpenFlow table.

Syntax Description

table_id

OpenFlow table ID for adding/removing key values. Can be one ID or range. Range: 0-249.

Default

N/A

Configuration Mode

Any command mode

History

3.6.3004

Example

switch (config) # show openflow table 2 match-keys
Table:                                                       2
Pending keys:
Key name     Description
---------    ------------
in_port      Source port
dl_src       Source MAC address
dl_dst       Destination MAC address
dl_type      Ethernet protocol type
vlan_vid     Virtual LAN tag
vlan_pcp     Priority Code Point
ip_src       Source IPv4 address
ip_dst       Destination IPv4 address
ip_proto     IPV4 - Next protocol, IPV6 - Next header
ip_dscp      IP ToS/DSCP or IPv6 traffic class field dscp
ip_ecn       ECN bits from IP header
ip_ttl       IP TTL or IPv6 hop limit
l4_src_port  Source L4 port
l4_dst_port  Destination L4 port
metadata     Matches value in the metadata field

Related Commands

Notes

show openflow table <table_id[-table_id]> match-keys supported

Displays list of ACL keys which can be configured in OpenFlow table.

Syntax Description

table_id

OpenFlow table ID for adding/removing key values. Can be one ID or range. Range: 0-249.

Default

N/A

Configuration Mode

Any command mode

History

3.6.3004

Example

switch (config) # show openflow table 2 match-keys supported
Key name     Description
---------    ------------
in_port      Source port
dl_src       Source MAC address
dl_dst       Destination MAC address
dl_type      Ethernet protocol type
vlan_vid     Virtual LAN tag
vlan_pcp     Priority Code Point
ip_src       Source IPv4 address
ip_dst       Destination IPv4 address
ipv6_dst     Destination IPv6 address
ipv6_src     Source IPv6 address
ip_proto     IPV4 - Next protocol, IPV6 - Next header
ip_dscp      IP ToS/DSCP or IPv6 traffic class field dscp
ip_ecn       ECN bits from IP header
ip_ttl       IP TTL or IPv6 hop limit
l4_src_port  Source L4 port
l4_dst_port  Destination L4 port
metadata     Matches value in the metadata field

Related Commands

Notes