OseSwitchConfig Object

Description:

Configures OSE topology on the emulated device.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Automatically-created children: OseTrafficConfig

Relations:

Side name (Type)	Relative	Description
ClientLoadProfile (AffiliatedClientLoadProfile)	ClientLoadProfile	Relation to specify association with client load profile.
AffiliatedProtocolProfile (AffiliatedProtocolProfile)	OpenflowProtocolProfile, OtvProtocolProfile	Relation to specify association with 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	Connection destination association.
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).

OseSwitchConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AdditionalSwitchPortNames

Configure names for up to 3 additional port names.

Type: string

Default: add1_@b-@s-@x

BaseSwitchPortNum

Topology, Host and Additional ports are based off the Base Switch Port Number.

Type: u16

Default: 4000

Range: 1 - 50000

ConfigureAdditionalSwitchPorts

Option to configure additional switch ports with separate names.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Configure additional switch ports.
FALSE	Do not configure additional switch ports.

ConfigureHosts

Configure hosts on switches.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Configure hosts.
FALSE	Do not configure hosts.

ConnectionType

Type of connection to establish between switches and controller.

Type: enum

Default: TCP

Possible Values:

Value	Description
TCP	TCP connection between switches and controller.
TCP_TLS	TLS Connection between the switches and controller.

ControllerCaCertificates

PEM files containing the trusted Certification Authority certificate to authenticate the controller.

Type: string

Default: "" (empty string)

ControllerIpAddrList

Ipv4 address of the controller.

Type: ip

Default: 192.85.1.1

ControllerIpv6AddrList

Ipv6 address of the controller.

Type: ipv6

Default: 2000::1

Dpid

Starting Datapath Id number to be assigned to switches.

Type: u64

Default: 1

DpidIncrement

Increment of the Datapath Id number between the switches.

Type: u64

Default: 1

DynamicLoad

Dynamic load.

Type: s32

Default: 30

Range: 1 - 1000000

EdgeSwitchName

Edge Switch Name, also name of the local port to controller.

Type: string

Default: eg_@b-@s-@x

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.

HostCount

Number of hosts to configure on switch.

Type: u8

Default: 1

Range: 1 - 255

HostIpv4AddrIncr

IPv4 Address step between host ports.

Type: ip

Default: 0.0.0.1

HostIpv4AddrStart

IPv4 Address start for host ports.

Type: ip

Default: 0.0.0.1

HostMacAddrStart

MAC Address start for host ports.

Type: mac

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

HostPortName

Name of host port.

Type: string

Default: host_@b-@s-@x

LeafSwitchName

Leaf Switch Name, also name of the local port to controller.

Type: string

Default: lf_@b-@s-@x

LocalPortName

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Name for port on switch that is used for communication with controller.

Type: string

Default: br_@b-@s-@x

NumAuxChannels

Number of auxiliary channels

Type: u8

Default: 0

Range: 0 - 4

NumEdgeSwitches

Number of edge switches in topology.

Type: u16

Default: 2

Range: 0 - 65535

NumLeafSwitches

Number of leaf switches in topology.

Type: u16

Default: 4

Range: 1 - 65535

NumSpineSwitches

Number of spine switches in topology.

Type: u16

Default: 2

Range: 1 - 65535

OpenflowDefaultTableMissEntry

Select action to be taken when no flow match occurs.

Type: enum

Default: SEND_TO_CONTROLLER

Possible Values:

Value	Description
DROP	Drop the packet.
SEND_TO_CONTROLLER	Forward packet to controller.

OpenflowVersion

Version of Openflow to be supported by the switches.

Type: enum

Default: 2

Possible Values:

Value	Description
VERSION_1_0	Openflow 1.0.
VERSION_1_3	Openflow 1.3.
VERSION_1_4	Openflow 1.4

OseTopology

Type of the switch topology to create.

Type: enum

Default: LINEAR

Possible Values:

Value	Description
LINEAR	Linear topology.
RING	Ring topology.
GRID	Grid topology.
SPINE_LEAF	Spine Leaf Topology.
FULL_MESH	Full Mesh Topology.
STANDALONE	Standalone Topology. Topology with no interconnecting links.

RowCount

Number of rows in grid topology.

Type: u8

Default: 2

SendPortStatusOnConnect

Option to send the Port_Status message when switches connect to controller.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Send Port_Status message to controller.
FALSE	Do not send Port_Status message to controller.

SpineSwitchName

Spine Switch Name, also name of the local port to controller.

Type: string

Default: sp_@b-@s-@x

SwitchCertificate

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

Type: string

Default: "" (empty string)

SwitchName

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Switch name.

Type: string

Default: br_@b-@s-@x

SwitchPortMacAddrStart

MAC Address start for all switch ports.

Type: mac

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

SwitchPortMacAddrStep

MAC Address step between switch ports.

Type: mac

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

SwitchPortNamePrefix

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Name for port interconnecting switches in topology.

Type: string

Default: Port_

Range: 1 - 8 characters

SwitchPrivateKey

PEM file containing the private key file of the switch.

Type: string

Default: "" (empty string)

TcpPort

TCP port for the communication between the switches and the controller.

Type: u16

Default: 6633

TopologyPortName

Name for port interconnecting switches in topology.

Type: string

Default: topo_@b-@s-@x

TrafficEnable

Option to configure traffic on switch topology.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Configure traffic.
FALSE	Do not configure traffic.

TrafficTestType

Type of traffic test to configure.

Type: enum

Default: PACKET_IN

Possible Values:

Value	Description
PACKET_IN	Packet-in traffic.
ARP	ARP traffic test.

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.

UsePortMacAddr

Option to use same MAC address as switch port in the Port_Description message.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use same MAC address.
FALSE	No not use same MAC address.

OseSwitchConfig Read-Only Attributes

Read-Only Attribute

Description

Common Read-Only Attributes

State

BaseVirtualSwitchVersion

Version of the Virtual Switch used for the Switches.

Type: enum

Default: 0

Possible Values:

Value	Description
N_A	Switches have not been created.
OVS_2_1	OVS 2.1.0
OVS_2_5	OVS 2.5.0

LoadProfileRunState

Load profile run state.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Load profile is running.
FALSE	Load profile is stopped.

OseTrafficState

Current state of OSE Traffic.

Type: enum

Default: STOPPED

Possible Values:

Value	Description
STARTED	Traffic is running.
STOPPED	Traffic is stopped.
IN_PROGRESS	Processing Traffic Stop or Start command.