OpenflowGroupActionSetConfig Object

Description:

Actions to perform for the action bucket.

Writable Attributes
Read-Only Attributes

Automatically created from: OpenflowGroupActionBucketConfig

OpenflowGroupActionSetConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

ControllerMaxLength

The length of the packet to send to the controller. Used when OutputPortActionType is set to CONTROLLER.

Type: u16

Default: 65535

DecrementTtlType

TTL type to decrement when GroupActionType is set to DECREMENT_TTL.

Type: enum

Default: DECREMENT_IP_TTL

Possible Values:

Value	Description
DECREMENT_MPLS_TTL	Decrement MPLS TTL
DECREMENT_IP_TTL	Decrement IP TTL

ExperimenterData1

Pass through the value in the experimenter field.

Type: string

Default: 00

ExperimenterData2

Pass through the value in the experimenter field.

Type: string

Default: 00

ExperimenterData3

Pass through the value in the experimenter field.

Type: string

Default: 00

ExperimenterData4

Pass through the value in the experimenter field.

Type: string

Default: 00

ExperimenterId1

Experimenter ID 1

Type: u32

Default: 0

ExperimenterId2

Experimenter ID 2

Type: u32

Default: 0

ExperimenterId3

Experimenter ID 3

Type: u32

Default: 0

ExperimenterId4

Experimenter ID 4

Type: u32

Default: 0

GroupActionType

Type of action. More then one can be used.

Type: enum

Default: OUTPUT

Possible Values:

Value	Description
COPY_TTL_INWARDS	Copy TTL inwards.
POP	Pop Tag.
PUSH_MPLS	Push MPLS.
PUSH_PBB	Push PBB.
PUSH_VLAN	Push VLAN.
COPY_TTL_OUTWARDS	Copy TTL outwards.
DECREMENT_TTL	Decrement TTL.
SET	Set fields.
QOS	QOS.
GROUP	Output group ID.
OUTPUT	Output port.
EXPERIMENTER1	Experimenter 1
EXPERIMENTER2	Experimenter 2
EXPERIMENTER3	Experimenter 3
EXPERIMENTER4	Experimenter 4

OutputGroupId

The Output Group ID to use when GroupActionType is set to Group.

Type: u32

Default: 1

OutputPortActionType

What action to take when GroupActionType is set to Output.

Type: enum

Default: PORT_NUM

Possible Values:

Value	Description
PORT_NUM	Output on port number.
ALL	Output to all standard ports except in port.
CONTROLLER	Output to controller.
TABLE	Output to the first table.
IN_PORT	Output on input port.
ANY	Output on any port.
LOCAL	Output on local Openflow port.
NORMAL	Forward using non-Openflow pipline.
FLOOD	Flood using non-Openflow pipline.

OutputPortNumber

The output port to send packet on. Used when OutputPortActionType is set to PORT_NUM.

Type: u32

Default: 1

PopMplsTagDataEthertype

Set MPLS Ethertype when PopTag is set to POP_MPLS_HEADER.

Type: u16

Default: 0x8847

PopTag

Chose which header to pop when GroupActionType is set to POP.

Type: enum

Default: POP_VLAN_HEADER

Possible Values:

Value	Description
POP_MPLS_HEADER	Pop the outer-most MPLS header.
POP_PBB_HEADER	Pop the outer-most PBB header.
POP_VLAN_HEADER	Pop the outer-most VLAN header.

PushMplsTagDataEthertype

Push a new MPLS header and set the Ethertype when GroupActionType is set to PUSH_MPLS.

Type: u16

Default: 0x8847

PushPbbTagDataEthertype

Push a new PBB header and set the Ethertype when GroupActionType is set to PUSH_PBB.

Type: u16

Default: 0x88E7

PushVlanTagDataEthertype

Push a new VLAN header and set the Ethertype when GroupActionType is set to PUSH_VLAN.

Type: u16

Default: 0x8100

SetArpDstHwAddr

ARP Destination Hardware Address to be used when SetL2Fields is set to ARP_THA

Type: mac

Default: 00-10-01-00-00-01

SetArpDstIpv4Addr

ARP Destination IPv4 Address to be used when SetL2Fields is set to ARP_TPA

Type: ip

Default: 20.0.0.1

SetArpOpcode

ARP Opcode to be used when SetL2Fields is set to ARP_OP

Type: u16

Default: 0

SetArpSrcHwAddr

