OpenflowControllerProtocolConfig Object


Description:

Openflow controller emulation protocol configuration.

Parents: EmulatedDevice

Children: OpenflowExperimenterMessageConfig, OpenflowFlowBlock, OpenflowGroupEntryConfig, OpenflowMeterConfig, OpenflowReactiveModeRuleConfig, OpenflowSwitchConfig

Automatically-created children: OpenflowSetAsyncMessageConfig

Result children (automatically created): OpenflowAsyncConfigResults, OpenflowControllerResults, OpenflowControllerSwitchPortResults, OpenflowControllerSwitchResults, OpenflowReactiveModeAggregateResults

Relations:

Side name
(Type)
Relative Description
ClientLoadProfile
(AffiliatedClientLoadProfile)

ClientLoadProfile

Relation to the affiliated client load profile.

AffiliatedProtocolProfile
(AffiliatedProtocolProfile)

OpenflowProtocolProfile, OtvProtocolProfile

Relation to the affiliated protocol profile.

ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

Result of the MPLS control plane binding.

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary protocol path.

ProtocolConnectionDestination
(ProtocolConnectionDestination)

AutosarTimeSyncConfig, CoapServerConfig, EcpriProtocolConfig, Ieee80211AccessPointConfig, Ieee80211ClientConfig, MacsecSupplicantBlockConfig, OamFlexeClientConfig, OpenflowControllerProtocolConfig, OpflexDeviceConfig, OseSwitchConfig, OtvEdgeDeviceConfig, OtvSiteDeviceConfig, OvsdbServerConfig, TrillRbridgeConfig, VdpStationConfig, VsiBlockConfig, VxlanVtepConfig

Protocol connection destination.

ResultChild
(ResultChild)

OpenflowAsyncConfigResults, OpenflowControllerResults, OpenflowControllerSwitchPortResults, OpenflowControllerSwitchResults, OpenflowReactiveModeAggregateResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

OpenflowControllerProtocolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AddDefaultDiscoveryFlows

Add default flows for discovery.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

When discovery is started and this option is set, a default flow to forward LLDP packets to the controller will be added to every switch. These flows will be removed when discovery is stopped.

FALSE

No flows will be added when discovery is stopped or started. Discovery will still work on switches that default to forward unknown packets to the controller.

AddFlowsOnConnect

Whether the flows will be automatically added when the Openflow Controller is started and the switches have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Flows will be sent when the Openflow Controller is started and switches have connected.

FALSE

Flows will not be sent when the Openflow Controller is started.

AddGroupEntriesOnConnect

Whether the group entries will be automatically added when the Openflow Controller is started and the switches have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Group entries will be sent when the Openflow Controller is started and switches have connected.

FALSE

Group entries will not be sent when the Openflow Controller is started and switches have connected.

AddMetersOnConnect

Whether the meters will be automatically added when the Openflow Controller is started and the switches have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Meters will be sent when the Openflow Controller is started and switches have connected.

FALSE

Meters will not be sent when the Openflow Controller is started and switches have connected.

BarrierFlowCount

Number of flows after which the Controller will send Barrier Request.

Type: u64

Default: 100

BarrierRequestTimeout

Barrier Request timeout in milliseconds.

Type: u32

Default: 10000

Range: 250 - 6000000

ClearExistingFlowsOnConnect

Whether the flows will be cleared automatically when the Openflow Controller is started and the switches are have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Flows will be cleared when the Openflow Controller is started and switches have connected.

FALSE

Flows will not be cleared when the Openflow Controller is started.

ClearExistingGroupEntriesOnConnect

Whether the group entries will be cleared automatically when the Openflow Controller is started and the switches are have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Group entries will be cleared when the Openflow Controller is started and switches have connected.

FALSE

Group entries will not be cleared when the Openflow Controller is started.

ClearExistingMetersOnConnect

Whether the meters will be cleared automatically when the Openflow Controller is started and the switches are have connected.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Meters will be cleared when the Openflow Controller is started and switches have connected.

FALSE

Meters will not be cleared when the Openflow Controller is started.

ConnectionType

Controller connection type.

Type: enum

Default: PASSIVE_TCP

Possible Values:

Value Description
PASSIVE_TCP

Passive TCP connection.

PASSIVE_TCP_TLS

Passive TCP TLS connection.

