ostinato.ost_pb module¶
Module Constants¶
Module Classes¶
- Ack
- BuildConfig
- CaptureBuffer
- CaptureBufferList
- DeviceGroup
- DeviceGroupConfigList
- DeviceGroupCore
- DeviceGroupId
- DeviceGroupIdList
- EncapEmulation
- Notification
- Port
- PortConfigList
- PortDeviceList
- PortId
- PortIdList
- PortNeighborList
- PortState
- PortStats
- PortStatsList
- Protocol
- ProtocolId
- Stream
- StreamConfigList
- StreamControl
- StreamCore
- StreamGuid
- StreamGuidList
- StreamId
- StreamIdList
- StreamStats
- StreamStatsList
- VariableField
- VersionCompatibility
- VersionInfo
- Void
Module constants¶
LinkState¶
ost_pb.LinkStateUnknown
ost_pb.LinkStateDown
ost_pb.LinkStateUp
NotifType¶
ost_pb.portConfigChanged
TransmitMode¶
ost_pb.kSequentialTransmit
ost_pb.kInterleavedTransmit
Ack class¶
Class constants¶
RpcStatus¶
Ack.kRpcSuccess
Ack.kRpcError
Class attributes¶
status¶
Ack.status : RpcStatus
This attribute is mandatory and should be set explicitly. See RpcStatus
notes¶
Ack.notes : str(unicode)
Optional. If not set, defaults to "".
BuildConfig class¶
Class attributes¶
port_id¶
BuildConfig.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
CaptureBuffer class¶
CaptureBuffer class has no attributes
CaptureBufferList class¶
Class attributes¶
list¶
CaptureBufferList.list : List[CaptureBuffer]
See CaptureBuffer
DeviceGroup class¶
Class attributes¶
device_group_id¶
DeviceGroup.device_group_id : DeviceGroupId
This attribute is mandatory and should be set explicitly. See DeviceGroupId
core¶
DeviceGroup.core : DeviceGroupCore
See DeviceGroupCore
encap¶
DeviceGroup.encap : EncapEmulation
See EncapEmulation
device_count¶
DeviceGroup.device_count : long
Optional. If not set, defaults to 1.
Extensions¶
DeviceGroup.Extensions : Dict
Extended attributes for this class are available via this dictionary. To access any extended attribute, use the extended attribute name as the key.
Class extended attributes¶
Following extended attributes are available -
| Name | Type | Description |
|---|---|---|
| ip4 | emul.Ip4Emulation | |
| ip6 | emul.Ip6Emulation | |
| mac | emul.MacEmulation |
DeviceGroupConfigList class¶
Class attributes¶
port_id¶
DeviceGroupConfigList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
device_group¶
DeviceGroupConfigList.device_group : List[DeviceGroup]
See DeviceGroup
DeviceGroupCore class¶
Class attributes¶
name¶
DeviceGroupCore.name : str(unicode)
Optional. If not set, defaults to "".
DeviceGroupId class¶
Class attributes¶
id¶
DeviceGroupId.id : long
This attribute is mandatory and should be set explicitly
DeviceGroupIdList class¶
Class attributes¶
port_id¶
DeviceGroupIdList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
device_group_id¶
DeviceGroupIdList.device_group_id : List[DeviceGroupId]
See DeviceGroupId
EncapEmulation class¶
EncapEmulation class has no attributes
Extensions¶
EncapEmulation.Extensions : Dict
Extended attributes for this class are available via this dictionary. To access any extended attribute, use the extended attribute name as the key.
Class extended attributes¶
Following extended attributes are available -
| Name | Type | Description |
|---|---|---|
| vlan | emul.VlanEmulation |
Notification class¶
Class attributes¶
notif_type¶
Notification.notif_type : NotifType
This attribute is mandatory and should be set explicitly. See NotifType
port_id_list¶
Notification.port_id_list : PortIdList
See PortIdList
Port class¶
Class attributes¶
port_id¶
Port.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
name¶
Port.name : str(unicode)
Optional. If not set, defaults to "".
description¶
Port.description : str(unicode)
Optional. If not set, defaults to "".
notes¶
Port.notes : str(unicode)
Optional. If not set, defaults to "".
is_enabled¶
Port.is_enabled : boolean
Optional. If not set, defaults to False.
is_exclusive_control¶
Port.is_exclusive_control : boolean
Optional. If not set, defaults to False.
transmit_mode¶
Port.transmit_mode : TransmitMode
See TransmitMode
Optional. If not set, defaults to kSequentialTransmit.
user_name¶
Port.user_name : str(unicode)
Optional. If not set, defaults to "".
is_tracking_stream_stats¶
Port.is_tracking_stream_stats : boolean
Optional. If not set, defaults to False.
speed¶
Port.speed : float
Optional. If not set, defaults to 0.
mtu¶
Port.mtu : long
Optional. If not set, defaults to 0.
user_description¶
Port.user_description : str(unicode)
Optional. If not set, defaults to "".
PortConfigList class¶
Class attributes¶
port¶
PortConfigList.port : List[Port]
See Port
PortDeviceList class¶
Class attributes¶
port_id¶
PortDeviceList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
Extensions¶
PortDeviceList.Extensions : Dict
Extended attributes for this class are available via this dictionary. To access any extended attribute, use the extended attribute name as the key.
Class extended attributes¶
Following extended attributes are available -
| Name | Type | Description |
|---|---|---|
| device | emul.Device |
PortId class¶
Class attributes¶
id¶
PortId.id : long
This attribute is mandatory and should be set explicitly
PortIdList class¶
Class attributes¶
port_id¶
PortIdList.port_id : List[PortId]
See PortId
PortNeighborList class¶
Class attributes¶
port_id¶
PortNeighborList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
Extensions¶
PortNeighborList.Extensions : Dict
Extended attributes for this class are available via this dictionary. To access any extended attribute, use the extended attribute name as the key.
Class extended attributes¶
Following extended attributes are available -
| Name | Type | Description |
|---|---|---|
| device_neighbor | emul.DeviceNeighborList |
PortState class¶
Class attributes¶
link_state¶
PortState.link_state : LinkState
See LinkState
Optional. If not set, defaults to LinkStateUnknown.
is_transmit_on¶
PortState.is_transmit_on : boolean
Optional. If not set, defaults to false.
is_capture_on¶
PortState.is_capture_on : boolean
Optional. If not set, defaults to false.
PortStats class¶
Class attributes¶
port_id¶
PortStats.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
state¶
PortStats.state : PortState
See PortState
rx_pkts¶
PortStats.rx_pkts : long
Optional. If not set, defaults to 0.
rx_bytes¶
PortStats.rx_bytes : long
Optional. If not set, defaults to 0.
rx_pkts_nic¶
PortStats.rx_pkts_nic : long
Optional. If not set, defaults to 0.
rx_bytes_nic¶
PortStats.rx_bytes_nic : long
Optional. If not set, defaults to 0.
rx_pps¶
PortStats.rx_pps : long
Optional. If not set, defaults to 0.
rx_bps¶
PortStats.rx_bps : long
Optional. If not set, defaults to 0.
tx_pkts¶
PortStats.tx_pkts : long
Optional. If not set, defaults to 0.
tx_bytes¶
PortStats.tx_bytes : long
Optional. If not set, defaults to 0.
tx_pkts_nic¶
PortStats.tx_pkts_nic : long
Optional. If not set, defaults to 0.
tx_bytes_nic¶
PortStats.tx_bytes_nic : long
Optional. If not set, defaults to 0.
tx_pps¶
PortStats.tx_pps : long
Optional. If not set, defaults to 0.
tx_bps¶
PortStats.tx_bps : long
Optional. If not set, defaults to 0.
rx_drops¶
PortStats.rx_drops : long
Optional. If not set, defaults to 0.
rx_errors¶
PortStats.rx_errors : long
Optional. If not set, defaults to 0.
rx_fifo_errors¶
PortStats.rx_fifo_errors : long
Optional. If not set, defaults to 0.
rx_frame_errors¶
PortStats.rx_frame_errors : long
Optional. If not set, defaults to 0.
PortStatsList class¶
Class attributes¶
port_stats¶
PortStatsList.port_stats : List[PortStats]
See PortStats
Protocol class¶
Class constants¶
k¶
Protocol.kMacFieldNumber
Protocol.kPayloadFieldNumber
Protocol.kSampleFieldNumber
Protocol.kUserScriptFieldNumber
Protocol.kHexDumpFieldNumber
Protocol.kSignFieldNumber
Protocol.kEth2FieldNumber
Protocol.kDot3FieldNumber
Protocol.kLlcFieldNumber
Protocol.kSnapFieldNumber
Protocol.kSvlanFieldNumber
Protocol.kVlanFieldNumber
Protocol.kDot2LlcFieldNumber
Protocol.kDot2SnapFieldNumber
Protocol.kVlanStackFieldNumber
Protocol.kStpFieldNumber
Protocol.kArpFieldNumber
Protocol.kIp4FieldNumber
Protocol.kIp6FieldNumber
Protocol.kIp6over4FieldNumber
Protocol.kIp4over6FieldNumber
Protocol.kIp4over4FieldNumber
Protocol.kIp6over6FieldNumber
Protocol.kTcpFieldNumber
Protocol.kUdpFieldNumber
Protocol.kIcmpFieldNumber
Protocol.kIgmpFieldNumber
Protocol.kMldFieldNumber
Protocol.kGreFieldNumber
Protocol.kTextProtocolFieldNumber
Class attributes¶
protocol_id¶
Protocol.protocol_id : ProtocolId
This attribute is mandatory and should be set explicitly. See ProtocolId
variable_field¶
Protocol.variable_field : List[VariableField]
See VariableField
ProtocolId class¶
Class attributes¶
id¶
ProtocolId.id : long
This attribute is mandatory and should be set explicitly
Stream class¶
Class attributes¶
stream_id¶
Stream.stream_id : StreamId
This attribute is mandatory and should be set explicitly. See StreamId
core¶
Stream.core : StreamCore
See StreamCore
control¶
Stream.control : StreamControl
See StreamControl
protocol¶
Stream.protocol : List[Protocol]
See Protocol
StreamConfigList class¶
Class attributes¶
port_id¶
StreamConfigList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
stream¶
StreamConfigList.stream : List[Stream]
See Stream
StreamControl class¶
Class constants¶
NextWhat¶
StreamControl.e_nw_stop
StreamControl.e_nw_goto_next
StreamControl.e_nw_goto_id
SendMode¶
StreamControl.e_sm_fixed
StreamControl.e_sm_continuous
SendUnit¶
StreamControl.e_su_packets
StreamControl.e_su_bursts
Class attributes¶
unit¶
StreamControl.unit : SendUnit
See SendUnit
Optional. If not set, defaults to e_su_packets.
mode¶
StreamControl.mode : SendMode
See SendMode
Optional. If not set, defaults to e_sm_fixed.
num_packets¶
StreamControl.num_packets : long
Optional. If not set, defaults to 10.
num_bursts¶
StreamControl.num_bursts : long
Optional. If not set, defaults to 1.
packets_per_burst¶
StreamControl.packets_per_burst : long
Optional. If not set, defaults to 10.
next¶
StreamControl.next : NextWhat
See NextWhat
Optional. If not set, defaults to e_nw_goto_next.
OBSOLETE_packets_per_sec¶
StreamControl.OBSOLETE_packets_per_sec : long
Optional. If not set, defaults to 1.
OBSOLETE_bursts_per_sec¶
StreamControl.OBSOLETE_bursts_per_sec : long
Optional. If not set, defaults to 1.
packets_per_sec¶
StreamControl.packets_per_sec : float
Optional. If not set, defaults to 1.
bursts_per_sec¶
StreamControl.bursts_per_sec : float
Optional. If not set, defaults to 1.
StreamCore class¶
Class constants¶
FrameLengthMode¶
StreamCore.e_fl_fixed
StreamCore.e_fl_inc
StreamCore.e_fl_dec
StreamCore.e_fl_random
StreamCore.e_fl_imix
Class attributes¶
name¶
StreamCore.name : str(unicode)
Optional. If not set, defaults to "".
is_enabled¶
StreamCore.is_enabled : boolean
Optional. If not set, defaults to False.
ordinal¶
StreamCore.ordinal : long
Optional. If not set, defaults to 0.
len_mode¶
StreamCore.len_mode : FrameLengthMode
See FrameLengthMode
Optional. If not set, defaults to e_fl_fixed.
frame_len¶
StreamCore.frame_len : long
Frame Length (includes CRC)
Optional. If not set, defaults to 64.
frame_len_min¶
StreamCore.frame_len_min : long
Optional. If not set, defaults to 64.
frame_len_max¶
StreamCore.frame_len_max : long
Optional. If not set, defaults to 1518.
StreamGuid class¶
Class attributes¶
id¶
StreamGuid.id : long
This attribute is mandatory and should be set explicitly
StreamGuidList class¶
Class attributes¶
port_id_list¶
StreamGuidList.port_id_list : PortIdList
This attribute is mandatory and should be set explicitly. See PortIdList
stream_guid¶
StreamGuidList.stream_guid : List[StreamGuid]
See StreamGuid
StreamId class¶
Class attributes¶
id¶
StreamId.id : long
This attribute is mandatory and should be set explicitly
StreamIdList class¶
Class attributes¶
port_id¶
StreamIdList.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
stream_id¶
StreamIdList.stream_id : List[StreamId]
See StreamId
StreamStats class¶
Class attributes¶
port_id¶
StreamStats.port_id : PortId
This attribute is mandatory and should be set explicitly. See PortId
stream_guid¶
StreamStats.stream_guid : StreamGuid
This attribute is mandatory and should be set explicitly. See StreamGuid
tx_duration¶
StreamStats.tx_duration : float
Optional. If not set, defaults to 0.
latency¶
StreamStats.latency : long
Optional. If not set, defaults to 0.
jitter¶
StreamStats.jitter : long
Optional. If not set, defaults to 0.
rx_pkts¶
StreamStats.rx_pkts : long
Optional. If not set, defaults to 0.
rx_bytes¶
StreamStats.rx_bytes : long
Optional. If not set, defaults to 0.
tx_pkts¶
StreamStats.tx_pkts : long
Optional. If not set, defaults to 0.
tx_bytes¶
StreamStats.tx_bytes : long
Optional. If not set, defaults to 0.
StreamStatsList class¶
Class attributes¶
stream_stats¶
StreamStatsList.stream_stats : List[StreamStats]
See StreamStats
VariableField class¶
Class constants¶
Mode¶
VariableField.kIncrement
VariableField.kDecrement
VariableField.kRandom
Type¶
VariableField.kCounter8
VariableField.kCounter16
VariableField.kCounter32
Class attributes¶
type¶
VariableField.type : Type
See Type
Optional. If not set, defaults to kCounter8.
offset¶
VariableField.offset : long
Optional. If not set, defaults to 0.
mask¶
VariableField.mask : int
Optional. If not set, defaults to 4294967295.
value¶
VariableField.value : long
Optional. If not set, defaults to 0.
mode¶
VariableField.mode : Mode
See Mode
Optional. If not set, defaults to kIncrement.
count¶
VariableField.count : long
Optional. If not set, defaults to 16.
step¶
VariableField.step : long
Optional. If not set, defaults to 1.
VersionCompatibility class¶
Class constants¶
Compatibility¶
VersionCompatibility.kIncompatible
VersionCompatibility.kCompatible
Class attributes¶
result¶
VersionCompatibility.result : Compatibility
This attribute is mandatory and should be set explicitly. See Compatibility
notes¶
VersionCompatibility.notes : str(unicode)
Optional. If not set, defaults to "".
VersionInfo class¶
Class attributes¶
version¶
VersionInfo.version : str(unicode)
This attribute is mandatory and should be set explicitly
client_name¶
VersionInfo.client_name : str(unicode)
Optional. If not set, defaults to "".
Void class¶
Void class has no attributes