ARP Source Hardware Address to be used when SetL2Fields is set to ARP_SHA

Type: mac

Default: 00-20-01-00-00-01

SetArpSrcIpv4Addr

ARP Source IPv4 Address to be used when SetL2Fields is set to ARP_SPA

Type: ip

Default: 10.0.0.1

SetEthDst

Ethernet Destination Address to be used when SetL2Fields is set to ETH_DST

Type: mac

Default: 00-10-01-00-00-01

SetEthSrc

Ethernet Source Address to be used when SetL2Fields is set to ETH_SRC

Type: mac

Default: 00-20-01-00-00-01

SetEthType

Ethernet Type to be used when SetL2Fields is set to ETH_TYPE

Type: u16

Default: 0x8100

SetExperimenterData1

Set Experimenter Data 1 (Hex)

Type: string

Default: 00

SetExperimenterData2

Set Experimenter Data 2 (Hex)

Type: string

Default: 00

SetExperimenterData3

Set Experimenter Data 3 (Hex)

Type: string

Default: 00

SetExperimenterData4

Set Experimenter Data 4 (Hex)

Type: string

Default: 00

SetExperimenterField1

Set Experimenter Field 1 (int)

Type: u8

Default: 0

Range: 0 - 127

SetExperimenterField2

Set Experimenter Field 2 (int)

Type: u8

Default: 0

Range: 0 - 127

SetExperimenterField3

Set Experimenter Field 3 (int)

Type: u8

Default: 0

Range: 0 - 127

SetExperimenterField4

Set Experimenter Field 4 (int)

Type: u8

Default: 0

Range: 0 - 127

SetExperimenterId1

Set Experimenter ID 1 (Hex)

Type: string

Default: 00

SetExperimenterId2

Set Experimenter ID 2 (Hex)

Type: string

Default: 00

SetExperimenterId3

Set Experimenter ID 3 (Hex)

Type: string

Default: 00

SetExperimenterId4

Set Experimenter ID 4 (Hex)

Type: string

Default: 00

SetIcmpv4Code

ICMPv4 Code to be used when SetIpv4Fields is set to ICMPV4_CODE

Type: u8

Default: 0

SetIcmpv4Type

ICMPv4 Type to be used when SetIpv4Fields is set to ICMPV4_TYPE

Type: u8

Default: 0

SetIcmpv6Code

ICMPv6 Code to be used when SetIpv6Fields is set to ICMPV6_CODE

Type: u8

Default: 0

SetIcmpv6Type

ICMPv6 Type to be used when SetIpv6Fields is set to ICMPV6_TYPE

Type: u8

Default: 0

SetIpDscp

IP DSCP to be used when SetIpv4Fields is set to IP_DSCP

Type: u8

Default: 0

SetIpEcn

IP ECN to be used when SetIpv4Fields is set to IP_ECN

Type: u8

Default: 0

SetIpProto

IP Proto to be used when SetIpv4Fields is set to IP_PROTO

Type: u8

Default: 6

SetIpv4Dst

IPv4 Destination to be used when SetIpv4Fields is set to IPV4_DST

Type: ip

Default: 10.0.0.2

SetIpv4Fields

Set IPv4 Fields when GroupActionType is set to SET.

Type: enum

Default: 0

Possible Values:

Value	Description
IP_DSCP	Set IP DSCP (6 bits in ToS field)
IP_ECN	Set IP ECN (2 bits in ToS field)
IP_PROTO	Set IP Protocol
IPV4_SRC	Set IPv4 Source Address
IPV4_DST	Set IPv4 Destination Address
TCP_SRC	Set TCP Source Port
TCP_DST	Set TCP Destination Port
UDP_SRC	Set UDP Source Port
UDP_DST	Set UDP Destination Port
SCTP_SRC	Set SCTP Source Port
SCTP_DST	Set SCTP Destination Port
ICMPV4_TYPE	Set ICMPv4 Type
ICMPV4_CODE	Set ICMPv4 Code

SetIpv4Src

IPv4 Source to be used when SetIpv4Fields is set to IPV4_SRC

Type: ip

Default: 10.0.0.1

SetIpv6Dst

IPv6 Destination to be used when SetIpv6Fields is set to IPV6_DST

Type: ipv6

Default: 2000::1

SetIpv6Fields

Set IPv6 Fields when GroupActionType is set to SET.

Type: enum

Default: 0

