byteblower_test_framework.host module

Host interfaces which serve ByteBlower traffic endpoints.

class byteblower_test_framework.host.MeetingPoint

Bases: object

ByteBlower Meeting Point interface.

Added in version 1.2.0: Added for ByteBlower Endpoint support.

__init__(ip_or_host: str) → None

Connect to the ByteBlower Meeting Point.

Parameters:: ip_or_host (str) – The connection address. This can be the hostname or IPv4/IPv6 address of the ByteBlower Meeting Point.

static __new__(cls, ip_or_host: str)

property bb_meeting_point: MeetingPoint: Object from the ByteBlower API.

property info: str: Return connection address this Meeting Point.

release() → None

Release this host related resources used on the ByteBlower system.

Warning

Releasing resources related to traffic generation and analysis should be done first via the Scenario.release() and/or Flow.release().

Warning

Releasing endpoint resources should be done first via Port.release().

release_endpoint(endpoint: WirelessEndpoint) → None

Release this endpoint resources used on the ByteBlower system.

Removes this device from the list of endpoints used in the test and destroys it on the Meeting Point.

Parameters:: endpoint (LLEndpoint) – Endpoint to release

reserve_endpoint(uuid: str) → WirelessEndpoint

Add device to the list of endpoints used in the test.

Return type:: WirelessEndpoint

property timestamp: datetime: Return the current time on the Meeting Point.

class byteblower_test_framework.host.Server

Bases: object

ByteBlower Server interface.

__init__(ip_or_host: str) → None

Connect to the ByteBlower server.

Parameters:: ip_or_host (str) – The connection address. This can be the hostname or IPv4/IPv6 address of the ByteBlower server.

property bb_server: ByteBlowerServer: Server object from the ByteBlower API.

property info: str: Return connection address this server.

release() → None

Release this host related resources used on the ByteBlower system.

Warning

Releasing resources related to traffic generation and analysis should be done first via the Scenario.release() and/or Flow.release().

Warning

Releasing endpoint resources should be done first via Port.release().

start() → None

Start all ByteBlower Ports configured on this server.

Warning

This call will start all traffic generation/analysis on all ByteBlowerPorts created for this Server.

This might not be intended when you run multiple test scenarios in parallel.

stop() → None

Stop all ByteBlower Ports configured on this server.

Warning

This call will stop all traffic generation/analysis on all ByteBlowerPorts created for this Server.

This might not be intended when you run multiple test scenarios in parallel.