diff options
| author |   imarom <imarom@cisco.com> | 2017-01-29 18:35:19 +0200 |
|---|---|---|
| committer | imarom <imarom@cisco.com> | 2017-01-29 18:35:19 +0200 |
| commit | 78a3270eda09ba24a7f9f795800df3337f8953bf (patch) | |
| tree | afa40d7512b4fd85bd7091a8bb8cc677b1425e50 /scripts/automation/trex_control_plane/stl | |
| parent | 519ea63d05c655a75602eb8cd77c84e6e49e827d (diff) | |
documenation errors
Signed-off-by: imarom <imarom@cisco.com>
Diffstat (limited to 'scripts/automation/trex_control_plane/stl')
| -rwxr-xr-x | scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py b/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py index c46a7d78..215c0253 100755 --- a/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py +++ b/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py @@ -3008,16 +3008,18 @@ class STLClient(object): Starts a low rate packet capturing on the server :parameters: - tx_ports - on which ports to capture TX - rx_ports - on which ports to capture RX - limit - limit how many packets will be written - memory requierment is O(9K * limit) - - mode - 'fixed': when full, newer packets will be - dropped - - 'cyclic: when full, older packets will be - dropped + tx_ports: list + on which ports to capture TX + + rx_ports: list + on which ports to capture RX + + limit: int + limit how many packets will be written memory requierment is O(9K * limit) + + mode: str + 'fixed' - when full, newer packets will be dropped + 'cyclic' - when full, older packets will be dropped :returns: returns a dictionary: @@ -3075,10 +3077,12 @@ class STLClient(object): Stops an active capture and optionally save it to a PCAP file :parameters: - capture_id - an active capture ID to stop - output_filename - output filename to save capture - if None all captured packets - will be discarded + capture_id: int + an active capture ID to stop + + output_filename: str + output filename to save capture + if 'None', all captured packets will be discarded :raises: + :exe:'STLError' |