Possible Values:

Value	Description
IPV6_SRC	Set IPv6 Source Address
IPV6_DST	Set IPv6 Destination Address
IPV6_FLABEL	Set IPv6 Flow Label
ICMPV6_TYPE	Set ICMPv6 Type
ICMPV6_CODE	Set ICMPv6 Code
IPV6_ND_TARGET	Set Target Address For ND
IPV6_ND_SLL	Set Source link-layer For ND
IPV6_ND_TLL	Set Target link-layer For ND

SetIpv6Flabel

IPv6 Flow Label to be used when SetIpv6Fields is set to IPV6_FLABEL

Type: u32

Default: 0

SetIpv6NdSll

IPv6 Source Link-layer For ND to be used when SetIpv6Fields is set to IPV6_ND_SLL

Type: mac

Default: 00:00:01:00:00:01

SetIpv6NdTarget

IPv6 Target Address For ND to be used when SetIpv6Fields is set to IPV6_ND_TARGET

Type: ipv6

Default: 2000::1

SetIpv6NdTll

IPv6 Target Link-layer For ND to be used when SetIpv6Fields is set to IPV6_ND_TLL

Type: mac

Default: 00:00:01:00:00:01

SetIpv6Src

IPv6 Source to be used when SetIpv6Fields is set to IPV6_SRC

Type: ipv6

Default: 2000::10

SetL2Fields

Set L2 Fields when GroupActionType is set to SET.

Type: enum

Default: 0

Possible Values:

Value	Description
ETH_DST	Set Ethernet Destination Address.
ETH_SRC	Set Ethernet Source Address.
ETH_TYPE	Set Ethernet Type.
VLAN_VID	Set VLAN ID.
VLAN_PCP	Set VLAN priority.
ARP_OP	Set ARP Opcode
ARP_SPA	Set ARP Source IPv4 Address
ARP_TPA	Set ARP Target IPv4 Address.
ARP_SHA	Set ARP Source Hardware Address.
ARP_THA	Set ARP Target Hardware Address.
MPLS_LABEL	Set MPLS Label.
MPLS_TC	Set MPLS TC.
MPLS_BOS	Set MPLS BoC Bit.
PBB_ISID	Set PBB I-SID.
TUNNEL_ID	Set Tunnel ID
SET_EXPERIMENTER1	Set Experimenter 1
SET_EXPERIMENTER2	Set Experimenter 2
SET_EXPERIMENTER3	Set Experimenter 3
SET_EXPERIMENTER4	Set Experimenter 4

SetMplsBosBit

MPLS BOS Bit to be used when SetL2Fields is set to MPLS_BOS

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Set Bit
FALSE	UnSet Bit

SetMplsLabel

MPLS Label to be used when SetL2Fields is set to MPLS_LABEL

Type: u16

Default: 0x8100

SetMplsTc

MPLS TC to be used when SetL2Fields is set to MPLS_TC

Type: u8

Default: 0

SetPbbIsid

PBB ISID to be used when SetL2Fields is set to PBB_ISID

Type: u32

Default: 0

SetQueueId

The value to set when GroupActionType is set to QOS.

Type: u32

Default: 1

SetSctpDst

SCTP Destination Port to be used when SetIpv4Fields is set to SCTP_DST

Type: u16

Default: 100

SetSctpSrc

SCTP Source Port to be used when SetIpv4Fields is set to SCTP_SRC

Type: u16

Default: 100

SetTcpDst

TCP Destination to be used when SetIpv4Fields is set to TCP_DST

Type: u16

Default: 0000

SetTcpSrc

TCP Source to be used when SetIpv4Fields is set to TCP_SRC

Type: u16

Default: 0000

SetTunnelId

Tunnel ID to be used when SetL2Fields is set to TUNNEL_ID

Type: u64

Default: 0

SetUdpDst

UDP Destination to be used when SetIpv4Fields is set to UDP_DST

Type: u16

Default: 0000

SetUdpSrc

UDP Source to be used when SetIpv4Fields is set to UDP_SRC

Type: u16

Default: 0000

SetVlanId

VLAN ID to be used when SetL2Fields is set to VLAN_VID

Type: u16

Default: 100

SetVlanPriority

VLAN Priority to be used when SetL2Fields is set to VLAN_PCP

Type: u8

Default: 0

OpenflowGroupActionSetConfig Read-Only Attributes

There are no read-only attributes.