mirror of
				https://github.com/Telecominfraproject/wlan-lanforge-scripts.git
				synced 2025-11-04 04:38:02 +00:00 
			
		
		
		
	Updated descriptions in cli --help output
This commit is contained in:
		@@ -119,15 +119,12 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create generic endpoints and test for their ability to execute chosen commands
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_generic.py:
 | 
			
		||||
    test_generic.py
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_generic.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -115,15 +115,13 @@ def main():
 | 
			
		||||
        #formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
        Useful Information:
 | 
			
		||||
            1. TBD
 | 
			
		||||
         Create stations that attempt to authenticate, associate, and receive IP addresses on the 
 | 
			
		||||
         chosen SSID
 | 
			
		||||
            ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
        test_ipv4_variable_tim.py:
 | 
			
		||||
         --------------------
 | 
			
		||||
         TBD
 | 
			
		||||
 | 
			
		||||
        test_ipv4_connection.py
 | 
			
		||||
        ------------------------
 | 
			
		||||
         Generic command layout:
 | 
			
		||||
         python ./test_ipv4_variable_time.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -156,15 +156,13 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create layer-4 endpoints and test that the bytes-rd from the chosen URL are increasing over the
 | 
			
		||||
                duration of the test
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_generic.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
        test_ipv4_l4.py
 | 
			
		||||
        --------------------
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv4_l4.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -157,15 +157,13 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create layer-4 endpoints to an ftp server and test that the bytes-wr are increasing over the duration
 | 
			
		||||
                of the test 
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv4_l4_ftp_upload.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
        test_ipv4_l4_ftp_upload.py
 | 
			
		||||
        --------------------------
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv4_l4_ftp_upload.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -137,15 +137,12 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create layer-4 endpoints to connect to an ftp server and test that urls/s are meeting or exceeding the target rate
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv4_l4_urls_per_ten.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
        test_ipv4_l4_ftp_urls_per_ten.py
 | 
			
		||||
        --------------------------
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv4_l4_urls_per_ten.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -160,15 +160,13 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create layer-4 endpoints and test that the bytes-rd from the chosen URL are increasing over the
 | 
			
		||||
                duration of the test
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv4_l4_ftp_wifi.py_upload.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
        test_ipv4_l4_ftp_wifi.py
 | 
			
		||||
        --------------------------
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv4_l4_ftp_wifi.py_upload.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -133,13 +133,12 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
            Create layer-4 endpoints to connect to a url and test that urls/s are meeting or exceeding the target rate
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv4_l4_urls_per_ten.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    -----------------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
 
 | 
			
		||||
@@ -159,15 +159,13 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
                Create layer-4 endpoints and test that the bytes-rd from the chosen URL are increasing over the
 | 
			
		||||
                duration of the test
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv4_l4_wifi.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv4_l4.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -166,15 +166,12 @@ def main():
 | 
			
		||||
        #formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
        Useful Information:
 | 
			
		||||
            1. TBD
 | 
			
		||||
            Create stations to test connection and traffic on VAPs of varying security types (WEP, WPA, WPA2, WPA3, Open)
 | 
			
		||||
            ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
test_ipv4_variable_time.py:
 | 
			
		||||
--------------------
 | 
			
		||||
TBD
 | 
			
		||||
 | 
			
		||||
Generic command layout:
 | 
			
		||||
python ./test_ipv4_variable_time.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -116,15 +116,13 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
            Useful Information:
 | 
			
		||||
                1. TBD
 | 
			
		||||
            Create stations that attempt to authenticate, associate, and receive IPV6 addresses on the 
 | 
			
		||||
            chosen SSID
 | 
			
		||||
                ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
    test_ipv6_connection.py:
 | 
			
		||||
    --------------------
 | 
			
		||||
    TBD
 | 
			
		||||
 | 
			
		||||
    Generic command layout:
 | 
			
		||||
    python ./test_ipv6_connection.py --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -166,15 +166,12 @@ def main():
 | 
			
		||||
        # formatter_class=argparse.RawDescriptionHelpFormatter,
 | 
			
		||||
        formatter_class=argparse.RawTextHelpFormatter,
 | 
			
		||||
        epilog='''\
 | 
			
		||||
        Useful Information:
 | 
			
		||||
            1. TBD
 | 
			
		||||
        Create stations to test IPV6 connection and traffic on VAPs of varying security types (WEP, WPA, WPA2, WPA3, Open)
 | 
			
		||||
            ''',
 | 
			
		||||
 | 
			
		||||
        description='''\
 | 
			
		||||
test_ipv6_variable_time.py:
 | 
			
		||||
--------------------
 | 
			
		||||
TBD
 | 
			
		||||
 | 
			
		||||
Generic command layout:
 | 
			
		||||
python ./test_ipv6_variable_time.py --upstream_port <port> --radio <radio 0> <stations> <ssid> <ssid password> <security type: wpa2, open, wpa3> --debug
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user