Advanced properties of bus-related objects¶
CAN¶
- class CanFrame¶
- canID¶
The CAN ID of the Frame
- Type:
int
- flags : CanFlags¶
Any of the frame’s flags defined in the corresponding flags class can be accessed directly on the frame object, i.e. theFrame.aFlag instead of theFrame.flags.aFlag
Some of the flags can take the value False if the driver does not support the respective attribute.
- Type:
- length¶
The frame’s length in Bytes
- Type:
int
- payload¶
The frame’s payload
- Type:
ByteStream
- timestamp¶
The frame’s timestamp in ms
- Type:
float
- class CanFlags¶
- isError¶
Is this an error frame?
- Type:
bool
- isRemote¶
Is this an remote frame?
- Type:
bool
- isExtended¶
Is this an extended-(29-Bit-)ID-frame?
- Type:
bool
- isSelfReceived¶
Was this frame sent by the controller that received it?
- Type:
bool
- isTx¶
Was this frame sent by the controller that received it? (alias for isSelfReceived)
- Type:
bool
- isEDL¶
Does this frame has an extended data length?
- Type:
bool
- isBRS¶
Was this frame received by using bit rate switching?
- Type:
bool
FlexRay¶
- class FlexRayFrame¶
- slotID¶
The slot ID of the Frame
- Type:
int
- cycleNumber¶
The cycle number of the Frame
- Type:
int
- headerCRC¶
The header CRC of the Frame
- Type:
int
- channelID¶
The ID of the FlexRay channel on which this frame was received
- Type:
int
- flags¶
Any of the frame’s flags defined in the corresponding flags class can be accessed directly on the frame object, i.e. theFrame.aFlag instead of theFrame.flags.aFlag
Some of the flags can take the value False if the driver does not support the respective attribute.
- Type:
- payload¶
The frame’s payload
- Type:
ByteStream
- timestamp¶
The frame’s timestamp in ms
- Type:
float
- class FlexRayFlags¶
- isSelfReceived¶
Was this frame sent by the controller that received it?
- Type:
bool
- isTx¶
Was this frame sent by the controller that received it? (alias for isSelfReceived)
- Type:
bool
- isNull¶
Is this a null frame?
- Type:
bool
- isValid¶
Is this frame valid?
- Type:
bool
- isSync¶
Is this a sync frame?
- Type:
bool
- isStartup¶
Is this a startup frame?
- Type:
bool
- hasPayloadPreamble¶
Does this frame have a payload preamble?
- Type:
bool
- isError¶
Is this an error frame?
- Type:
bool
- isAsync¶
Was this frame received in asynchronous mode?
- Type:
bool
- isDynamic¶
Is this a dynamic frame?
- Type:
bool
LIN¶
- class LinFrame¶
- linID¶
The LIN ID of the Frame
- Type:
int
- crc¶
The CRC of the Frame
- Type:
int
- flags¶
Any of the frame’s flags defined in the corresponding flags class can be accessed directly on the frame object, i.e. theFrame.aFlag instead of theFrame.flags.aFlag
Some of the flags can take the value False if the driver does not support the respective attribute.
- Type:
- payload¶
The frame’s payload
- Type:
ByteStream
- timestamp¶
The frame’s timestamp in ms
- Type:
float
- class LinFlags¶
- isCrcError¶
Does this frame have a CRC error?
- Type:
bool
- isSelfReceived¶
Was this frame sent by the controller that received it?
- Type:
bool
- isTx¶
Was this frame sent by the controller that received it? (alias for isSelfReceived)
- Type:
bool
Ethernet¶
- class Ethernet¶
Access to various Ethernet related packet types and constants
-
UDP =
17¶
-
TCP =
6¶
- PacketEthernet¶
- PacketIcmp¶
- PacketPtpSync¶
- PacketPtpFollowUp¶
- PacketPdelayReq¶
- PacketPdelayResp¶
- PacketPdelayRespFollowUp¶
- PacketSomeIp¶
- PacketSomeIpSd¶
- PacketSomeIpSdEntry¶
- PacketSomeIpSdEntryService¶
- PacketSomeIpSdEntryEventgroup¶
- PacketSomeIpSdOptionIpv4¶
- PacketSomeIpSdOption¶
- PacketSomeIpSdOptionIpv6¶
- PacketSomeIpSdOptionIpv4Multicast¶
- PacketSomeIpSdOptionIpv6Multicast¶
- PacketSomeIpSdOptionIpv4SD¶
- PacketSomeIpSdOptionIpv6SD¶
- PacketSomeIpSdOptionConfig¶
-
UDP =
PacketEthernet¶
- class PacketEthernet¶
In the test case, use
api.Ethernet.PacketEthernet; in UserPyModules, usefrom tts.lib.ethernet.PacketEthernet import PacketEthernet.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- ethType¶
ethernet protocol type
- Type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- ethPayload¶
Ethernet payload
- Type:
bytes
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
PacketIp4¶
- class PacketIp4¶
In the test case, use
api.Ethernet.PacPacketIp4; in UserPyModules, usefrom tts.lib.ethernet.PacketIp4 import PacketIp4.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetIpVersionAndHeaderLength()¶
- Returns:
protocol version and header length
- Return type:
int
- SetIpVersionAndHeaderLength(versionHeader)¶
- Parameters:
- versionHeader : int¶
protocol version and header length
- ipVersionHeader¶
protocol version and header length
- Type:
int
- GetIpTos()¶
- Returns:
type of service
- Return type:
int
- ipTos¶
type of service
- Type:
int
- GetIpLen()¶
- Returns:
packet length
- Return type:
int
- ipLen¶
packet length
- Type:
int
- GetIpIdent()¶
- Returns:
identifier
- Return type:
int
- ipIdent¶
identifier
- Type:
int
- GetIpOffset()¶
- Returns:
flags and offset combined
- Return type:
int
- ipOffset¶
flags and offset combined
- Type:
int
- GetIpTtl()¶
- Returns:
TTL
- Return type:
int
- ipTtl¶
TTL
- Type:
int
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- ipProt¶
protocol type / next header field
- Type:
int
- GetIpChecksum()¶
- Returns:
checksum
- Return type:
int
- ipChecksum¶
checksum
- Type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 127.0.0.1
- Return type:
str
- ipSrc¶
source IP address e.g. 127.0.0.1
- Type:
str
- GetIpDst()¶
- Returns:
target IP address e.g. 127.0.0.1
- Return type:
str
- ipDst¶
target IP address e.g. 127.0.0.1
- Type:
str
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- ipPayload¶
IP payload
- Type:
bytes
- GetIpAhSpi()¶
- Returns:
Security parameters index of IP authentication header (see RFC 4302)
- Return type:
int
- ipAhSpi¶
Security parameters index of IP authentication header (see RFC 4302)
- Type:
int
- GetIpAhSeq()¶
- Returns:
Sequence number field of IP authentication header (see RFC 4302)
- Return type:
int
- ipAhSeq¶
Sequence number field of IP authentication header (see RFC 4302)
- Type:
int
- GetIpAhIcv()¶
- Returns:
Integrity check value of IP authentication header (see RFC 4302)
- Return type:
bytes
- ipAhIcv¶
Integrity check value of IP authentication header (see RFC 4302)
- Type:
bytes
- GetIpAhNxt()¶
- Returns:
Next header value of IP authentication header (see RFC 4302)
- Return type:
int
- ipAhNxt¶
Next header value of IP authentication header (see RFC 4302)
- Type:
int
- GetIpAhLen()¶
- Returns:
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Return type:
int
- ipAhLen¶
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Type:
int
- GetIpAhRsvd()¶
- Returns:
Reserved value of IP authentication header (see RFC 4302)
- Return type:
int
- ipAhRsvd¶
Reserved value of IP authentication header (see RFC 4302)
- Type:
int
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketIp6¶
- class PacketIp6¶
In the test case, use
api.Ethernet.PacketIp6; in UserPyModules, usefrom tts.lib.ethernet.PacketIp6 import PacketIp6.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- ipProt¶
protocol type / next header field
- Type:
int
- GetIpHopLimit()¶
- Returns:
hop limit field
- Return type:
int
- ipHopLimit¶
hop limit field
- Type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 2001:db8::1428:57ab
- Return type:
str
- ipSrc¶
source IP address e.g. 2001:db8::1428:57ab
- Type:
str
- GetIpDst()¶
- Returns:
target IP address e.g. 2001:db8::1428:57ab
- Return type:
str
- ipDst¶
target IP address e.g. 2001:db8::1428:57ab
- Type:
str
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- ipPayload¶
IP payload
- Type:
bytes
- GetIpLen()¶
- Returns:
payload length from IPv6 header
- Return type:
int
- ipLen¶
payload length from IPv6 header
- Type:
int
- GetIpTrafficClass()¶
- Returns:
traffic class from IPv6 header
- Return type:
int
- ipTrafficClass¶
traffic class from IPv6 header
- Type:
int
- GetIpFlowLabel()¶
- Returns:
flow label from IPv6 header
- Return type:
int
- ipFlowLabel¶
flow label from IPv6 header
- Type:
int
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketIcmp¶
- class PacketIcmp¶
In the test case, use
api.Ethernet.PacketIcmp; in UserPyModules, usefrom tts.lib.ethernet.PacketIcmp import PacketIcmp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetIcmpType()¶
- Returns:
ICMP type
- Return type:
int
- icmpType¶
ICMP type
- Type:
int
- GetIcmpCode()¶
- Returns:
ICMP code
- Return type:
int
- icmpCode¶
ICMP code
- Type:
int
- GetIcmpChecksum()¶
- Returns:
checksum
- Return type:
int
- icmpChecksum¶
checksum
- Type:
int
- GetIcmpPayload()¶
- Returns:
ICMP payload
- Return type:
bytes
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetIpAhIcv()¶
- Returns:
Integrity check value of IP authentication header (see RFC 4302)
- Return type:
bytes
- GetIpAhLen()¶
- Returns:
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Return type:
int
- GetIpAhNxt()¶
- Returns:
Next header value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhRsvd()¶
- Returns:
Reserved value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSeq()¶
- Returns:
Sequence number field of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSpi()¶
- Returns:
Security parameters index of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetIpDst()¶
- Returns:
target IP address e.g. 127.0.0.1
- Return type:
str
- GetIpIdent()¶
- Returns:
identifier
- Return type:
int
- GetIpLen()¶
- Returns:
packet length
- Return type:
int
- GetIpOffset()¶
- Returns:
flags and offset combined
- Return type:
int
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 127.0.0.1
- Return type:
str
- GetIpTos()¶
- Returns:
type of service
- Return type:
int
- GetIpTtl()¶
- Returns:
TTL
- Return type:
int
- GetIpVersionAndHeaderLength()¶
- Returns:
protocol version and header length
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- PK_CLASS¶
alias of
IP
- SetIpVersionAndHeaderLength(versionHeader)¶
- Parameters:
- versionHeader : int¶
protocol version and header length
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- ipAhIcv¶
Integrity check value of IP authentication header (see RFC 4302)
- Type:
bytes
- ipAhLen¶
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Type:
int
- ipAhNxt¶
Next header value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhRsvd¶
Reserved value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSeq¶
Sequence number field of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSpi¶
Security parameters index of IP authentication header (see RFC 4302)
- Type:
int
- ipChecksum¶
checksum
- Type:
int
- ipDst¶
target IP address e.g. 127.0.0.1
- Type:
str
- ipIdent¶
identifier
- Type:
int
- ipLen¶
packet length
- Type:
int
- ipOffset¶
flags and offset combined
- Type:
int
- ipPayload¶
IP payload
- Type:
bytes
- ipProt¶
protocol type / next header field
- Type:
int
- ipSrc¶
source IP address e.g. 127.0.0.1
- Type:
str
- ipTos¶
type of service
- Type:
int
- ipTtl¶
TTL
- Type:
int
- ipVersionHeader¶
protocol version and header length
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
- icmpPayload¶
ICMP payload
- Type:
bytes
PacketMka¶
- class PacketMka¶
In the test case, use
api.Ethernet.PacketMka; in UserPyModules, usefrom tts.lib.ethernet.PacketMka import PacketMka.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- UseCak(cak)¶
Use a specific Connectivity Association Key. Needed for example to unwrap the Security Association Key or to validate the MKPDU’s Integrity Check Value.
- GetEthDstMac()¶
- Returns:
destination MAC address e.g. DE:AD:BE:EF:42:05
- Return type:
str
- ethDstMac¶
destination MAC address e.g. DE:AD:BE:EF:42:05
- Type:
str
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:42:05
- Return type:
str
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:42:05
- Type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetMkaIcv()¶
- Returns:
Integrity Check Value of this MKPDU. See IEEE 802.1X-2020, section 9.4.1.
- Return type:
- mkaIcv¶
Integrity Check Value of this MKPDU. See IEEE 802.1X-2020, section 9.4.1.
- Type:
- IsMkaIcvValid()¶
- Returns:
True if the Integrity Check Value of this PacketMka is valid, False otherwise.
- Return type:
bool
- GetKeyServerPriority()¶
- Returns:
Key Server Priority (0..255) from Basic Parameter Set. See IEEE 802.1X-2020, section 9.5 and table 11-7.
- Return type:
int
- keyServerPriority¶
Key Server Priority (0..255) from Basic Parameter Set. See IEEE 802.1X-2020, section 9.5 and table 11-7.
- Type:
int
- GetKeyServerFlag()¶
- Returns:
Key Server Flag from Basic Parameter Set. See IEEE 802.1X-2020, section 9.5.1 and table 11-7.
- Return type:
bool
- keyServerFlag¶
Key Server Flag from Basic Parameter Set. See IEEE 802.1X-2020, section 9.5.1 and table 11-7.
- Type:
bool
- GetMacSecDesired()¶
- Returns:
MACsec Desired from Basic Parameter Set. See IEEE 802.1X-2020, section 9.6.1 and table 11-7.
- Return type:
bool
- macSecDesired¶
MACsec Desired from Basic Parameter Set. See IEEE 802.1X-2020, section 9.6.1 and table 11-7.
- Type:
bool
- GetMacSecCapability()¶
- Returns:
MACsec Capability from Basic Parameter Set. See IEEE 802.1X-2020, section 9.6.1 and table 11-7.
- Return type:
MacSecCapability
- macSecCapability¶
MACsec Capability from Basic Parameter Set. See IEEE 802.1X-2020, section 9.6.1 and table 11-7.
- Type:
MacSecCapability
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7 and IEEE 802.1AE.
- Return type:
- macSecSci¶
Secure Channel Identifier from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7 and IEEE 802.1AE.
- Type:
- GetMemberIdentifier()¶
- Returns:
Member Identifier from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7.
- Return type:
- memberIdentifier¶
Member Identifier from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7.
- Type:
- GetMessageNumber()¶
- Returns:
Message Number from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7.
- Return type:
int
- messageNumber¶
Message Number from Basic Parameter Set. See IEEE 802.1X-2020, table 11-7.
- Type:
int
- GetCakName()¶
- Returns:
Connectivity Association Key Name from Basic Parameter Set. See IEEE 802.1X-2020, section 9.3.1 and table 11-7.
- Return type:
- cakName¶
Connectivity Association Key Name from Basic Parameter Set. See IEEE 802.1X-2020, section 9.3.1 and table 11-7.
- Type:
- GetLivePeerListMemberIdentifiers()¶
- Returns:
List of Member Identifiers from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Return type:
list[ByteStream] | None
- livePeerListMemberIdentifiers¶
List of Member Identifiers from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Type:
Optional[list[ByteStream]]
- GetLivePeerListMessageNumbers()¶
- Returns:
List of Message Numbers (one for each Member Identifier) from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Return type:
list[int] | None
- livePeerListMessageNumbers¶
List of Message Numbers (one for each Member Identifier) from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Type:
Optional[list[int]]
- GetLivePeerListKeyServerSsci()¶
- Returns:
Elected Key Server’s Short Secure Channel Identifier from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Return type:
int | None
- livePeerListKeyServerSsci¶
Elected Key Server’s Short Secure Channel Identifier from Live Peer List Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Type:
Optional[int]
- RemoveLivePeerList()¶
If the MKPDU has a Live Peer List Parameter Set, remove it.
- GetPotentialPeerListMemberIdentifiers()¶
- Returns:
List of Member Identifiers from Potential Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Return type:
list[ByteStream] | None
- potentialPeerListMemberIdentifiers¶
List of Member Identifiers from Potential Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Type:
Optional[list[ByteStream]]
- GetPotentialPeerListMessageNumbers()¶
- Returns:
List of Message Numbers (one for each Member Identifier) from Potential Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Return type:
list[int] | None
- potentialPeerListMessageNumbers¶
List of Message Numbers (one for each Member Identifier) from Potential Peer List Parameter Set. See IEEE 802.1X-2020, section 9.4.3 and table 11-7.
- Type:
Optional[list[int]]
- RemovePotentialPeerList()¶
If the MKPDU has a Potential Peer List Parameter Set, remove it.
- GetSakUseLatestAn()¶
- Returns:
Latest Key Association Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Return type:
int | None
- sakUseLatestAn¶
Latest Key Association Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Type:
Optional[int]
- GetSakUseLatestTx()¶
- Returns:
Latest Key Tx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Return type:
bool | None
- sakUseLatestTx¶
Latest Key Tx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Type:
Optional[bool]
- GetSakUseLatestRx()¶
- Returns:
Latest Key Rx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Return type:
bool | None
- sakUseLatestRx¶
Latest Key Rx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10 and table 11-7.
- Type:
Optional[bool]
- GetSakUsePlainTx()¶
- Returns:
Plain Tx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, table 11-7 and figure 11-10.
- Return type:
bool | None
- sakUsePlainTx¶
Plain Tx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, table 11-7 and figure 11-10.
- Type:
Optional[bool]
- GetSakUsePlainRx()¶
- Returns:
Plain Rx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, table 11-7 and figure 11-10.
- Return type:
bool | None
- sakUsePlainRx¶
Plain Rx Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, table 11-7 and figure 11-10.
- Type:
Optional[bool]
- GetSakUseDelayProtect()¶
- Returns:
Delay Protect Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Return type:
bool | None
- sakUseDelayProtect¶
Delay Protect Flag from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Type:
Optional[bool]
- GetSakUseLatestKeyServerMemberIdentifier()¶
- Returns:
Latest Key Server Member Identifier from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Return type:
ByteStream | None
- sakUseLatestKeyServerMemberIdentifier¶
Latest Key Server Member Identifier from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Type:
Optional[ByteStream]
- GetSakUseLatestKeyNumber()¶
- Returns:
Latest Key Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Return type:
int | None
- sakUseLatestKeyNumber¶
Latest Key Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Type:
Optional[int]
- GetSakUseLatestLpn()¶
- Returns:
Latest Key Lowest Acceptable Packet Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Return type:
int | None
- sakUseLatestLpn¶
Latest Key Lowest Acceptable Packet Number from MACsec SAK Use Parameter Set. See IEEE 802.1X-2020, section 9.10.1 and table 11-7.
- Type:
Optional[int]
- RemoveSakUse()¶
If the MKPDU has a MACsec SAK Use Parameter Set, remove it.
- GetDistributedSakWrappedKey()¶
- Returns:
AES Key Wrap of Security Association Key from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.8 and table 11-7.
- Return type:
ByteStream | None
- distributedSakWrappedKey¶
AES Key Wrap of Security Association Key from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.8 and table 11-7.
- Type:
Optional[ByteStream]
- GetDistributedSakUnwrappedKey()¶
- Returns:
Security Association Key, unwrapped using the Connectivity Association Key which was set by PacketMka.UseCak().
- Return type:
ByteStream | None
- distributedSakUnwrappedKey¶
Security Association Key, unwrapped using the Connectivity Association Key which was set by PacketMka.UseCak().
- Type:
Optional[ByteStream]
- GetDistributedSakAn()¶
- Returns:
Association Number from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.9 and table 11-7.
- Return type:
int | None
- distributedSakAn¶
Association Number from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.9 and table 11-7.
- Type:
Optional[int]
- GetDistributedSakConfidentialityOffset()¶
- Returns:
Confidentiality Offset from Distributed SAK Parameter Set. 0 = no confidentiality, 1 = no offset, 2 = offset 30 bytes, 3 = offset 50 bytes. See IEEE 802.1X-2020, section 9.6.1, table 11-6 and table 11-7.
- Return type:
int | None
- distributedSakConfidentialityOffset¶
Confidentiality Offset from Distributed SAK Parameter Set. 0 = no confidentiality, 1 = no offset, 2 = offset 30 bytes, 3 = offset 50 bytes. See IEEE 802.1X-2020, section 9.6.1, table 11-6 and table 11-7.
- Type:
Optional[int]
- GetDistributedSakKeyNumber()¶
- Returns:
Key Number from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.8 and table 11-7.
- Return type:
int | None
- distributedSakKeyNumber¶
Key Number from Distributed SAK Parameter Set. See IEEE 802.1X-2020, section 9.8 and table 11-7.
- Type:
Optional[int]
- GetDistributedSakCipherSuite()¶
- Returns:
MACsec Cipher Suite from Distributed SAK Parameter Set. Values from IEEE 802.1AE-2018, table 14-1. See IEEE 802.1X-2020, section 9.7 and table 11-7.
- Return type:
ByteStream | None
- distributedSakCipherSuite¶
MACsec Cipher Suite from Distributed SAK Parameter Set. Values from IEEE 802.1AE-2018, table 14-1. See IEEE 802.1X-2020, section 9.7 and table 11-7.
- Type:
Optional[ByteStream]
- SetDistributedSakToNoMacSec()¶
Change the values of the Distributed SAK Parameter Set so MACsec will not be used. See IEEE 802.1X-2020, figure 11-11, footnotes a and b.
- RemoveDistributedSak()¶
If the MKPDU has a Distributed SAK Parameter Set, remove it.
- GetXpnLatestLpn()¶
- Returns:
Latest Key Lowest Acceptable Packet Number (most significant 32 bits) from XPN Parameter Set. See IEEE 802.1X-2020, section 9.18 and table 11-7.
- Return type:
int | None
- xpnLatestLpn¶
Latest Key Lowest Acceptable Packet Number (most significant 32 bits) from XPN Parameter Set. See IEEE 802.1X-2020, section 9.18 and table 11-7.
- Type:
Optional[int]
- RemoveXpn()¶
If the MKPDU has an XPN Parameter Set, remove it.
- GetAnnouncementTypes()¶
- Returns:
TLV types from Announcement Parameter Set. See IEEE 802.1X-2020, section 9.7 and table 11-8.
- Return type:
list[int] | None
- announcementTypes¶
TLV types from Announcement Parameter Set. See IEEE 802.1X-2020, section 9.7 and table 11-8.
- Type:
Optional[list[int]]
- GetAnnouncementInfos()¶
- Returns:
TLV infos (without length bits) from Announcement Parameter Set. See IEEE 802.1X-2020, section 9.7 and figure 11-19.
- Return type:
list[ByteStream] | None
- announcementInfos¶
TLV infos (without length bits) from Announcement Parameter Set. See IEEE 802.1X-2020, section 9.7 and figure 11-19.
- Type:
Optional[list[ByteStream]]
- GetAnnouncementCipherSuiteCapabilities()¶
- Returns:
Implementation capabilities for the MACsec Cipher Suites from Announcement Parameter Set. See IEEE 802.1X-2020, sections 9.7 and 11.12.3 and figure 11-22.
- Return type:
list[MacSecCapability] | None
- announcementCipherSuiteCapabilities¶
Implementation capabilities for the MACsec Cipher Suites from Announcement Parameter Set. See IEEE 802.1X-2020, sections 9.7 and 11.12.3 and figure 11-22.
- Type:
Optional[list[MacSecCapability]]
- GetAnnouncementCipherSuiteNames()¶
- Returns:
Names of the supported Cipher Suites from Announcement Parameter Set, e.g. [‘GCM-AES-XPN-256’]. See IEEE 802.1X-2020, sections 9.7 and 11.12.3 and figure
- Return type:
list[str] | None
- announcementCipherSuiteNames¶
Names of the supported Cipher Suites from Announcement Parameter Set, e.g. [‘GCM-AES-XPN-256’]. See IEEE 802.1X-2020, sections 9.7 and 11.12.3 and figure
- Type:
Optional[list[str]]
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- RemoveAnnouncement()¶
If the MKPDU has an Announcement Parameter Set, remove it.
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketIke¶
- class PacketIke¶
In the test case, use
api.Ethernet.PacketIke; in UserPyModules, usefrom tts.lib.ethernet.PacketIke import PacketIke.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetInitiatorSpi()¶
- Returns:
Security Parameter Index chosen by the initiator
- Return type:
- initiatorSpi¶
Security Parameter Index chosen by the initiator
- Type:
- GetResponderSpi()¶
- Returns:
Security Parameter Index chosen by the responder
- Return type:
- responderSpi¶
Security Parameter Index chosen by the responder
- Type:
- GetNextPayload()¶
- Returns:
type of next payload from IKE header
- Return type:
int
- nextPayload¶
type of next payload from IKE header
- Type:
int
- GetMajorVersion()¶
- Returns:
major protocol version of IKE header
- Return type:
int
- majorVersion¶
major protocol version of IKE header
- Type:
int
- GetMinorVersion()¶
- Returns:
minor protocol version of IKE header
- Return type:
int
- minorVersion¶
minor protocol version of IKE header
- Type:
int
- GetExchangeType()¶
- Returns:
exchange type of IKE header
- Return type:
int
- exchangeType¶
exchange type of IKE header
- Type:
int
- GetFlags()¶
- Returns:
flags of IKE header
- Return type:
int
- flags¶
flags of IKE header
- Type:
int
- IsInitiator()¶
- Returns:
whether the initiator bit of IKE header flags is set
- Return type:
bool
- IsResponder()¶
- Returns:
whether the initiator bit of IKE header flags is cleared
- Return type:
bool
- SetToInitiator()¶
Sets the initiator bit of IKE header flags
- SetToResponder()¶
Clears the initiator bit of IKE header flags
- IsRequest()¶
- Returns:
whether the response bit of IKE header flags is cleared
- Return type:
bool
- IsResponse()¶
- Returns:
whether the response bit of IKE header flags is set
- Return type:
bool
- SetToRequest()¶
Clears the response bit of IKE header flags
- SetToReponse()¶
Sets the response bit of IKE header flags
- GetMessageId()¶
- Returns:
message id of IKE header
- Return type:
int
- messageId¶
message id of IKE header
- Type:
int
- GetLength()¶
- Returns:
length from IKE header, i.e. total message length including header and payloads)
- Return type:
int
- length¶
length from IKE header, i.e. total message length including header and payloads)
- Type:
int
- GetKeyExchangeNextPayload()¶
- Returns:
type of next payload from KE payload, or None if there is no KE payload
- Return type:
int | None
- keyExchangeNextPayload¶
type of next payload from KE payload, or None if there is no KE payload
- Type:
Optional[int]
- IsKeyExchangeCritical()¶
- Returns:
critical flag of KE payload, or None if there is no KE payload
- Return type:
bool | None
- keyExchangeCritical¶
critical flag of KE payload, or None if there is no KE payload
- Type:
Optional[bool]
- GetKeyExchangeLength()¶
- Returns:
length of KE payload, or None if there is no KE payload
- Return type:
int | None
- keyExchangeLength¶
length of KE payload, or None if there is no KE payload
- Type:
Optional[int]
- GetKeyExchangeDhGroupNumber()¶
- Returns:
Diffie-Hellman group number of KE payload, or None if there is no KE payload
- Return type:
int | None
- keyExchangeDhGroupNumber¶
Diffie-Hellman group number of KE payload, or None if there is no KE payload
- Type:
Optional[int]
- GetKeyExchangeData()¶
- Returns:
key exchange data from KE payload, or None if there is no KE payload
- Return type:
ByteStream | None
- keyExchangeData¶
key exchange data from KE payload, or None if there is no KE payload
- Type:
Optional[ByteStream]
- GetNonceNextPayload()¶
- Returns:
type of next payload from nonce payload, or None if there is no nonce payload
- Return type:
int | None
- nonceNextPayload¶
type of next payload from nonce payload, or None if there is no nonce payload
- Type:
Optional[int]
- IsNonceCritical()¶
- Returns:
critical flag of nonce payload, or None if there is no nonce payload
- Return type:
bool | None
- nonceCritical¶
critical flag of nonce payload, or None if there is no nonce payload
- Type:
Optional[bool]
- GetNonceLength()¶
- Returns:
length of nonce payload, or None if there is no nonce payload
- Return type:
int | None
- nonceLength¶
length of nonce payload, or None if there is no nonce payload
- Type:
Optional[int]
- GetNonceData()¶
- Returns:
nonce data, or None if there is no nonce payload
- Return type:
ByteStream | None
- nonceData¶
nonce data, or None if there is no nonce payload
- Type:
Optional[ByteStream]
- GetCertificateNextPayload()¶
- Returns:
type of next payload from CERT payload, or None if there is no CERT payload
- Return type:
int | None
- certificateNextPayload¶
type of next payload from CERT payload, or None if there is no CERT payload
- Type:
Optional[int]
- IsCertificateCritical()¶
- Returns:
critical flag of CERT payload, or None if there is no CERT payload
- Return type:
bool | None
- certificateCritical¶
critical flag of CERT payload, or None if there is no CERT payload
- Type:
Optional[bool]
- GetCertificateLength()¶
- Returns:
length of CERT payload, or None if there is no CERT payload
- Return type:
int | None
- certificateLength¶
length of CERT payload, or None if there is no CERT payload
- Type:
Optional[int]
- GetCertificateEncoding()¶
- Returns:
certificate encoding of CERT payload, or None if there is no CERT payload
- Return type:
int | None
- certificateEncoding¶
certificate encoding of CERT payload, or None if there is no CERT payload
- Type:
Optional[int]
- GetCertificateData()¶
- Returns:
certificate data of CERT payload, or None if there is no CERT payload
- Return type:
ByteStream | None
- certificateData¶
certificate data of CERT payload, or None if there is no CERT payload
- Type:
Optional[ByteStream]
- GetCertificateRequestNextPayload()¶
- Returns:
type of next payload from CERTREQ payload, or None if there is no CERTREQ payload
- Return type:
int | None
- certificateRequestNextPayload¶
type of next payload from CERTREQ payload, or None if there is no CERTREQ payload
- Type:
Optional[int]
- GetCertificateRequestCritical()¶
- Returns:
critical flag of CERTREQ payload, or None if there is no CERTREQ payload
- Return type:
bool | None
- certificateRequestCritical¶
critical flag of CERTREQ payload, or None if there is no CERTREQ payload
- Type:
Optional[bool]
- GetCertificateRequestLength()¶
- Returns:
length of CERTREQ payload, or None if there is no CERTREQ payload
- Return type:
int | None
- certificateRequestLength¶
length of CERTREQ payload, or None if there is no CERTREQ payload
- Type:
Optional[int]
- GetCertificateRequestData()¶
- Returns:
concatenated certificate authorities’ public key SHA-1 hashes of CERTREQ payload, or None if there is no CERTREQ payload
- Return type:
ByteStream | None
- certificateRequestData¶
concatenated certificate authorities’ public key SHA-1 hashes of CERTREQ payload, or None if there is no CERTREQ payload
- Type:
Optional[ByteStream]
- GetCertificateRequestEncoding()¶
- Returns:
certificate encoding of CERTREQ payload, or None if there is no CERTREQ payload
- Return type:
int | None
- certificateRequestEncoding¶
certificate encoding of CERTREQ payload, or None if there is no CERTREQ payload
- Type:
Optional[int]
- GetIdentInitiatorNextPayload()¶
- Returns:
type of next payload from IDi payload, or None if there is no IDi payload
- Return type:
int | None
- identInitiatorNextPayload¶
type of next payload from IDi payload, or None if there is no IDi payload
- Type:
Optional[int]
- GetIdentInitiatorCritical()¶
- Returns:
critical flag of IDi payload, or None if there is no IDi payload
- Return type:
bool | None
- identInitiatorCritical¶
critical flag of IDi payload, or None if there is no IDi payload
- Type:
Optional[bool]
- GetIdentInitiatorLength()¶
- Returns:
length of IDi payload, or None if there is no IDi payload
- Return type:
int | None
- identInitiatorLength¶
length of IDi payload, or None if there is no IDi payload
- Type:
Optional[int]
- GetIdentInitiatorIdType()¶
- Returns:
identification type of IDi payload, or None if there is no IDi payload
- Return type:
int | None
- identInitiatorIdType¶
identification type of IDi payload, or None if there is no IDi payload
- Type:
Optional[int]
- GetIdentInitiatorData()¶
- Returns:
identification data of IDi payload, or None if there is no IDi payload
- Return type:
ByteStream | None
- identInitiatorData¶
identification data of IDi payload, or None if there is no IDi payload
- Type:
Optional[ByteStream]
- GetIdentResponderNextPayload()¶
- Returns:
type of next payload from IDr payload, or None if there is no IDr payload
- Return type:
int | None
- identResponderNextPayload¶
type of next payload from IDr payload, or None if there is no IDr payload
- Type:
Optional[int]
- GetIdentResponderCritical()¶
- Returns:
critical flag of IDr payload, or None if there is no IDr payload
- Return type:
bool | None
- identResponderCritical¶
critical flag of IDr payload, or None if there is no IDr payload
- Type:
Optional[bool]
- GetIdentResponderLength()¶
- Returns:
length of IDr payload, or None if there is no IDr payload
- Return type:
int | None
- identResponderLength¶
length of IDr payload, or None if there is no IDr payload
- Type:
Optional[int]
- GetIdentResponderIdType()¶
- Returns:
identification type of IDr payload, or None if there is no IDr payload
- Return type:
int | None
- identResponderIdType¶
identification type of IDr payload, or None if there is no IDr payload
- Type:
Optional[int]
- GetIdentResponderData()¶
- Returns:
identification data of IDr payload, or None if there is no IDr payload
- Return type:
ByteStream | None
- identResponderData¶
identification data of IDr payload, or None if there is no IDr payload
- Type:
Optional[ByteStream]
- GetAuthNextPayload()¶
- Returns:
type of next payload from AUTH payload, or None if there is no AUTH payload
- Return type:
int | None
- authNextPayload¶
type of next payload from AUTH payload, or None if there is no AUTH payload
- Type:
Optional[int]
- GetAuthCritical()¶
- Returns:
critical flag of AUTH payload, or None if there is no AUTH payload
- Return type:
bool | None
- authCritical¶
critical flag of AUTH payload, or None if there is no AUTH payload
- Type:
Optional[bool]
- GetAuthLength()¶
- Returns:
length of AUTH payload, or None if there is no AUTH payload
- Return type:
int | None
- authLength¶
length of AUTH payload, or None if there is no AUTH payload
- Type:
Optional[int]
- GetAuthMethod()¶
- Returns:
authentication method of AUTH payload, or None if there is no AUTH payload
- Return type:
int | None
- authMethod¶
authentication method of AUTH payload, or None if there is no AUTH payload
- Type:
Optional[int]
- GetAuthData()¶
- Returns:
authentication data of AUTH payload, or None if there is no AUTH payload
- Return type:
ByteStream | None
- authData¶
authentication data of AUTH payload, or None if there is no AUTH payload
- Type:
Optional[ByteStream]
- GetTsInitiatorNextPayload()¶
- Returns:
type of next payload from TSi payload, or None if there is no TSi payload
- Return type:
int | None
- tsInitiatorNextPayload¶
type of next payload from TSi payload, or None if there is no TSi payload
- Type:
Optional[int]
- GetTsInitiatorCritical()¶
- Returns:
critical flag of TSi payload, or None if there is no TSi payload
- Return type:
bool | None
- tsInitiatorCritical¶
critical flag of TSi payload, or None if there is no TSi payload
- Type:
Optional[bool]
- GetTsInitiatorLength()¶
- Returns:
length of TSi payload, or None if there is no TSi payload
- Return type:
int | None
- tsInitiatorLength¶
length of TSi payload, or None if there is no TSi payload
- Type:
Optional[int]
- GetTsInitiatorNumOfTss()¶
- Returns:
number of traffic selectors of TSi payload, or None if there is no TSi payload
- Return type:
int | None
- tsInitiatorNumOfTss¶
number of traffic selectors of TSi payload, or None if there is no TSi payload
- Type:
Optional[int]
- GetTsInitiatorTrafficSelectors()¶
- Returns:
traffic selector data of TSi payload, or None if there is no TSi payload
- Return type:
- tsInitiatorTrafficSelectors¶
traffic selector data of TSi payload, or None if there is no TSi payload
- Type:
- GetTsResponderNextPayload()¶
- Returns:
type of next payload from TSr payload, or None if there is no TSr payload
- Return type:
int | None
- tsResponderNextPayload¶
type of next payload from TSr payload, or None if there is no TSr payload
- Type:
Optional[int]
- GetTsResponderCritical()¶
- Returns:
critical flag of TSr payload, or None if there is no TSr payload
- Return type:
bool | None
- tsResponderCritical¶
critical flag of TSr payload, or None if there is no TSr payload
- Type:
Optional[bool]
- GetTsResponderLength()¶
- Returns:
length of TSr payload, or None if there is no TSr payload
- Return type:
int | None
- tsResponderLength¶
length of TSr payload, or None if there is no TSr payload
- Type:
Optional[int]
- GetTsResponderNumOfTss()¶
- Returns:
number of traffic selectors of TSr payload, or None if there is no TSr payload
- Return type:
int | None
- tsResponderNumOfTss¶
number of traffic selectors of TSr payload, or None if there is no TSr payload
- Type:
Optional[int]
- GetTsResponderTrafficSelectors()¶
- Returns:
traffic selector data of TSr payload, or None if there is no TSr payload
- Return type:
- tsResponderTrafficSelectors¶
traffic selector data of TSr payload, or None if there is no TSr payload
- Type:
- GetSaNextPayload()¶
- Returns:
type of next payload from SA payload, or None if there is no SA payload
- Return type:
int | None
- saNextPayload¶
type of next payload from SA payload, or None if there is no SA payload
- Type:
Optional[int]
- GetSaCritical()¶
- Returns:
critical flag of SA payload, or None if there is no SA payload
- Return type:
bool | None
- saCritical¶
critical flag of SA payload, or None if there is no SA payload
- Type:
Optional[bool]
- GetSaLength()¶
- Returns:
length of SA payload, or None if there is no SA payload
- Return type:
int | None
- saLength¶
length of SA payload, or None if there is no SA payload
- Type:
Optional[int]
- GetSaProposals()¶
- Returns:
proposal data SA payload, or None if there is no SA payload
- Return type:
ByteStream | None
- saProposals¶
proposal data SA payload, or None if there is no SA payload
- Type:
Optional[ByteStream]
- GetNotifyNumOfPayloads()¶
- Returns:
number of Notify payloads in this IKEv2 packet
- Return type:
int
- notifyNumOfPayloads¶
number of Notify payloads in this IKEv2 packet
- Type:
int
-
GetNotifyNextPayload(notifyIdx=
-1)¶ - Returns:
type of next payload from Notify payload, or None if there is no Notify payload
- Return type:
int | None
- notifyNextPayload¶
type of next payload from Notify payload, or None if there is no Notify payload
- Type:
Optional[int]
-
GetNotifyCritical(notifyIdx=
-1)¶ - Returns:
critical flag of Notify payload, or None if there is no Notify payload
- Return type:
bool | None
- notifyCritical¶
critical flag of Notify payload, or None if there is no Notify payload
- Type:
Optional[bool]
-
GetNotifyLength(notifyIdx=
-1)¶ - Returns:
length of Notify payload, or None if there is no Notify payload
- Return type:
int | None
- notifyLength¶
length of Notify payload, or None if there is no Notify payload
- Type:
Optional[int]
-
GetNotifyProtocolId(notifyIdx=
-1)¶ - Returns:
protocol id of Notify payload, or None if there is no Notify payload
- Return type:
int | None
- notifyProtocolId¶
protocol id of Notify payload, or None if there is no Notify payload
- Type:
Optional[int]
-
GetNotifySpiSize(notifyIdx=
-1)¶ - Returns:
SPI size of Notify payload, or None if there is no Notify payload
- Return type:
int | None
- notifySpiSize¶
SPI size of Notify payload, or None if there is no Notify payload
- Type:
Optional[int]
-
GetNotifyMessageType(notifyIdx=
-1)¶ - Returns:
notify message type of Notify payload, or None if there is no Notify payload
- Return type:
int | None
- notifyMessageType¶
notify message type of Notify payload, or None if there is no Notify payload
- Type:
Optional[int]
-
GetNotifySpi(notifyIdx=
-1)¶ - Returns:
SPI of Notify payload, or None if there is no Notify payload
- Return type:
ByteStream | None
- notifySpi¶
SPI of Notify payload, or None if there is no Notify payload
- Type:
Optional[ByteStream]
-
GetNotifyData(notifyIdx=
-1)¶ - Returns:
notification data of Notify payload, or None if there is no Notify payload
- Return type:
ByteStream | None
- notifyData¶
notification data of Notify payload, or None if there is no Notify payload
- Type:
Optional[ByteStream]
- GetDeleteNextPayload()¶
- Returns:
type of next payload from Delete payload, or None if there is no Delete payload
- Return type:
int | None
- deleteNextPayload¶
type of next payload from Delete payload, or None if there is no Delete payload
- Type:
Optional[int]
- GetDeleteCritical()¶
- Returns:
critical flag of Delete payload, or None if there is no Delete payload
- Return type:
bool | None
- deleteCritical¶
critical flag of Delete payload, or None if there is no Delete payload
- Type:
Optional[bool]
- GetDeleteLength()¶
- Returns:
length of Delete payload, or None if there is no Delete payload
- Return type:
int | None
- deleteLength¶
length of Delete payload, or None if there is no Delete payload
- Type:
Optional[int]
- GetDeleteProtocolId()¶
- Returns:
protocol id of Delete payload, or None if there is no Delete payload
- Return type:
int | None
- deleteProtocolId¶
protocol id of Delete payload, or None if there is no Delete payload
- Type:
Optional[int]
- GetDeleteSpiSize()¶
- Returns:
SPI size of Delete payload, or None if there is no Delete payload
- Return type:
int | None
- deleteSpiSize¶
SPI size of Delete payload, or None if there is no Delete payload
- Type:
Optional[int]
- GetDeleteSpis()¶
- Returns:
SPI list of Delete payload, or None if there is no Delete payload
- Return type:
list[int] | None
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- CalcUdpLen()¶
Calculate and set the current length of this segment
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetIpAhIcv()¶
- Returns:
Integrity check value of IP authentication header (see RFC 4302)
- Return type:
bytes
- GetIpAhLen()¶
- Returns:
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Return type:
int
- GetIpAhNxt()¶
- Returns:
Next header value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhRsvd()¶
- Returns:
Reserved value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSeq()¶
- Returns:
Sequence number field of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSpi()¶
- Returns:
Security parameters index of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetIpDst()¶
- Returns:
target IP address e.g. 127.0.0.1
- Return type:
str
- GetIpIdent()¶
- Returns:
identifier
- Return type:
int
- GetIpLen()¶
- Returns:
packet length
- Return type:
int
- GetIpOffset()¶
- Returns:
flags and offset combined
- Return type:
int
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 127.0.0.1
- Return type:
str
- GetIpTos()¶
- Returns:
type of service
- Return type:
int
- GetIpTtl()¶
- Returns:
TTL
- Return type:
int
- GetIpVersionAndHeaderLength()¶
- Returns:
protocol version and header length
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetUdpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetUdpDst()¶
- Returns:
destination port
- Return type:
int
- GetUdpLen()¶
- Returns:
length of the UDP segment
- Return type:
int
- GetUdpPayload()¶
- Returns:
UDP payload
- Return type:
bytes
- GetUdpSrc()¶
- Returns:
source port
- Return type:
int
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- PK_CLASS¶
alias of
IP
- SetIpVersionAndHeaderLength(versionHeader)¶
- Parameters:
- versionHeader : int¶
protocol version and header length
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- ipAhIcv¶
Integrity check value of IP authentication header (see RFC 4302)
- Type:
bytes
- ipAhLen¶
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Type:
int
- ipAhNxt¶
Next header value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhRsvd¶
Reserved value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSeq¶
Sequence number field of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSpi¶
Security parameters index of IP authentication header (see RFC 4302)
- Type:
int
- ipChecksum¶
checksum
- Type:
int
- ipDst¶
target IP address e.g. 127.0.0.1
- Type:
str
- ipIdent¶
identifier
- Type:
int
- ipLen¶
packet length
- Type:
int
- ipOffset¶
flags and offset combined
- Type:
int
- ipPayload¶
IP payload
- Type:
bytes
- ipProt¶
protocol type / next header field
- Type:
int
- ipSrc¶
source IP address e.g. 127.0.0.1
- Type:
str
- ipTos¶
type of service
- Type:
int
- ipTtl¶
TTL
- Type:
int
- ipVersionHeader¶
protocol version and header length
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- udpChecksum¶
checksum
- Type:
int
- udpDst¶
destination port
- Type:
int
- udpLen¶
length of the UDP segment
- Type:
int
- udpPayload¶
UDP payload
- Type:
bytes
- udpSrc¶
source port
- Type:
int
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
- deleteSpis¶
SPI list of Delete payload, or None if there is no Delete payload
- Type:
Optional[list[int]]
- GetDeleteNumOfSpis()¶
- Returns:
Number of SPIs in the Delete payload, or None if there is no Delete payload
- Return type:
int | None
- deleteNumOfSpis¶
Number of SPIs in the Delete payload, or None if there is no Delete payload
- Type:
Optional[int]
PacketTcp¶
- class PacketTcp¶
In the test case, use
api.Ethernet.PacketTcp; in UserPyModules, usefrom tts.lib.ethernet.PacketTcp import PacketTcp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetTcpLen()¶
- Returns:
length of the whole TCP segment including header length
- Return type:
int
- GetTcpSrc()¶
- Returns:
source port
- Return type:
int
- tcpSrc¶
source port
- Type:
int
- GetTcpDst()¶
- Returns:
destination port
- Return type:
int
- tcpDst¶
destination port
- Type:
int
- GetTcpSeq()¶
- Returns:
sequence number
- Return type:
int
- tcpSeq¶
sequence number
- Type:
int
- GetTcpAck()¶
- Returns:
Ack number
- Return type:
int
- tcpAck¶
Ack number
- Type:
int
- GetTcpOffset()¶
- Returns:
TCP offset
- Return type:
int
- tcpOffset¶
TCP offset
- Type:
int
- GetTcpFlags()¶
- Returns:
flags
- Return type:
int
- tcpFlags¶
flags
- Type:
int
- GetTcpWindow()¶
- Returns:
window
- Return type:
int
- tcpWindow¶
window
- Type:
int
- GetTcpChecksum()¶
- Returns:
checksum
- Return type:
int
- tcpChecksum¶
checksum
- Type:
int
- GetTcpUrgent()¶
- Returns:
urgent pointer
- Return type:
int
- tcpUrgent¶
urgent pointer
- Type:
int
- GetTcpPayload()¶
- Returns:
TCP payload
- Return type:
bytes
- tcpPayload¶
TCP payload
- Type:
bytes
- GetTcpOptions()¶
- Returns:
the option list - a list with tuples (option, data)
- Return type:
list[tuple]
- tcpOptions¶
the option list - a list with tuples (option, data)
- Type:
list[tuple]
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetIpAhIcv()¶
- Returns:
Integrity check value of IP authentication header (see RFC 4302)
- Return type:
bytes
- GetIpAhLen()¶
- Returns:
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Return type:
int
- GetIpAhNxt()¶
- Returns:
Next header value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhRsvd()¶
- Returns:
Reserved value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSeq()¶
- Returns:
Sequence number field of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSpi()¶
- Returns:
Security parameters index of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetIpDst()¶
- Returns:
target IP address e.g. 127.0.0.1
- Return type:
str
- GetIpIdent()¶
- Returns:
identifier
- Return type:
int
- GetIpLen()¶
- Returns:
packet length
- Return type:
int
- GetIpOffset()¶
- Returns:
flags and offset combined
- Return type:
int
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 127.0.0.1
- Return type:
str
- GetIpTos()¶
- Returns:
type of service
- Return type:
int
- GetIpTtl()¶
- Returns:
TTL
- Return type:
int
- GetIpVersionAndHeaderLength()¶
- Returns:
protocol version and header length
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- PK_CLASS¶
alias of
IP
- SetIpVersionAndHeaderLength(versionHeader)¶
- Parameters:
- versionHeader : int¶
protocol version and header length
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- ipAhIcv¶
Integrity check value of IP authentication header (see RFC 4302)
- Type:
bytes
- ipAhLen¶
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Type:
int
- ipAhNxt¶
Next header value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhRsvd¶
Reserved value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSeq¶
Sequence number field of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSpi¶
Security parameters index of IP authentication header (see RFC 4302)
- Type:
int
- ipChecksum¶
checksum
- Type:
int
- ipDst¶
target IP address e.g. 127.0.0.1
- Type:
str
- ipIdent¶
identifier
- Type:
int
- ipLen¶
packet length
- Type:
int
- ipOffset¶
flags and offset combined
- Type:
int
- ipPayload¶
IP payload
- Type:
bytes
- ipProt¶
protocol type / next header field
- Type:
int
- ipSrc¶
source IP address e.g. 127.0.0.1
- Type:
str
- ipTos¶
type of service
- Type:
int
- ipTtl¶
TTL
- Type:
int
- ipVersionHeader¶
protocol version and header length
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketUdp¶
- class PacketUdp¶
In the test case, use
api.Ethernet.PacketUdp; in UserPyModules, usefrom tts.lib.ethernet.PacketUdp import PacketUdp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- CalcIpLen()¶
Calculate and set the current length of this IP packet
- CalcUdpLen()¶
Calculate and set the current length of this segment
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetIpAhIcv()¶
- Returns:
Integrity check value of IP authentication header (see RFC 4302)
- Return type:
bytes
- GetIpAhLen()¶
- Returns:
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Return type:
int
- GetIpAhNxt()¶
- Returns:
Next header value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhRsvd()¶
- Returns:
Reserved value of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSeq()¶
- Returns:
Sequence number field of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpAhSpi()¶
- Returns:
Security parameters index of IP authentication header (see RFC 4302)
- Return type:
int
- GetIpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetIpDst()¶
- Returns:
target IP address e.g. 127.0.0.1
- Return type:
str
- GetIpIdent()¶
- Returns:
identifier
- Return type:
int
- GetIpLen()¶
- Returns:
packet length
- Return type:
int
- GetIpOffset()¶
- Returns:
flags and offset combined
- Return type:
int
- GetIpPayload()¶
- Returns:
IP payload
- Return type:
bytes
- GetIpProt()¶
- Returns:
protocol type / next header field
- Return type:
int
- GetIpSrc()¶
- Returns:
source IP address e.g. 127.0.0.1
- Return type:
str
- GetIpTos()¶
- Returns:
type of service
- Return type:
int
- GetIpTtl()¶
- Returns:
TTL
- Return type:
int
- GetIpVersionAndHeaderLength()¶
- Returns:
protocol version and header length
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetUdpChecksum()¶
- Returns:
checksum
- Return type:
int
- GetUdpDst()¶
- Returns:
destination port
- Return type:
int
- GetUdpLen()¶
- Returns:
length of the UDP segment
- Return type:
int
- GetUdpPayload()¶
- Returns:
UDP payload
- Return type:
bytes
- GetUdpSrc()¶
- Returns:
source port
- Return type:
int
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- PK_CLASS¶
alias of
IP
- SetIpVersionAndHeaderLength(versionHeader)¶
- Parameters:
- versionHeader : int¶
protocol version and header length
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- ipAhIcv¶
Integrity check value of IP authentication header (see RFC 4302)
- Type:
bytes
- ipAhLen¶
Length value of IP authentication header (see RFC 4302) => len(ICV)/4+1
- Type:
int
- ipAhNxt¶
Next header value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhRsvd¶
Reserved value of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSeq¶
Sequence number field of IP authentication header (see RFC 4302)
- Type:
int
- ipAhSpi¶
Security parameters index of IP authentication header (see RFC 4302)
- Type:
int
- ipChecksum¶
checksum
- Type:
int
- ipDst¶
target IP address e.g. 127.0.0.1
- Type:
str
- ipIdent¶
identifier
- Type:
int
- ipLen¶
packet length
- Type:
int
- ipOffset¶
flags and offset combined
- Type:
int
- ipPayload¶
IP payload
- Type:
bytes
- ipProt¶
protocol type / next header field
- Type:
int
- ipSrc¶
source IP address e.g. 127.0.0.1
- Type:
str
- ipTos¶
type of service
- Type:
int
- ipTtl¶
TTL
- Type:
int
- ipVersionHeader¶
protocol version and header length
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- udpChecksum¶
checksum
- Type:
int
- udpDst¶
destination port
- Type:
int
- udpLen¶
length of the UDP segment
- Type:
int
- udpPayload¶
UDP payload
- Type:
bytes
- udpSrc¶
source port
- Type:
int
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PTP¶
PacketPtpSync¶
- class PacketPtpSync¶
In the test case, use
api.Ethernet.PacketPtpSync; in UserPyModules, usefrom tts.lib.ethernet.PacketPtp import PacketPtpSync.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetPtpControl()¶
- Returns:
PTP control field
- Return type:
int
- GetPtpCorrectionField()¶
- Returns:
PTP correction field
- Return type:
int
- GetPtpDomainNumber()¶
- Returns:
PTP domain number
- Return type:
int
- GetPtpFlags()¶
- Returns:
PTP flags
- Return type:
int
- GetPtpLogMsgInterval()¶
- Returns:
PTP log message interval
- Return type:
int
- GetPtpMsgLen()¶
- Returns:
PTP message length
- Return type:
int
- GetPtpMsgType()¶
- Returns:
PTP message type
- Return type:
int
- GetPtpSequenceId()¶
- Returns:
PTP sequence ID
- Return type:
int
- GetPtpSourcePortIdentity()¶
- Returns:
PTP source port identity
- Return type:
bytes
- GetPtpVersion()¶
- Returns:
PTP version
- Return type:
int
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetPtpCorrectionField(correctionField)¶
- Parameters:
- correctionField : int¶
PTP correction field
- SetPtpDomainNumber(domainNumber)¶
- Parameters:
- domainNumber : int¶
PTP domain number
- SetPtpLogMsgInterval(logMsgInterval)¶
- Parameters:
- logMsgInterval : int¶
log message interval
- SetPtpSequenceId(sequenceId)¶
- Parameters:
- sequenceId : int¶
PTP sequence ID
- SetPtpSourcePortIdentity(sourcePortIdentity)¶
- Parameters:
- sourcePortIdentity : bytes¶
PTP source port identity
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- ptpControl¶
PTP control field
- Type:
int
- ptpCorrectionField¶
PTP correction field
- Type:
int
- ptpDomainNumber¶
PTP domain number
- Type:
int
- ptpFlags¶
PTP flags
- Type:
int
- ptpLogMsgInterval¶
PTP log message interval
- Type:
int
- ptpMsgLen¶
PTP message length
- Type:
int
- ptpMsgType¶
PTP message type
- Type:
int
- ptpSequenceId¶
PTP sequence ID
- Type:
int
- ptpSourcePortIdentity¶
PTP source port identity
- Type:
bytes
- ptpVersion¶
PTP version
- Type:
int
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketPtpFollowUp¶
- class PacketPtpFollowUp¶
In the test case, use
api.Ethernet.PacketPtpFollowUp; in UserPyModules, usefrom tts.lib.ethernet.PacketPtp import PacketPtpFollowUp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetPtpPreciseOriginTimestampSec()¶
- Returns:
second portion of the PTP precise origin timestamp
- Return type:
int
- SetPtpPreciseOriginTimestampSec(preciseOriginTimestampSec)¶
- Parameters:
- preciseOriginTimestampSec : int¶
second portion of the PTP precise origin timestamp
- ptpPreciseOriginTimestampSec¶
second portion of the PTP precise origin timestamp
- Type:
int
- GetPtpPreciseOriginTimestampNSec()¶
- Returns:
nanosecond portion of the PTP precise origin timestamp
- Return type:
int
- SetPtpPreciseOriginTimestampNSec(preciseOriginTimestampNSec)¶
- Parameters:
- preciseOriginTimestampNSec : int¶
nanosecond portion of the PTP precise origin timestamp
- ptpPreciseOriginTimestampNSec¶
nanosecond portion of the PTP precise origin timestamp
- Type:
int
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetPtpControl()¶
- Returns:
PTP control field
- Return type:
int
- GetPtpCorrectionField()¶
- Returns:
PTP correction field
- Return type:
int
- GetPtpDomainNumber()¶
- Returns:
PTP domain number
- Return type:
int
- GetPtpFlags()¶
- Returns:
PTP flags
- Return type:
int
- GetPtpLogMsgInterval()¶
- Returns:
PTP log message interval
- Return type:
int
- GetPtpMsgLen()¶
- Returns:
PTP message length
- Return type:
int
- GetPtpMsgType()¶
- Returns:
PTP message type
- Return type:
int
- GetPtpSequenceId()¶
- Returns:
PTP sequence ID
- Return type:
int
- GetPtpSourcePortIdentity()¶
- Returns:
PTP source port identity
- Return type:
bytes
- GetPtpVersion()¶
- Returns:
PTP version
- Return type:
int
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetPtpCorrectionField(correctionField)¶
- Parameters:
- correctionField : int¶
PTP correction field
- SetPtpDomainNumber(domainNumber)¶
- Parameters:
- domainNumber : int¶
PTP domain number
- SetPtpLogMsgInterval(logMsgInterval)¶
- Parameters:
- logMsgInterval : int¶
log message interval
- SetPtpSequenceId(sequenceId)¶
- Parameters:
- sequenceId : int¶
PTP sequence ID
- SetPtpSourcePortIdentity(sourcePortIdentity)¶
- Parameters:
- sourcePortIdentity : bytes¶
PTP source port identity
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- ptpControl¶
PTP control field
- Type:
int
- ptpCorrectionField¶
PTP correction field
- Type:
int
- ptpDomainNumber¶
PTP domain number
- Type:
int
- ptpFlags¶
PTP flags
- Type:
int
- ptpLogMsgInterval¶
PTP log message interval
- Type:
int
- ptpMsgLen¶
PTP message length
- Type:
int
- ptpMsgType¶
PTP message type
- Type:
int
- ptpSequenceId¶
PTP sequence ID
- Type:
int
- ptpSourcePortIdentity¶
PTP source port identity
- Type:
bytes
- ptpVersion¶
PTP version
- Type:
int
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketPdelayReq¶
- class PacketPdelayReq¶
In the test case, use
api.Ethernet.PacketPdelayReq; in UserPyModules, usefrom tts.lib.ethernet.PacketPtp import PacketPdelayReq.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetPtpControl()¶
- Returns:
PTP control field
- Return type:
int
- GetPtpCorrectionField()¶
- Returns:
PTP correction field
- Return type:
int
- GetPtpDomainNumber()¶
- Returns:
PTP domain number
- Return type:
int
- GetPtpFlags()¶
- Returns:
PTP flags
- Return type:
int
- GetPtpLogMsgInterval()¶
- Returns:
PTP log message interval
- Return type:
int
- GetPtpMsgLen()¶
- Returns:
PTP message length
- Return type:
int
- GetPtpMsgType()¶
- Returns:
PTP message type
- Return type:
int
- GetPtpSequenceId()¶
- Returns:
PTP sequence ID
- Return type:
int
- GetPtpSourcePortIdentity()¶
- Returns:
PTP source port identity
- Return type:
bytes
- GetPtpVersion()¶
- Returns:
PTP version
- Return type:
int
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetPtpCorrectionField(correctionField)¶
- Parameters:
- correctionField : int¶
PTP correction field
- SetPtpDomainNumber(domainNumber)¶
- Parameters:
- domainNumber : int¶
PTP domain number
- SetPtpLogMsgInterval(logMsgInterval)¶
- Parameters:
- logMsgInterval : int¶
log message interval
- SetPtpSequenceId(sequenceId)¶
- Parameters:
- sequenceId : int¶
PTP sequence ID
- SetPtpSourcePortIdentity(sourcePortIdentity)¶
- Parameters:
- sourcePortIdentity : bytes¶
PTP source port identity
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- ptpControl¶
PTP control field
- Type:
int
- ptpCorrectionField¶
PTP correction field
- Type:
int
- ptpDomainNumber¶
PTP domain number
- Type:
int
- ptpFlags¶
PTP flags
- Type:
int
- ptpLogMsgInterval¶
PTP log message interval
- Type:
int
- ptpMsgLen¶
PTP message length
- Type:
int
- ptpMsgType¶
PTP message type
- Type:
int
- ptpSequenceId¶
PTP sequence ID
- Type:
int
- ptpSourcePortIdentity¶
PTP source port identity
- Type:
bytes
- ptpVersion¶
PTP version
- Type:
int
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketPdelayResp¶
- class PacketPdelayResp¶
In the test case, use
api.Ethernet.PacketPdelayResp; in UserPyModules, usefrom tts.lib.ethernet.PacketPtp import PacketPdelayResp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetPtpRequestReceiptTimestampSec()¶
- Returns:
second portion of the PTP request receipt timestamp
- Return type:
int
- SetPtpRequestReceiptTimestampSec(requestReceiptTimestampSec)¶
- Parameters:
- requestReceiptTimestampSec : int¶
second portion of the PTP request receipt timestamp
- ptpRequestReceiptTimestampSec¶
second portion of the PTP request receipt timestamp
- Type:
int
- GetPtpRequestReceiptTimestampNSec()¶
- Returns:
nanosecond portion of the PTP precise origin timestamp
- Return type:
int
- SetPtpRequestReceiptTimestampNSec(requestReceiptTimestampNSec)¶
- Parameters:
- requestReceiptTimestampNSec : int¶
nanosecond portion of the PTP precise origin timestamp
- ptpRequestReceiptTimestampNSec¶
nanosecond portion of the PTP precise origin timestamp
- Type:
int
- GetPtpRequestingPortIdentity()¶
- Returns:
PTP requesting port identity
- Return type:
bytes
- SetPtpRequestingPortIdentity(requestingPortIdentity)¶
- Parameters:
- requestingPortIdentity : bytes¶
PTP requesting port identity
- ptpRequestingPortIdentity¶
PTP requesting port identity
- Type:
bytes
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetPtpControl()¶
- Returns:
PTP control field
- Return type:
int
- GetPtpCorrectionField()¶
- Returns:
PTP correction field
- Return type:
int
- GetPtpDomainNumber()¶
- Returns:
PTP domain number
- Return type:
int
- GetPtpFlags()¶
- Returns:
PTP flags
- Return type:
int
- GetPtpLogMsgInterval()¶
- Returns:
PTP log message interval
- Return type:
int
- GetPtpMsgLen()¶
- Returns:
PTP message length
- Return type:
int
- GetPtpMsgType()¶
- Returns:
PTP message type
- Return type:
int
- GetPtpSequenceId()¶
- Returns:
PTP sequence ID
- Return type:
int
- GetPtpSourcePortIdentity()¶
- Returns:
PTP source port identity
- Return type:
bytes
- GetPtpVersion()¶
- Returns:
PTP version
- Return type:
int
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetPtpCorrectionField(correctionField)¶
- Parameters:
- correctionField : int¶
PTP correction field
- SetPtpDomainNumber(domainNumber)¶
- Parameters:
- domainNumber : int¶
PTP domain number
- SetPtpLogMsgInterval(logMsgInterval)¶
- Parameters:
- logMsgInterval : int¶
log message interval
- SetPtpSequenceId(sequenceId)¶
- Parameters:
- sequenceId : int¶
PTP sequence ID
- SetPtpSourcePortIdentity(sourcePortIdentity)¶
- Parameters:
- sourcePortIdentity : bytes¶
PTP source port identity
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- ptpControl¶
PTP control field
- Type:
int
- ptpCorrectionField¶
PTP correction field
- Type:
int
- ptpDomainNumber¶
PTP domain number
- Type:
int
- ptpFlags¶
PTP flags
- Type:
int
- ptpLogMsgInterval¶
PTP log message interval
- Type:
int
- ptpMsgLen¶
PTP message length
- Type:
int
- ptpMsgType¶
PTP message type
- Type:
int
- ptpSequenceId¶
PTP sequence ID
- Type:
int
- ptpSourcePortIdentity¶
PTP source port identity
- Type:
bytes
- ptpVersion¶
PTP version
- Type:
int
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
PacketPdelayRespFollowUp¶
- class PacketPdelayRespFollowUp¶
In the test case, use
api.Ethernet.PacketPdelayRespFollowUp; in UserPyModules, usefrom tts.lib.ethernet.PacketPtp import PacketPdelayRespFollowUp.- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- GetPtpResponseOriginTimestampSec()¶
- Returns:
second portion of the PTP response origin timestamp
- Return type:
int
- SetPtpResponseOriginTimestampSec(responseOriginTimestampSec)¶
- Parameters:
- responseOriginTimestampSec : int¶
second portion of the PTP response origin timestamp
- ptpResponseOriginTimestampSec¶
second portion of the PTP response origin timestamp
- Type:
int
- GetPtpResponseOriginTimestampNSec()¶
- Returns:
nanosecond portion of the PTP response origin timestamp
- Return type:
int
- SetPtpResponseOriginTimestampNSec(responseOriginTimestampNSec)¶
- Parameters:
- responseOriginTimestampNSec : int¶
nanosecond portion of the PTP response origin timestamp
- ptpResponseOriginTimestampNSec¶
nanosecond portion of the PTP response origin timestamp
- Type:
int
- GetPtpRequestingPortIdentity()¶
- Returns:
PTP requesting port identity
- Return type:
bytes
- SetPtpRequestingPortIdentity(requestingPortIdentity)¶
- Parameters:
- requestingPortIdentity : bytes¶
PTP requesting port identity
- ptpRequestingPortIdentity¶
PTP requesting port identity
- Type:
bytes
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- GetEthDstMac()¶
- Returns:
target MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthPayload()¶
- Returns:
Ethernet payload
- Return type:
bytes
- GetEthSrcMac()¶
- Returns:
source MAC address e.g. DE:AD:BE:EF:FF:00
- Return type:
str
- GetEthType()¶
- Returns:
ethernet protocol type
- Return type:
int
- GetMacSecAn()¶
- Returns:
Association Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecIcv()¶
- Returns:
Integrity check value of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecPn()¶
- Returns:
Packet Number of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecSci()¶
- Returns:
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Return type:
bytes
- GetMacSecSl()¶
- Returns:
Short Length of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTci()¶
- Returns:
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciAn()¶
- Returns:
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Return type:
int
- GetMacSecTciC()¶
- Returns:
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciE()¶
- Returns:
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciEs()¶
- Returns:
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciSc()¶
- Returns:
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciScb()¶
- Returns:
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetMacSecTciV()¶
- Returns:
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Return type:
bool
- GetPtpControl()¶
- Returns:
PTP control field
- Return type:
int
- GetPtpCorrectionField()¶
- Returns:
PTP correction field
- Return type:
int
- GetPtpDomainNumber()¶
- Returns:
PTP domain number
- Return type:
int
- GetPtpFlags()¶
- Returns:
PTP flags
- Return type:
int
- GetPtpLogMsgInterval()¶
- Returns:
PTP log message interval
- Return type:
int
- GetPtpMsgLen()¶
- Returns:
PTP message length
- Return type:
int
- GetPtpMsgType()¶
- Returns:
PTP message type
- Return type:
int
- GetPtpSequenceId()¶
- Returns:
PTP sequence ID
- Return type:
int
- GetPtpSourcePortIdentity()¶
- Returns:
PTP source port identity
- Return type:
bytes
- GetPtpVersion()¶
- Returns:
PTP version
- Return type:
int
- GetTimestamp()¶
- Returns:
Receive timestamp in sec., None if not available
- Return type:
float | None
- GetVlanCfi(ixVlanTags)¶
- Returns:
802.1a canonical format indicator
- Return type:
int
- GetVlanCfiOuter(ixVlanTags)¶
- Returns:
802.1ad canonical format indicator
- Return type:
int
- GetVlanPcp(ixVlanTags)¶
- Returns:
802.1a priority code point
- Return type:
int
- GetVlanPcpOuter(ixVlanTags)¶
- Returns:
802.1ad priority code point
- Return type:
int
- GetVlanVid(ixVlanTags)¶
- Returns:
802.1a VLAN id
- Return type:
int
- GetVlanVidOuter(ixVlanTags)¶
- Returns:
802.1ad VLAN id
- Return type:
int
- SetPtpCorrectionField(correctionField)¶
- Parameters:
- correctionField : int¶
PTP correction field
- SetPtpDomainNumber(domainNumber)¶
- Parameters:
- domainNumber : int¶
PTP domain number
- SetPtpLogMsgInterval(logMsgInterval)¶
- Parameters:
- logMsgInterval : int¶
log message interval
- SetPtpSequenceId(sequenceId)¶
- Parameters:
- sequenceId : int¶
PTP sequence ID
- SetPtpSourcePortIdentity(sourcePortIdentity)¶
- Parameters:
- sourcePortIdentity : bytes¶
PTP source port identity
- SetTimestamp(timestamp)¶
- Parameters:
- timestamp : float | None¶
Receive timestamp in sec., None if not available
- ethDstMac¶
target MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethPayload¶
Ethernet payload
- Type:
bytes
- ethSrcMac¶
source MAC address e.g. DE:AD:BE:EF:FF:00
- Type:
str
- ethType¶
ethernet protocol type
- Type:
int
- macSecAn¶
Association Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecIcv¶
Integrity check value of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecPn¶
Packet Number of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecSci¶
Secure Channel Identifier of MACsec header (see IEEE 802.1AE)
- Type:
bytes
- macSecSl¶
Short Length of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTci¶
TAG Control Information of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciAn¶
TCI_AN byte of MACsec header (see IEEE 802.1AE)
- Type:
int
- macSecTciC¶
Changed text bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciE¶
Encryption bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciEs¶
End station bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciSc¶
SCI indication bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciScb¶
Single copy broadcast capability bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- macSecTciV¶
Version bit in TCI of MACsec header (see IEEE 802.1AE)
- Type:
bool
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- ptpControl¶
PTP control field
- Type:
int
- ptpCorrectionField¶
PTP correction field
- Type:
int
- ptpDomainNumber¶
PTP domain number
- Type:
int
- ptpFlags¶
PTP flags
- Type:
int
- ptpLogMsgInterval¶
PTP log message interval
- Type:
int
- ptpMsgLen¶
PTP message length
- Type:
int
- ptpMsgType¶
PTP message type
- Type:
int
- ptpSequenceId¶
PTP sequence ID
- Type:
int
- ptpSourcePortIdentity¶
PTP source port identity
- Type:
bytes
- ptpVersion¶
PTP version
- Type:
int
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- vlanCfi¶
802.1a canonical format indicator
- Type:
int
- vlanCfiOuter¶
802.1ad canonical format indicator
- Type:
int
- vlanPcp¶
802.1a priority code point
- Type:
int
- vlanPcpOuter¶
802.1ad priority code point
- Type:
int
- vlanVid¶
802.1a VLAN id
- Type:
int
- vlanVidOuter¶
802.1ad VLAN id
- Type:
int
SOME/IP¶
Info
If your code uses getters and/or setter methods, you should probably convert it to use the properties as documented below, but for the time being it will continue to work.
PacketSomeIp¶
- class PacketSomeIp¶
In the test case, use
api.Ethernet.PacketSomeIp; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIp import PacketSomeIp.-
SOMEIP_MSG_REQUEST =
0¶
-
SOMEIP_MSG_REQUEST_NO_RETURN =
1¶
-
SOMEIP_MSG_NOTIFICATION =
2¶
-
SOMEIP_MSG_TP =
32¶
-
SOMEIP_MSG_RESPONSE =
128¶
-
SOMEIP_MSG_ERROR =
129¶
-
SOMEIP_RETURN_OK =
0¶
-
SOMEIP_RETURN_NOT_OK =
1¶
-
SOMEIP_RETURN_UNKNOWN_SERVICE =
2¶
-
SOMEIP_RETURN_UNKNOWN_METHOD =
3¶
-
SOMEIP_RETURN_NOT_READY =
4¶
-
SOMEIP_RETURN_NOT_REACHABLE =
5¶
-
SOMEIP_RETURN_TIMEOUT =
6¶
-
SOMEIP_RETURN_WRONG_PROTOCOL_VERSION =
7¶
-
SOMEIP_RETURN_WRONG_INTERFACE_VERSION =
8¶
-
SOMEIP_RETURN_MALFORMED =
9¶
-
SOMEIP_RETURN_TCP_ERROR =
10¶
- classmethod GetSomeIpMessagesFromPayload(data: bytes) list[PacketSomeIp]¶
Creates one or multiple SOME/IP packets from data.
- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
-
classmethod Create(serviceId=
0, methodId=0, clientId=0, sessionId=0, protocolVersion=1, interfaceVersion=1, messageType=0, returnCode=0, payload=None, length='Auto', messageId=None, requestId=None)¶ Returns a PacketSomeIp object as specified. If a messageId is given, any given serviceId and methodId will be overwritten. If a requestId is given, any given clientId and sessionId will be overwritten.
- Parameters:
- serviceId : int, optional¶
defaults to 0x00
- methodId : int, optional¶
defaults to 0x00
- clientId : int, optional¶
defaults to 0x00
- sessionId : int, optional¶
defaults to 0x00
- protocolVersion : int, optional¶
defaults to 0x01
- interfaceVersion : int, optional¶
defaults to 0x01
- messageType : int | str, optional¶
defaults to
api.Ethernet.PacketSomeIp.SOMEIP_MSG_REQUEST- returnCode : int | str, optional¶
defaults to
api.Ethernet.PacketSomeIp.SOMEIP_RETURN_OK- payload : bytes | ByteStream | None, optional¶
defaults to None
- length : int, optional¶
defaults to ‘Auto’
- messageId : int | None, optional¶
defaults to None
- requestId : int | None, optional¶
defaults to None
- Returns:
PacketSomeIp object
- Return type:
- CalcLen()¶
Calculate and set the current length of this SOME/IP packet
- messageId¶
message id
- Type:
int
- serviceId¶
service id (highest 16 bit from message id)
- Type:
int
- methodId¶
method id (lowest 16 bit from message id)
- Type:
int
- length¶
length from this header position
- Type:
int
- requestId¶
request id
- Type:
int
- clientId¶
client id (highest 16 bit from request id)
- Type:
int
- sessionId¶
session id (lowest 16 bit from request id)
- Type:
int
- protocolVersion¶
protocol version
- Type:
int
- interfaceVersion¶
interface version
- Type:
int
- messageType¶
message type
- Type:
int
- returnCode¶
return code
- Type:
int
- payload¶
payload for this packet
- Type:
bytes
- GetHeaderBytes()¶
- Returns:
the header (cached)
- Return type:
bytes
- instanceIds¶
- Return type:
set
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
-
SOMEIP_MSG_REQUEST =
PacketSomeIpSd¶
- class PacketSomeIpSd¶
In the test case, use
api.Ethernet.PacketSomeIpSd; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSd.-
__init__(self, data: bytes | None =
None)¶ Create a
PacketSomeIpSdinstance. Either from an existing payload, or empty.
- <protocol>
Equivalent to method
FindParent(protocol). Direct access to parent protocols. protocol is one ofOsiProtocol.Example: Signal.eth.src provides the source MAC address of the Ethernet protocol layer.
- Type:
- CalcEntryArrayLen()¶
Calculate and set the current length of all entries
- CalcOptionArrayLen()¶
Calculate and set the current length of all options
-
classmethod Create(rebootFlag=
True, unicastFlag=True, entryList=None, optionList=None, entryArrayLength='Auto', optionArrayLength='Auto')¶ Returns a PacketSomeIpSd object as specified.
- Parameters:
- Returns:
PacketSomeIpSd object
- Return type:
- FindParent(protocol)¶
Only for pseudo signals in trace analysis! Returns the requested protocol object if present, otherwise a
NoProtocolobject.- Parameters:
- protocol : OsiProtocol¶
The required protocol name.
- Returns:
The required parent protocol object.
- Return type:
- entryLen¶
length of all entries in bytes
- Type:
int
- entryList¶
list of all SOME/IP-SD entries
- Type:
list[PacketSomeIpSdEntry]
- optionLen¶
length of all options in bytes
- Type:
int
- optionList¶
list of all SOME/IP-SD options
- Type:
list[PacketSomeIpSdOption]
- parent¶
Only for pseudo signals in trace analysis! Returns the parent protocol object if there is one present, otherwise None.
- Return type:
EthernetProtocolBase | None
- rebootFlag¶
reboot flag
- Type:
bool
- timestamp¶
Receive timestamp in sec., None if not available
- Type:
Optional[float]
- unicastFlag¶
unicast flag
- Type:
bool
-
__init__(self, data: bytes | None =
PacketSomeIpSdEntry¶
- class PacketSomeIpSdEntry¶
In the test case, use
api.Ethernet.PacketSomeIpSdEntry; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdEntry.- index1¶
first option index
- Type:
int
- index2¶
second option index
- Type:
int
- instanceId¶
instance id
- Type:
int
- majorVersion¶
major version
- Type:
int
- optionCount1¶
first option count
- Type:
int
- optionCount2¶
second option count
- Type:
int
- serviceId¶
service id
- Type:
int
- ttl¶
Time to live (TTL)
- Type:
int
- type¶
entry type
- Type:
int
PacketSomeIpSdEntryService¶
- class PacketSomeIpSdEntryService¶
Bases:
PacketSomeIpSdEntryIn the test case, use
api.Ethernet.PacketSomeIpSdEntryService; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdEntryService.-
SERVICE_FIND =
0¶
-
SERVICE_OFFER =
1¶
-
SERVICE_STOP_OFFER =
1¶
-
classmethod Create(index1=
0, index2=0, instanceId=1, majorVersion=1, minorVersion=0, optionCount1=0, optionCount2=0, serviceId=0, ttl=0, type=1)¶ Returns a PacketSomeIpSdEntryService object as specified.
- Parameters:
- index1 : int, optional¶
defaults to 0
- index2 : int, optional¶
defaults to 0
- instanceId : int, optional¶
defaults to 1
- majorVersion : int, optional¶
defaults to 1
- minorVersion : int, optional¶
defaults to 0
- optionCount1 : int, optional¶
defaults to 0
- optionCount2 : int, optional¶
defaults to 0
- serviceId : int, optional¶
defaults to 0
- ttl : int, optional¶
defaults to 0
- type : int, optional¶
defaults to
api.Ethernet.PacketSomeIpSdEntryService.SERVICE_OFFER
- Returns:
PacketSomeIpSdEntryService object
- Return type:
- minorVersion¶
minor version
- Type:
int
-
SERVICE_FIND =
PacketSomeIpSdEntryEventgroup¶
- class PacketSomeIpSdEntryEventgroup¶
Bases:
PacketSomeIpSdEntryIn the test case, use
api.Ethernet.PacketSomeIpSdEntryEventgroup; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdEntryEventgroup.-
EVENTGROUP_SUBSCRIBE =
6¶
-
EVENTGROUP_SUBSCRIBE_ACK =
7¶
-
EVENTGROUP_STOP_SUBSCRIBE =
6¶
-
EVENTGROUP_SUBSCRIBE_NACK =
7¶
-
classmethod Create(eventgroupId=
0, index1=0, index2=0, instanceId=1, majorVersion=1, optionCount1=0, optionCount2=0, serviceId=0, ttl=0, type=6)¶ Returns a PacketSomeIpSdEntryEventgroup object as specified.
- Parameters:
- eventgroupId : int, optional¶
defaults to 0
- index1 : int, optional¶
defaults to 0
- index2 : int, optional¶
defaults to 0
- instanceId : int, optional¶
defaults to 1
- majorVersion : int, optional¶
defaults to 1
- optionCount1 : int, optional¶
defaults to 0
- optionCount2 : int, optional¶
defaults to 0
- serviceId : int, optional¶
defaults to 0
- ttl : int, optional¶
defaults to 0
- type : int, optional¶
defaults to
api.Ethernet.PacketSomeIpSdEntryEventgroup.EVENTGROUP_SUBSCRIBE
- Returns:
PacketSomeIpSdEntryEventgroup object
- Return type:
- eventgroupId¶
eventgroup id
- Type:
int
-
EVENTGROUP_SUBSCRIBE =
PacketSomeIpSdOption¶
- class PacketSomeIpSdOption¶
In the test case, use
api.Ethernet.PacketSomeIpSdOption; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOption.-
TRANSPORT_TCP =
6¶
-
TRANSPORT_UDP =
17¶
-
PACKET_SOME_IP_SD_OPTION_CONFIG =
1¶
-
PACKET_SOME_IP_SD_OPTION_IPV4 =
4¶
-
PACKET_SOME_IP_SD_OPTION_IPV6 =
6¶
-
PACKET_SOME_IP_SD_OPTION_IPV4_MULTICAST =
20¶
-
PACKET_SOME_IP_SD_OPTION_IPV4_SD =
36¶
-
PACKET_SOME_IP_SD_OPTION_IPV6_MULTICAST =
22¶
-
PACKET_SOME_IP_SD_OPTION_IPV6_SD =
38¶
- optionLen¶
length of this option from reserved field
- Type:
int
- type¶
option type
- Type:
int
-
TRANSPORT_TCP =
PacketSomeIpSdOptionIpv4¶
- class PacketSomeIpSdOptionIpv4¶
Bases:
PacketSomeIpSdOptionIn the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv4; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv4.-
classmethod Create(ip=
'127.0.0.1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdOptionIpv4 object as specified.
- Parameters:
- ip : str, optional¶
defaults to ‘127.0.0.1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv4 object
- Return type:
- ip¶
IPv4 address, format 127.0.0.1
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionIpv6¶
- class PacketSomeIpSdOptionIpv6¶
Bases:
PacketSomeIpSdOptionIn the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv6; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv6.-
classmethod Create(ip=
'::1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdEntryService object as specified
- Parameters:
- ip : str, optional¶
defaults to ‘::1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv6 object
- Return type:
- ip¶
IPv6 address, format 2001:0db8:85a3:08d3:1319:8a2e:0370:7344
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionIpv4Multicast¶
- class PacketSomeIpSdOptionIpv4Multicast¶
Bases:
PacketSomeIpSdOptionIpv4In the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv4Multicast; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv4Multicast.-
classmethod Create(ip=
'127.0.0.1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdOptionIpv4Multicast object as specified.
- Parameters:
- ip : str, optional¶
defaults to ‘127.0.0.1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv4Multicast object
- Return type:
- ip¶
IPv4 address, format 127.0.0.1
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionIpv6Multicast¶
- class PacketSomeIpSdOptionIpv6Multicast¶
Bases:
PacketSomeIpSdOptionIpv6In the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv6Multicast; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv6Multicast.-
classmethod Create(ip=
'::1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdOptionIpv6Multicast object as specified.
- Parameters:
- ip : str, optional¶
defaults to ‘::1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv6Multicast object
- Return type:
- ip¶
IPv6 address, format 2001:0db8:85a3:08d3:1319:8a2e:0370:7344
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionIpv4SD¶
- class PacketSomeIpSdOptionIpv4SD¶
Bases:
PacketSomeIpSdOptionIpv4In the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv4SD; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv4SD.-
classmethod Create(ip=
'127.0.0.1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdOptionIpv4 object as specified.
- Parameters:
- ip : str, optional¶
defaults to ‘127.0.0.1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv4 object
- Return type:
- ip¶
IPv4 address, format 127.0.0.1
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionIpv6SD¶
- class PacketSomeIpSdOptionIpv6SD¶
Bases:
PacketSomeIpSdOptionIpv6In the test case, use
api.Ethernet.PacketSomeIpSdOptionIpv6SD; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionIpv6SD.-
classmethod Create(ip=
'::1', port=1234, protocol=17, optionLength='Auto')¶ Returns a PacketSomeIpSdEntryService object as specified
- Parameters:
- ip : str, optional¶
defaults to ‘::1’
- port : int, optional¶
defaults to 1234
- protocol : int, optional¶
defaults to
api.Ethernet.UDP- optionLength : int, optional¶
defaults to “Auto”
- Returns:
PacketSomeIpSdOptionIpv6 object
- Return type:
- ip¶
IPv6 address, format 2001:0db8:85a3:08d3:1319:8a2e:0370:7344
- Type:
str
- optionLen¶
length of this option from reserved field
- Type:
int
- port¶
transport layer port
- Type:
int
- protocol¶
transport layer protocol -
api.Ethernet.UDP,api.Ethernet.TCP- Type:
int
-
classmethod Create(ip=
PacketSomeIpSdOptionConfig¶
- class PacketSomeIpSdOptionConfig¶
Bases:
PacketSomeIpSdOptionIn the test case, use
api.Ethernet.PacketSomeIpSdOptionConfig; in UserPyModules, usefrom tts.lib.ethernet.PacketSomeIpSd import PacketSomeIpSdOptionConfig.-
classmethod Create(config, optionLength=
'Auto')¶ Returns a PacketSomeIpSdOptionConfig object as specified.
- Parameters:
- Returns:
PacketSomeIpSdOptionConfig object
- Return type:
- config¶
configuration parameter as dictionary (format: {id1: value1, id: value2, …})
- Type:
dict
- optionLen¶
length of this option from reserved field
- Type:
int
-
classmethod Create(config, optionLength=