34. openflow Commands

configure
— apply-groups reference
— apply-groups-exclude reference
of-controller number
address string
admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
description string
echo-interval number
echo-multiple number
ipv6-address string
role keyword
tls-server-profile reference
version keyword
of-switch string
admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
aux-channel boolean
controller (ipv4-address-no-zone | ipv6-address-no-zone) port number
— apply-groups reference
— apply-groups-exclude reference
ofc-loopback (ipv4-address-no-zone | ipv6-address-no-zone)
service-name string
tls-client-profile reference
description string
echo-interval number
echo-multiple number
flowtable number
— apply-groups reference
— apply-groups-exclude reference
max-size number
mismatch-action keyword
logical-port-status keyword
ofs-id number

34.1. openflow Command Descriptions

openflow

Synopsis

Enter the openflow context

Tree
Introduced

16.0.R4

Platforms

All

of-controller [controller-id] number

Synopsis

Enter the of-controller list instance

Max. Elements

1

Introduced

16.0.R4

Platforms

VSR-NRC

[controller-id] number

Synopsis

OpenFlow controller ID

Default

1

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

VSR-NRC

address string

Warning:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

Synopsis

Local IPv4 address for the OpenFlow controller

Context
Tree
Introduced

16.0.R4

Platforms

VSR-NRC

admin-state keyword

Synopsis

Administrative state of an OpenFlow controller instance.

Default

disable

Options

enable, disable

Introduced

16.0.R4

Platforms

VSR-NRC

description string

Synopsis

Text description

String Length

1 to 80

Introduced

16.0.R4

Platforms

VSR-NRC

echo-interval number

Synopsis

Time interval between two consecutive OpenFlow echo request transmissions for a given OpenFlow session.

Range

10 to 3600

Default

10

Units

seconds

Introduced

16.0.R4

Platforms

VSR-NRC

echo-multiple number

Synopsis

Multiplier for OpenFlow control channel echo packets. The OpenFlow control channel is considered operationally down if no reply is heard from the switch after the specified multiplier.

Range

3 to 100

Default

3

Introduced

16.0.R4

Platforms

VSR-NRC

ipv6-address string

Synopsis

Local IPv6 address for OpenFlow controller to be used for packets on both main and aux channels. The OpenFlow controller must be shutdown to change its address.

Introduced

19.10.R1

Platforms

VSR-NRC

role keyword

Synopsis

The role that the controller will request to OpenFlow switches when multiple controllers are connected to a switch.

Context
Tree
Default

equal

Options

equal

Introduced

16.0.R4

Platforms

VSR-NRC

tls-server-profile reference

Warning:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

Synopsis

Specifies the profile name used by the controller.

Introduced

16.0.R4

Platforms

VSR-NRC

version keyword

Synopsis

OpenFlow version negotiated between an OpenFlow controller and the switch.

Context
Tree
Default

version-1-3-1

Options

version-1-3-1

Introduced

16.0.R4

Platforms

VSR-NRC

of-switch [name] string

Synopsis

Enter the of-switch list instance

Context
Tree
Max. Elements

8

Introduced

16.0.R4

Platforms

All

[name] string

Synopsis

The name of this OpenFlow switch.

Context
String Length

1 to 32

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

admin-state keyword

Synopsis

Administrative state of an OpenFlow switch instance.

Context
Default

disable

Options

enable, disable

Introduced

16.0.R4

Platforms

All

aux-channel boolean

Synopsis

The operational status of the auxiliary channel established between an OpenFlow controller and switch.

Context
Default

false

Introduced

16.0.R4

Platforms

All

controller [address] (ipv4-address-no-zone | ipv6-address-no-zone) port number

Synopsis

Enter the controller list instance

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number

Max. Elements

2

Introduced

16.0.R4

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)

Synopsis

IP address of the OpenFlow channel to the controller

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

port number

Synopsis

Controller port.

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number

Range

1 to 65535

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

ofc-loopback (ipv4-address-no-zone | ipv6-address-no-zone)

Synopsis

The controller loop back IPv4 address.

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number ofc-loopback (ipv4-address-no-zone | ipv6-address-no-zone)

Introduced

16.0.R4

Platforms

All

service-name string

Synopsis

Administrative service name

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number service-name string

String Length

1 to 64

Introduced

16.0.R4

Platforms

All

tls-client-profile reference

Synopsis

Specifies the profile name used by the controller.

Context

configure openflow of-switch string controller (ipv4-address-no-zone | ipv6-address-no-zone) port number tls-client-profile reference

Introduced

16.0.R4

Platforms

All

description string

Synopsis

Text description

Context
String Length

1 to 255

Introduced

16.0.R4

Platforms

All

echo-interval number

Synopsis

Time interval between two consecutive OpenFlow echo request transmissions for a given OpenFlow session.

Range

1 to 3600

Default

10

Units

seconds

Introduced

16.0.R4

Platforms

All

echo-multiple number

Synopsis

Multiplier for OpenFlow control channel echo packets. The OpenFlow control channel is considered operationally down if no reply is heard from the switch after the specified multiplier.

Range

3 to 100

Default

3

Introduced

16.0.R4

Platforms

All

flowtable [table-id] number

Synopsis

Enter the flowtable list instance

Context
Tree
Max. Elements

1

Introduced

16.0.R4

Platforms

All

[table-id] number

Synopsis

OpenFlow table ID.

Context
Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

max-size number

Synopsis

Maximum number of entries that the flowtable can have. The maximum size cannot be changed if any entries are present in the flowtable.

Context
Tree
Range

1 to 524288

Default

1000

Introduced

16.0.R4

Platforms

All

mismatch-action keyword

Synopsis

Action taken when no match entries found in flow table

Context
Default

fall-through

Options

drop, fall-through, packet-in

Introduced

16.0.R4

Platforms

All

switch-defined-cookie boolean

Synopsis

Enable switch-defined cookie encoding

Default

false

Introduced

16.0.R4

Platforms

All

logical-port-status keyword

Synopsis

Logical port type for status change reporting

Options

rsvp-te, mpls-tp, sr-te

Max. Elements

3

Introduced

16.0.R4

Platforms

All

ofs-id number

Warning:

Modifying this element recreates the parent element automatically for the new value to take effect.

Synopsis

Unique identifier of an OpenFlow switch instance.

Context
Tree
Range

1 to 8

Introduced

16.0.R6

Platforms

All