OpenflowFlowBlock Object


Description:

Openflow controller defined flow block.

Parents: OpenflowControllerProtocolConfig, OpenflowFlowGenParams

Children: ExtendedTableModifier, OpenflowFlowBoundTrafficAction, RandomModifier, RangeModifier, TableModifier

Automatically-created children: OpenflowSwitchTransportConfig

Relations:

Side name
(Type)
Relative Description
OpenflowSwitch
(AffiliatedOpenflowSwitch)

OpenflowSwitchConfig

Affiliated Openflow controller switch configuration.

StreamBlock
(OpenflowTraffic)

StreamBlock

Openflow controller stream blocks for flow block.

OpenflowFlowBlock Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AllowInvalidHeaders

Allow invalid headers.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Allow invalid headers.

FALSE

Doesn't allow invalid headers.

CmdType

Defines FlowMod command message types allowed for this flow block. If a flow contains both add and delete command types the flow will be added and deleted when applicable on apply changes. Flow blocks defined only for modify or delete commands will only be used when does a OpenflowModifyFlowsOnSwitchCommand or OpenflowRemoveFlowsFromSwitchCommand.

Type: enum

Default: ADD|DELETE

Possible Values:

Value Description
ADD

Flow block will be used to send FlowMod add messages.

MODIFY

Flow block will be used to send FlowMod modify messages.

DELETE

Flow block will be used to send FlowMod delete messages.

Cookie

Cookie value to match.

Type: u64

Default: 0

CookieMask

Cookie mask value to match.

Type: u64

Default: 0

Flags

Flag value to match.

Type: u16

Default: 0x0001

FlowBlockType

Flow block type.

Type: enum

Default: 0

Possible Values:

Value Description
BOUND

Flow block defined by bound traffic.

FLOW_TABLE_TEXT

Flow block defined by flow table text.

CUSTOM

Flow block defined by PDU XML.

FlowTableText

Flow table text where each flow is defined by a line of text.

Type: string

Default: "" (empty string)

FrameConfig

Custom flow configuration XML.

Type: string

Default: <frame><config><pdus><pdu name=\"eth1\" pdu=\"ethernet:EthernetII\" /><pdu name=\"ip_1\" pdu=\"ipv4:IPv4\" /></pdus></config></frame>

HardTimeout

Flow hard timeout.

Type: u16

Default: 0

IdleTimeout

Flow idle timeout.

Type: u16

Default: 0

MatchFields

List of match fields.

Type: enum

Default: ETH_DST_MAC

Possible Values:

Value Description
INGRESS_PORT

In port.

ETH_SRC_MAC

Ethernet source MAC.

ETH_DST_MAC

Ethernet destination MAC.

ETH_TYPE

Ethernet type.

VLAN_ID

VLAN ID.

VLAN_PRIORITY

VLAN priority.

IPV4_SRC_ADDR

IPv4 source address.

IPV4_DST_ADDR

IPv4 destination address.

IPV4_TOS

IPv4 TOS.

IPV4_PROTOCOL

IPv4 protocol.

TCP_UDP_SRC_PORT

TCP/UDP source port.

TCP_UDP_DST_PORT

TCP/UDP destination port.

IPV6_SRC_ADDR

IPv6 source address.

IPV6_DST_ADDR

IPv6 destination address.

IPV6_FLOW_LABEL

IPv6 flow label.

IPV6_PROTOCOL

IPv6 next header protocol.

IPV6_TRAFFIC_CLASS

IPv6 traffic class.

Priority

Flow priority.

Type: u16

Default: 32768

StrictMatch

Send FlowMod modify and delete messages strict.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Send FlowMod modify and delete messages strict.

FALSE

Send FlowMod modify and delete messages non-strict.

OpenflowFlowBlock Read-Only Attributes

Read-Only Attribute Description
FlowCount

Returned flow count is not supported.

Type: u32

Default: 1

PduInfo

PDU Information

Type: string

Default: "" (empty string)