ControllerCertificate

PEM file containing the public key certificate file of the controller.

Type: string

Default: "" (empty string)

ControllerPrivateKey

PEM file containing the private key file of the controller.

Type: string

Default: "" (empty string)

DefaultFlowCookie

Default Value for Flow Cookie.

Type: u64

Default: 0

DefaultFlowPriority

Default value for Flow Priority.

Type: u16

Default: 32768

DesiredGenerationId

Value of the generation id field in the Role Request message.

Type: u64

Default: 0

Range: 0 - 18446744073709551615

DesiredRole

Desired role of the controller for all the switches that connect to it.

Type: enum

Default: EQUAL

Possible Values:

Value Description
NOCHANGE

Do not change current role.

EQUAL

Equal

MASTER

Master

SLAVE

Slave

DiscoveryDstMacAddr

MAC address that will be used in discovery.

Type: mac

Default: 01:80:c2:00:00:0e

DiscoveryMsgTxInterval

Discovery message transmit interval in seconds.

Type: u16

Default: 30

Range: 5 - 32768

DiscoveryRequestNumber

Discovery request number.

Type: u32

Default: 3

Range: 1 - 4294967295

DynamicLoad

Dynamic load.

Type: s32

Default: 30

Range: 1 - 1000000

EnableBarrierFlowUpdate

Whether the Openflow Controller will send out a barrier request after adding flows to the switch.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Openflow Controller will send out a barrier request after adding flows to the switch.

FALSE

Openflow Controller will not send out a barrier request after adding flows to the switch.

EnableDiscovery

Enable Discovery of the Topology.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Discovery is enabled.

FALSE

Discovery is disabled.

EnableReactiveMode

Enable reactive mode.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Reactive mode is enabled.

FALSE

Reactive mode is disabled.

EndpointConnectionPattern

Endpoint connection pattern.

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Pairwise connection.

BACKBONE_SRC_FIRST

Backbone source first connection.

BACKBONE_DST_FIRST

Backbone destination first connection.

BACKBONE_INTERLEAVED

Backbone interleaved connection.

MaxFlowRate

Maximim flow message rate limit in flows per second.

Type: double

Default: 0.0

Range: 0.0 - 65535.0

OpenflowVersion

Version of Openflow wire-format used for messages.

Type: enum

Default: VERSION_1_0

Possible Values:

Value Description
VERSION_1_0

Openflow Version 1.0

VERSION_1_3

Openflow Version 1.3

SendBarrierPerFlowCount

Whether the Openflow Controller will send out a barrier request after specified flow count.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

The Openflow Controller will send out a barrier request after specified flow count.

FALSE

The Openflow Controller will not send out a barrier request after specified flow count.

SendRoleRequestOnConnect

Whether the Openflow Controller will send the Desired Role of the controller when a switch connects to this controller.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

The desired role of the controller will be sent when a switch connects to this controller.

FALSE

The desired role of the controller will not be sent when a switch connects to this controller.

SendSetAsyncOnConnect

Send Set Async Message On Connect.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Set async message sent on connect.

FALSE

Set async message not sent on connect.

SwitchCaCertificates

PEM files containing the trusted Certification Authority’s certificate to authenticate the switches.

Type: string

Default: "" (empty string)

TcpPort

Connection TCP port to listen on.

Type: u16

Default: 6633

UsePartialBlockState

Use partial block state (unsupported).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.

FALSE

Do not use partial block state.

OpenflowControllerProtocolConfig Read-Only Attributes

Read-Only Attribute Description
ControllerState

Openflow controller state.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

None

STARTED

Started

DiscoveryState

State of the Discovery Process

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

None.

RUNNING

Discovery is in process.

COMPLETED

Discovery has been completed.

STOPPED

Discovery process has been stopped.

LoadProfileRunState

Load profile run state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Load profile is running.

FALSE

Load profile is stopped.

SwitchConfigConnectState

State of the connected switches.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No switches are connected.

PARTIAL

Switches are partially connected.

CONNECTED

Switches are connected.

SwitchUpdateState

State of the Openflow Controller updating the flows on the switch.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

Openflow Controller has not updated the switch with any flow changes.

UPDATING

Openflow Controller is in the process of updating the switch.

COMPLETED

Openflow Controller is finished updating the switch.