Changed docstrings to fit script format

This commit is contained in:
Logan Lipke
2021-01-04 14:53:49 -08:00
parent e08d6548f3
commit 13dc5ed016
12 changed files with 50 additions and 36 deletions

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations or macvlans to test fileio traffic. Pre-existing stations and
- This script will create a variable number of stations or macvlans to test fileio traffic. Pre-existing stations and
macvlans can be used as well. Command line options are available to update cross-connects as well as using a list of
existing cross-connects if desired. if none are given, cross-connects and endpoints will be created by the script.
Modes such as read-only, write-only, or both can be specified as well as ip addresses and starting numbers for sequential
@@ -9,8 +9,9 @@
this script will depend on the mode used, a read-only test will check the read-bps column, write-only will check write-bps
and both will check both columns. If the relevant columns increase over the duration of the test it will pass,
otherwise it will fail.
Use './test_fileio.py --help' to see command line usage and options
- Use './test_fileio.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,12 +1,13 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations to test generic endpoints. Multiple command types can be tested
- This script will create a variable number of stations to test generic endpoints. Multiple command types can be tested
including ping, speedtest, generic types. The test will check the last result column for different things
depending on what test is being run. Ping will test for successful pings, speedtest will test for download
speed, upload speed, and ping time, generic will test for successful generic commands
Use './test_generic.py --help' to see command line usage and options
- Use './test_generic.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import pprint

View File

@@ -1,11 +1,13 @@
#!/usr/bin/env python3
"""
Script for creating a variable number of stations and attempting to connect them to an SSID.
- Script for creating a variable number of stations and attempting to connect them to an SSID.
A test will run to verify stations are associated and get an IP, if these conditions are both true, the test will
pass, otherwise, the test will fail.
Use './test_ipv4_connection.py' --help to see command line usage and options
- Use './test_ipv4_connection.py' --help to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
- See cookbook here: https://www.candelatech.com/....?
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-rd column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4.py --help' to see command line usage and options
= Use './test_ipv4_l4.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-wr column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_upload.py --help' to see command line usage and options
- Use './test_ipv4_l4_ftp_upload.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,12 +1,13 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run a specified number of times with periodic checks for traffic successfully being received every ten minutes.
The test will monitor the urls/s column of the endpoints. Being at or above 90% of the chosen url rate at each interval
will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_urls_per_ten.py --help' to see command line usage and options
- Use './test_ipv4_l4_ftp_urls_per_ten.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-wr column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_wifi.py --help' to see command line usage and options
- Use './test_ipv4_l4_ftp_wifi.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,12 +1,13 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run a specified number of times with periodic checks for traffic successfully being received every ten minutes.
The test will monitor the urls/s column of the endpoints. Being at or above 90% of the chosen url rate at each interval
will pass the test, otherwise it will fail
Use './test_ipv4_l4_urls_per_ten.py --help' to see command line usage and options
- Use './test_ipv4_l4_urls_per_ten.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
- This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-rd column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_wifi.py --help' to see command line usage and options
- Use './test_ipv4_l4_wifi.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,11 +1,13 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations each with their own set of cross-connects and endpoints.
- This script will create a variable number of stations each with their own set of cross-connects and endpoints.
It will then create layer 3 traffic over a specified amount of time, testing for increased traffic at regular intervals.
This test will pass if all stations increase traffic over the full test duration.
Use './test_ipv4_variable_time.py --help' to see command line usage and options
- Use './test_ipv4_variable_time.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
- See cookbook here: https://www.candelatech.com/....?
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
Script for creating a variable number of stations and attempting to connect them to an SSID using IPv6.
- Script for creating a variable number of stations and attempting to connect them to an SSID using IPv6.
A test will run to verify stations are associated and get an IP, if these conditions are both true, the test will
pass, otherwise, the test will fail.
Use './test_ipv6_connection.py --help' to see command line usage and options
- Use './test_ipv6_connection.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,11 +1,12 @@
#!/usr/bin/env python3
"""
This script will create a variable number of stations, using IPv6, each with their own set of cross-connects and endpoints.
- This script will create a variable number of stations, using IPv6, each with their own set of cross-connects and endpoints.
It will then create layer 3 traffic over a specified amount of time, testing for increased traffic at regular intervals.
This test will pass if all stations increase traffic over the full test duration.
Use './test_ipv6_variable_time.py --help' to see command line usage and options
- Use './test_ipv6_variable_time.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys