misc module

Token	A wrapper of connection and request.
Hex	NewType creates simple unique types with almost zero runtime overhead.
ArpEntry	ArpEntry(ipv4_address: ipaddress.IPv4Address, prefix: int, patched_mac: xoa_driver.internals.commands.enums.OnOff, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex)
NdpEntry	NdpEntry(ipv6_address: ipaddress.IPv6Address, prefix: int, patched_mac: xoa_driver.internals.commands.enums.OnOff, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex)
DhcpEntry	DhcpEntry(ipv4_address: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8eac0>, subnet_mask: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ed90>, braodcast_address: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ea70>, defaultgw: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ea20>, lease_time: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f100>, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8eb10>)
GroupAddressElem	GroupAddressElem(ip_address, subnet_mask, mac_address)
VlanTag	VlanTag(tci, type)
QueueStatsElem	QueueStatsElem(rx_bytes: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8fe20>, rx_packets: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f7e0>, tx_bytes: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f790>, tx_packets: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8fb50>)
ConnectionGroup	alias of ConnectionGroupIdx
BasePortFilter	alias of BaseFilterIdx
GenuinePortFilter	alias of GenuineFilterIdx
LengthTerm	alias of LengthTermIdx
MatchTerm	alias of MatchTermIdx
PortDataset	alias of PortDatasetIdx
BaseStream	alias of BaseStreamIdx
GenuineStream	alias of GenuineStreamIdx
ImpairmentFlow	alias of CFlow
BasicImpairmentFlowFilter	alias of ModeBasic
ExtendedImpairmentFlowFilter	alias of ModeExtended
GenuineMacSecTxScIdx	Genuine MACSec TX SC Index Manager
GenuineMacSecRxScIdx	Genuine MACSec RX SC Index Manager

Module Contents

Other types used in Xena test ports.

class ArpEntry

Bases: object

ArpEntry(ipv4_address: ipaddress.IPv4Address, prefix: int, patched_mac: xoa_driver.internals.commands.enums.OnOff, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex)

ipv4_address

The IP address to match to the Target IP address in the ARP requests

mac_address

The target MAC address to return in the ARP reply. If set t to all-zero, the port MAC address will be used.

patched_mac

If on, the target MAC address will be patched with the part of the IP address that is not masked by the prefix

prefix

The IP prefix used for address matching.

BasePortFilter

alias of BaseFilterIdx

BaseStream

alias of BaseStreamIdx

ConnectionGroup

alias of ConnectionGroupIdx

class DhcpEntry

Bases: object

DhcpEntry(ipv4_address: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8eac0>, subnet_mask: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ed90>, braodcast_address: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ea70>, defaultgw: ipaddress.IPv4Address = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8ea20>, lease_time: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f100>, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8eb10>)

class GenuineMacSecRxScIdx

Bases: BaseMacSecRxScIdx

Genuine MACSec RX SC Index Manager

access_sak_value(sak_index)

Access SAK value

Parameters:

sak_index (int) – SAK key index

Return type:

P_MACSEC_RXSC_SAK_VALUE

stats

Port’s MACsec RX SC statistics

Type:

P_MACSEC_RXSC_STATS

class GenuineMacSecTxScIdx

Bases: BaseMacSecTxScIdx

Genuine MACSec TX SC Index Manager

access_sak_value(sak_index)

Access SAK value

Parameters:

sak_index (int) – SAK key index

Return type:

P_MACSEC_TXSC_SAK_VALUE

stats

Port’s MACsec TX SC statistics

Type:

P_MACSEC_TXSC_STATS

GenuinePortFilter

alias of GenuineFilterIdx

GenuineStream

alias of GenuineStreamIdx

class GroupAddressElem

Bases: object

GroupAddressElem(ip_address, subnet_mask, mac_address)

ImpairmentFlow

alias of CFlow

LengthTerm

alias of LengthTermIdx

MatchTerm

alias of MatchTermIdx

class NdpEntry

Bases: object

NdpEntry(ipv6_address: ipaddress.IPv6Address, prefix: int, patched_mac: xoa_driver.internals.commands.enums.OnOff, mac_address: xoa_driver.internals.core.transporter.protocol.payload.types.Hex)

ipv6_address

The IP address to match to the Target IP address in the NDP Neighbor Solicitation

mac_address

The target MAC address to return in the NDP Neighbor Advertisement. If set t to all-zero, the port MAC address will be used.

patched_mac

If on, the target MAC address will be patched with the part of the IP address that is not masked by the prefix

prefix

The IP prefix used for address matching.

PortDataset

alias of PortDatasetIdx

class QueueStatsElem

Bases: object

QueueStatsElem(rx_bytes: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8fe20>, rx_packets: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f7e0>, tx_bytes: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8f790>, tx_packets: int = <xoa_driver.internals.core.transporter.protocol.payload.field.FieldSpecs object at 0x7177b6b8fb50>)

class Token

Bases: Awaitable[AwaitableDataType]

A wrapper of connection and request. Which can be used for await an single command or organized in to the ordered sequence of the commands which will be send to the server in single request.

class VlanTag

Bases: object

VlanTag(tci, type)