Client¶

class excentis.xra31.Client(address: str = 'localhost')¶

A Python client for the XRA-31.

address¶: The XRA-31’s address.

min_server_version¶: The minimal XRA-31 server version.

timeout¶: The XRA-31’s request timeout in seconds (read/connect).

configuration¶: The Configuration object.

capture¶: The Capture object.

analysis¶: The Analysis object.

system_serial¶: The XRA-31’s system serial.

company¶: The XRA-31’s licensed company.

property version¶: The XRA-31 API client version.

property min_version¶: The minimal XRA-31 API client version required by the server.

property server_version¶: The XRA-31’s server version.

property url¶: The XRA-31’s URL.

property url_api¶: The XRA-31’s API URL.

get_full_access() → None ¶: Enter full access mode.

try_full_access() → bool ¶

Try to enter full access mode.

Returns: True if successful, False otherwise.
Return type: bool

release() → None ¶: Release full access mode.

describe() → Dict[str, Any]¶: Representation of an XRA-31 configuration.

apply(description: dict) → None ¶

Apply an XRA-31 configuration.

Parameters: description (dict) – The configuration description (describe()).

Members