diff --git a/py-json/LANforge/lf_json_autogen.py b/py-json/LANforge/lf_json_autogen.py index f3d1b008..b661c5d5 100644 --- a/py-json/LANforge/lf_json_autogen.py +++ b/py-json/LANforge/lf_json_autogen.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- - Generated by LANforge JsonApiPythonGenerator, Wed Aug 04 22:56:41 PDT 2021 + Generated by LANforge JsonApiPythonGenerator, Wed Aug 04 23:45:25 PDT 2021 - - WORK IN PROGRESS - - The API this library provides is actively being changed. This file expects to live in py-json/LANforge directory. @@ -2266,16 +2266,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_arm_endp(self, - alias=None, # parameter explanation pending - cpu_id=None, # parameter explanation pending - mx_pkt_sz=None, # parameter explanation pending - pkt_sz=None, # parameter explanation pending - port=None, # parameter explanation pending - pps=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - tos=None, # parameter explanation pending - type=None, # parameter explanation pending + alias=None, # Name of endpoint. + cpu_id=None, # Preferred CPU ID on which this endpoint should run. + mx_pkt_sz=None, # Maximum packet size, including all Ethernet headers. + pkt_sz=None, # Minimum packet size, including all Ethernet headers. + port=None, # Port number. + pps=None, # Packets per second to generate. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + tos=None, # The Type of Service, can be HEX. See set_endp_tos for details. + type=None, # Endpoint Type : arm_udp debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2368,18 +2368,18 @@ class LFJsonPost(LFCliBase): def post_add_bgp_peer(self, - p_as=None, # parameter explanation pending - delay_open_time=None, # parameter explanation pending - flags=None, # parameter explanation pending - holdtime=None, # parameter explanation pending - local_dev=None, # parameter explanation pending - nexthop=None, # parameter explanation pending - nexthop6=None, # parameter explanation pending - peer_id=None, # parameter explanation pending - peer_index=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vr_id=None, # parameter explanation pending + p_as=None, # BGP Peer Autonomous System number, 0-65535 + delay_open_time=None, # BGP Peer delay open time. + flags=None, # Virtual router BGP Peer flags, see above for definitions. + holdtime=None, # BGP Peer hold-time. + local_dev=None, # BGP Peer Local interface. + nexthop=None, # BGP Peer Nexthop, IPv4 Address. + nexthop6=None, # BGP Peer IPv6 Nexthop address. + peer_id=None, # BGP Peer Identifier: IPv4 Address + peer_index=None, # Peer index in this virtual router (0-7). + resource=None, # Resource number. + shelf=None, # Shelf name/id. + vr_id=None, # Name of virtual router. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2416,10 +2416,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_bond(self, - network_devs=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + network_devs=None, # Comma-separated list of network devices: eth1,eth2,eth3... + port=None, # Name of the bond device. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2458,16 +2458,16 @@ class LFJsonPost(LFCliBase): def post_add_br(self, - br_aging_time=None, # parameter explanation pending - br_flags=None, # parameter explanation pending - br_forwarding_delay=None, # parameter explanation pending - br_hello_time=None, # parameter explanation pending - br_max_age=None, # parameter explanation pending - br_priority=None, # parameter explanation pending - network_devs=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + br_aging_time=None, # MAC aging time, in seconds, 32-bit number. + br_flags=None, # Bridge flags, see above. + br_forwarding_delay=None, # How long to wait until the bridge will start forwarding packets. + br_hello_time=None, # How often does the bridge send out STP hello packets. + br_max_age=None, # How long until STP considers a non-responsive bridge dead. + br_priority=None, # Bridge priority, 16-bit number. + network_devs=None, # Comma-separated list of network devices: eth1,eth2,eth3... + port=None, # Name of the bridge device. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2512,14 +2512,14 @@ class LFJsonPost(LFCliBase): def post_add_cd(self, - alias=None, # parameter explanation pending - bps=None, # parameter explanation pending - flags=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - state=None, # parameter explanation pending - type=None, # parameter explanation pending + alias=None, # Name of Collision Domain. + bps=None, # Maximum speed at which this collision domain can run. + flags=None, # See above. Leave blank or use 'NA' for no default values. + report_timer=None, # How often to report stats. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + state=None, # RUNNING or STOPPED (default is RUNNING). Use this to start/stop. + type=None, # CD Type: WIFI, WISER_SURFACE, WISER_SURFACE_AIR, WISER_AIR_AIR, WISER_NCW debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2552,8 +2552,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_endp(self, - cd=None, # parameter explanation pending - endp=None, # parameter explanation pending + cd=None, # Name of Collision Domain. + endp=None, # Endpoint name/id. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2580,8 +2580,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cd_vr(self, - cd=None, # parameter explanation pending - vr=None, # parameter explanation pending + cd=None, # Name of Collision Domain. + vr=None, # Virtual-Router name/ID. + debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2665,26 +2666,26 @@ class LFJsonPost(LFCliBase): def post_add_chamber(self, - chamber_type=None, # parameter explanation pending - dut_name1=None, # parameter explanation pending - dut_name2=None, # parameter explanation pending - dut_name3=None, # parameter explanation pending - dut_name4=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - height=None, # parameter explanation pending - isolation=None, # parameter explanation pending - lanforge1=None, # parameter explanation pending - lanforge2=None, # parameter explanation pending - lanforge3=None, # parameter explanation pending - lanforge4=None, # parameter explanation pending - name=None, # parameter explanation pending - resource=None, # parameter explanation pending - sma_count=None, # parameter explanation pending - turntable_type=None, # parameter explanation pending - width=None, # parameter explanation pending - x=None, # parameter explanation pending - y=None, # parameter explanation pending + chamber_type=None, # Chamber type, see above. Use 1 for Medium if uncertain. + dut_name1=None, # Name of first DUT in this chamber or NA + dut_name2=None, # Name of second DUT in this chamber or NA + dut_name3=None, # Name of third DUT in this chamber or NA + dut_name4=None, # Name of fourth DUT in this chamber or NA + flags=None, # Flag field for Chamber, see above. + flags_mask=None, # Mask of what flags to pay attention to, or NA for all. + height=None, # Height to be used when drawn in the LANforge-GUI. + isolation=None, # Estimated isolation in db for this chamber. + lanforge1=None, # EID of first LANforge Resource in this chamber or NA + lanforge2=None, # EID of second LANforge Resource in this chamber or NA + lanforge3=None, # EID of third LANforge Resource in this chamber or NA + lanforge4=None, # EID of fourth LANforge Resource in this chamber or NA + name=None, # Name of Chamber, unique identifier. + resource=None, # LANforge Resource ID for controlling turn-table via serial protocol. + sma_count=None, # Number of SMA connectors on this chamber, default is 16. + turntable_type=None, # Turn-Table type: see above. + width=None, # Width to be used when drawn in the LANforge-GUI. + x=None, # X coordinate to be used when drawn in the LANforge-GUI. + y=None, # Y coordinate to be used when drawn in the LANforge-GUI. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2739,17 +2740,17 @@ class LFJsonPost(LFCliBase): def post_add_chamber_cx(self, - a_id=None, # parameter explanation pending - atten_id=None, # parameter explanation pending - b_id=None, # parameter explanation pending - connection_idx=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - internal=None, # parameter explanation pending - min_atten=None, # parameter explanation pending - name=None, # parameter explanation pending - zrssi2=None, # parameter explanation pending - zrssi5=None, # parameter explanation pending + a_id=None, # EidAntenna in string format for A side connection. + atten_id=None, # EID for the Attenuator module if one is inline on this connection. + b_id=None, # EidAntenna in string format for B side connection. + connection_idx=None, # Connection index, currently up to 32 connections supported (0-31) + flags=None, # Flag field for Chamber Connection, see above. + flags_mask=None, # Mask of what flags to pay attention to, or NA for all. + internal=None, # Internal (1) or not (0): Internal connections are no longer supported. + min_atten=None, # Specify minimum attenuation in 10ths of a db. Distance logic will not set atten below this. + name=None, # Name of Chamber, unique identifier. + zrssi2=None, # Specify 2.4Ghz zero-attenuation RSSI in 10ths of a db. Distance logic will consider this in its calculations. + zrssi5=None, # Specify 5Ghz zero-attenuation RSSI in 10ths of a db. Distance logic will consider this in its calculations. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2785,9 +2786,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_chamber_path(self, - chamber=None, # parameter explanation pending - content=None, # parameter explanation pending - path=None, # parameter explanation pending + chamber=None, # Chamber Name. + content=None, # [BLANK] will erase all content, any other text will be appended to existing text. Unescaped Value + path=None, # Path Name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2836,14 +2837,14 @@ class LFJsonPost(LFCliBase): def post_add_channel_group(self, - alias=None, # parameter explanation pending - channels=None, # parameter explanation pending - idle_flag=None, # parameter explanation pending - mtu=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span_num=None, # parameter explanation pending - type=None, # parameter explanation pending + alias=None, # Name for this Channel Group. + channels=None, # List of channels to add to this group. + idle_flag=None, # Idle flag (byte) for this channel group, for instance: 0x7e + mtu=None, # MTU (and MRU) for this channel group. Must be a multiple of the number of channels if configuring a T1 WanLink. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + span_num=None, # The span number. First span is 1, second is 2... + type=None, # The channel-type. Use 'clear' for PPP links. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2876,10 +2877,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_cx(self, - alias=None, # parameter explanation pending - rx_endp=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending - tx_endp=None, # parameter explanation pending + alias=None, # Name of the Cross Connect to create. + rx_endp=None, # Name of Receiving endpoint. + test_mgr=None, # Name of test-manager to create the CX on. + tx_endp=None, # Name of Transmitting endpoint. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -2975,34 +2976,34 @@ class LFJsonPost(LFCliBase): def post_add_dut(self, - antenna_count1=None, # parameter explanation pending - antenna_count2=None, # parameter explanation pending - antenna_count3=None, # parameter explanation pending - api_id=None, # parameter explanation pending - bssid1=None, # parameter explanation pending - bssid2=None, # parameter explanation pending - bssid3=None, # parameter explanation pending - eap_id=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - hw_version=None, # parameter explanation pending - img_file=None, # parameter explanation pending - lan_port=None, # parameter explanation pending - mgt_ip=None, # parameter explanation pending - model_num=None, # parameter explanation pending - name=None, # parameter explanation pending - passwd1=None, # parameter explanation pending - passwd2=None, # parameter explanation pending - passwd3=None, # parameter explanation pending - serial_num=None, # parameter explanation pending - serial_port=None, # parameter explanation pending - ssid1=None, # parameter explanation pending - ssid2=None, # parameter explanation pending - ssid3=None, # parameter explanation pending - sw_version=None, # parameter explanation pending - top_left_x=None, # parameter explanation pending - top_left_y=None, # parameter explanation pending - wan_port=None, # parameter explanation pending + antenna_count1=None, # Antenna count for first radio. + antenna_count2=None, # Antenna count for second radio. + antenna_count3=None, # Antenna count for third radio. + api_id=None, # DUT API Identifier (none specified yet) + bssid1=None, # BSSID for first radio. + bssid2=None, # BSSID for second radio. + bssid3=None, # BSSID for third radio. + eap_id=None, # EAP Identifier, for EAP-PEAP. + flags=None, # Flag field for DUT, see above. + flags_mask=None, # Optional mask to specify what DUT flags are being set. + hw_version=None, # DUT Hardware Version information + img_file=None, # File-Name for image to represent DUT. + lan_port=None, # IP/Mask for LAN port + mgt_ip=None, # Management IP Address to access DUT + model_num=None, # DUT Model information + name=None, # Name of DUT, cannot contain '.' + passwd1=None, # WiFi Password that can be used to connect to DUT + passwd2=None, # WiFi Password that can be used to connect to DUT + passwd3=None, # WiFi Password that can be used to connect to DUT + serial_num=None, # DUT Identifier (serial-number, etc) + serial_port=None, # Resource and Serial port name on LANforge that connects to DUT (1.2.ttyS0). Serial port does not need to be on resource holding wan_port or lan_port + ssid1=None, # WiFi SSID that can be used to connect to DUT + ssid2=None, # WiFi SSID that can be used to connect to DUT + ssid3=None, # WiFi SSID that can be used to connect to DUT + sw_version=None, # DUT Software Version information + top_left_x=None, # X Location for Chamber View. + top_left_y=None, # X Location for Chamber View. + wan_port=None, # IP/Mask for WAN port debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3055,8 +3056,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_dut_notes(self, - dut=None, # parameter explanation pending - text=None, # parameter explanation pending + dut=None, # DUT Name. + text=None, # [BLANK] will erase all, any other text will be appended to existing text. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3144,13 +3145,13 @@ class LFJsonPost(LFCliBase): def post_add_dut_ssid(self, - bssid=None, # parameter explanation pending - name=None, # parameter explanation pending - passwd=None, # parameter explanation pending - ssid=None, # parameter explanation pending - ssid_flags=None, # parameter explanation pending - ssid_flags_mask=None, # parameter explanation pending - ssid_idx=None, # parameter explanation pending + bssid=None, # BSSID for cooresponding SSID. + name=None, # Name of DUT, cannot contain '.' + passwd=None, # WiFi Password that can be used to connect to DUT + ssid=None, # WiFi SSID that can be used to connect to DUT + ssid_flags=None, # SSID flags, see above. + ssid_flags_mask=None, # SSID flags mask + ssid_idx=None, # Index of the SSID. Zero-based indexing: (0 - 7) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3220,23 +3221,23 @@ class LFJsonPost(LFCliBase): def post_add_endp(self, - alias=None, # parameter explanation pending - ip_port=None, # parameter explanation pending - is_pkt_sz_random=None, # parameter explanation pending - is_rate_bursty=None, # parameter explanation pending - max_pkt=None, # parameter explanation pending - max_rate=None, # parameter explanation pending - min_pkt=None, # parameter explanation pending - min_rate=None, # parameter explanation pending - multi_conn=None, # parameter explanation pending - payload_pattern=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - send_bad_crc_per_million=None, # parameter explanation pending - shelf=None, # parameter explanation pending - ttl=None, # parameter explanation pending - type=None, # parameter explanation pending - use_checksum=None, # parameter explanation pending + alias=None, # Name of endpoint. + ip_port=None, # IP Port: IP port for layer three endpoints. Use -1 to let the LANforge server automatically configure the ip_port. Layer 2 endpoints will ignore + is_pkt_sz_random=None, # Yes means use random sized packets, anything else means NO. + is_rate_bursty=None, # Yes means bursty, anything else means NO. + max_pkt=None, # Maximum packet size, including all headers. 0 means 'same', -1 means AUTO (5.3.2+) + max_rate=None, # Maximum transmit rate (bps), used if in bursty mode. + min_pkt=None, # Minimum packet size, including all headers. -1 means AUTO (5.3.2+) + min_rate=None, # Minimum transmit rate (bps), or only rate if not bursty. + multi_conn=None, # If > 0, will create separate process with this many connections per endpoint. See AUTO_HELPER flag + payload_pattern=None, # Payload pattern, see above. + port=None, # Port/Interface name or number. + resource=None, # Resource number. + send_bad_crc_per_million=None, # If NIC supports it, will randomly send X per million packets with bad ethernet Frame Check Sum. + shelf=None, # Shelf name/id. + ttl=None, # Time-to-live, used by UDP Multicast Endpoints only. + type=None, # Endpoint Type: See above. + use_checksum=None, # Yes means checksum the payload, anything else means NO. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3278,10 +3279,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_event(self, - details=None, # parameter explanation pending - event_id=None, # parameter explanation pending - name=None, # parameter explanation pending - priority=None, # parameter explanation pending + details=None, # Event text description. Cannot include double-quote characters. + event_id=None, # Numeric ID for the event to modify, or 'new' if creating a new one. + name=None, # Event entity name. + priority=None, # See set_event_priority for available priorities. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3392,24 +3393,24 @@ class LFJsonPost(LFCliBase): def post_add_file_endp(self, - alias=None, # parameter explanation pending - directory=None, # parameter explanation pending - fio_flags=None, # parameter explanation pending - max_read_rate=None, # parameter explanation pending - max_write_rate=None, # parameter explanation pending - min_read_rate=None, # parameter explanation pending - min_write_rate=None, # parameter explanation pending - mount_dir=None, # parameter explanation pending - mount_options=None, # parameter explanation pending - payload_pattern=None, # parameter explanation pending - port=None, # parameter explanation pending - prefix=None, # parameter explanation pending - resource=None, # parameter explanation pending - retry_timer=None, # parameter explanation pending - server_mount=None, # parameter explanation pending - shelf=None, # parameter explanation pending - type=None, # parameter explanation pending - volume=None, # parameter explanation pending + alias=None, # Name of endpoint. + directory=None, # The directory to read/write in. Absolute path suggested. + fio_flags=None, # File-IO flags, see above for details. + max_read_rate=None, # Maximum read rate, bits-per-second. + max_write_rate=None, # Maximum write rate, bits-per-second. + min_read_rate=None, # Minimum read rate, bits-per-second. + min_write_rate=None, # Minimum write rate, bits-per-second. + mount_dir=None, # Directory to mount/unmount (if blank, will use 'directory'). + mount_options=None, # Optional mount options, passed to the mount command. 'NONE' clears. + payload_pattern=None, # Payload pattern, see above. + port=None, # Port number. + prefix=None, # The prefix of the file(s) to read/write. + resource=None, # Resource number. + retry_timer=None, # Number of miliseconds to retry errored IO calls before giving up. + server_mount=None, # The server to mount, ex: 192.168.100.5/exports/test1 + shelf=None, # Shelf name/id. + type=None, # Endpoint Type : fe_generic, fe_nfs, fe_nfs4, fe_cifs, fe_iscsi, fe_cifs/ip6, fe_nfs/ip6, fe_nfs4/ip6, fe_smb2, fe_smb2/ip6 fe_smb21 fe_smb21/ip6 fe_smb30 fe_smb30/ip6 + volume=None, # iSCSI volume to mount debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3452,11 +3453,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_gen_endp(self, - alias=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - type=None, # parameter explanation pending + alias=None, # Name of endpoint. + port=None, # Port number. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + type=None, # Endpoint Type : gen_generic debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3486,12 +3487,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_gre(self, - local_lower_ip=None, # parameter explanation pending - port=None, # parameter explanation pending - remote_lower_ip=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + local_lower_ip=None, # The local lower-level IP to use. + port=None, # Name of the GRE to create, suggested to start with 'gre' + remote_lower_ip=None, # The remote lower-level IP to use. + report_timer=None, # Report timer for this port, leave blank or use NA for defaults. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3577,9 +3578,9 @@ class LFJsonPost(LFCliBase): def post_add_group(self, - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - name=None, # parameter explanation pending + flags=None, # Flags for this group, see above. + flags_mask=None, # Mask for flags that we care about, use 0xFFFFFFFF or leave blank for all. + name=None, # The name of the test group. Must be unique across all groups. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3784,27 +3785,27 @@ class LFJsonPost(LFCliBase): def post_add_l4_endp(self, - alias=None, # parameter explanation pending - block_size=None, # parameter explanation pending - dns_cache_timeout=None, # parameter explanation pending - http_auth_type=None, # parameter explanation pending - ip_addr=None, # parameter explanation pending - max_speed=None, # parameter explanation pending - port=None, # parameter explanation pending - proxy_auth_type=None, # parameter explanation pending - proxy_port=None, # parameter explanation pending - proxy_server=None, # parameter explanation pending - proxy_userpwd=None, # parameter explanation pending - quiesce_after=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - smtp_from=None, # parameter explanation pending - ssl_cert_fname=None, # parameter explanation pending - timeout=None, # parameter explanation pending - type=None, # parameter explanation pending - url=None, # parameter explanation pending - url_rate=None, # parameter explanation pending - user_agent=None, # parameter explanation pending + alias=None, # Name of endpoint. + block_size=None, # TFTP Block size, in bytes. + dns_cache_timeout=None, # In seconds, how long to cache DNS lookups. 0 means no caching at all. + http_auth_type=None, # Bit-field for allowable http-authenticate methods. + ip_addr=None, # Local IP address, for binding to specific secondary IP. + max_speed=None, # In bits-per-second, can rate limit upload or download speed of the URL contents. 0 means infinite. + port=None, # Port number. + proxy_auth_type=None, # Bit-field for allowable proxy-authenticate methods. + proxy_port=None, # HTTP Proxy port if you are using a proxy. + proxy_server=None, # The name of our proxy server if using one. + proxy_userpwd=None, # The user-name and password for proxy authentication, format: user:passwd. + quiesce_after=None, # Quiesce test after this many URLs have been processed. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + smtp_from=None, # SMTP From address. + ssl_cert_fname=None, # Name of SSL Certs file. + timeout=None, # How long to wait for a connection, in milliseconds + type=None, # Endpoint Type : l4_generic + url=None, # The URL, see syntax above. Can also be a local file. + url_rate=None, # How often should we process the URL(s), per 10 minutes. + user_agent=None, # User-Agent string. Leave blank for default. Also SMTP-TO: <a@b.com><c@d.com>...<q@x.com> debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3907,14 +3908,14 @@ class LFJsonPost(LFCliBase): def post_add_monitor(self, - aid=None, # parameter explanation pending - ap_name=None, # parameter explanation pending - bssid=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - radio=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + aid=None, # AID, may be used when sniffing on /AX radios. + ap_name=None, # Name for this Monitor interface, for example: moni0 + bssid=None, # BSSID to use when sniffing on /AX radios, optional. + flags=None, # Flags for this monitor interface. + flags_mask=None, # Flags mask for this monitor interface. + radio=None, # Name of the physical radio interface, for example: wiphy0 + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3947,14 +3948,14 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_mvlan(self, - flags=None, # parameter explanation pending - index=None, # parameter explanation pending - mac=None, # parameter explanation pending - old_name=None, # parameter explanation pending - port=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + flags=None, # 0x1: Create admin-down. + index=None, # Optional: The index of the VLAN, (the 4 in eth0#4) + mac=None, # The MAC address, can also use parent-pattern in 5.3.8 and higher: xx:xx:xx:*:*:xx + old_name=None, # The temporary name, used for configuring un-discovered hardware. + port=None, # Port number of an existing Ethernet interface. + report_timer=None, # Report timer for this port, leave blank or use NA for defaults. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -3987,27 +3988,27 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_ppp_link(self, - auth=None, # parameter explanation pending - channel_groups=None, # parameter explanation pending - debug=None, # parameter explanation pending - down_time_max_ms=None, # parameter explanation pending - down_time_min_ms=None, # parameter explanation pending - dst_ip=None, # parameter explanation pending - extra_args=None, # parameter explanation pending - holdoff=None, # parameter explanation pending - lcp_echo_failure=None, # parameter explanation pending - lcp_echo_interval=None, # parameter explanation pending - mlppp_descriptor=None, # parameter explanation pending - persist=None, # parameter explanation pending - pppoe_transport_port=None, # parameter explanation pending - resource=None, # parameter explanation pending - run_time_max_ms=None, # parameter explanation pending - run_time_min_ms=None, # parameter explanation pending - shelf=None, # parameter explanation pending - src_ip=None, # parameter explanation pending - transport_type=None, # parameter explanation pending - tty_transport_device=None, # parameter explanation pending - unit=None, # parameter explanation pending + auth=None, # YES if you want to authenticate. Default is NO. + channel_groups=None, # List of channel groups, see above. + debug=None, # YES for debug, otherwise debugging for the ppp connection is off. + down_time_max_ms=None, # Maximum length of downtime (ms) for PPP link between runs, or 0 for the link to be always up. + down_time_min_ms=None, # Minimum length of downtime (ms) for PPP link between runs, or 0 for the link to be always up. + dst_ip=None, # Destination IP address for this PPP connection. + extra_args=None, # Extra arguments to be passed directly to the pppd server. + holdoff=None, # Seconds between attempt to bring link back up if it dies, suggest 1. + lcp_echo_failure=None, # LCP echo failures before we determine links is dead, suggest 5. + lcp_echo_interval=None, # Seconds between LCP echos, suggest 1. + mlppp_descriptor=None, # A unique key for use with multi-link PPP connections. + persist=None, # YES if you want to persist the connection. This is suggested. + pppoe_transport_port=None, # Port number (or name) for underlying PPPoE transport. + resource=None, # Resource (machine) number. + run_time_max_ms=None, # Maximum uptime (ms) for PPP link during an experiment, or 0 for the link to be always up. + run_time_min_ms=None, # Minimum uptime (ms) for PPP link during an experiment, or 0 for the link to be always up. + shelf=None, # Shelf name/id. + src_ip=None, # Source IP address for this PPP connection. + transport_type=None, # What sort of transport this ppp link uses. + tty_transport_device=None, # TTY device for PPP links associated with TTYs. + unit=None, # Unit number for the PPP link. ie, the 7 in ppp7. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4154,21 +4155,21 @@ class LFJsonPost(LFCliBase): def post_add_profile(self, - alias_prefix=None, # parameter explanation pending - antenna=None, # parameter explanation pending - bandwidth=None, # parameter explanation pending - eap_id=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - freq=None, # parameter explanation pending - instance_count=None, # parameter explanation pending - mac_pattern=None, # parameter explanation pending - name=None, # parameter explanation pending - passwd=None, # parameter explanation pending - profile_flags=None, # parameter explanation pending - profile_type=None, # parameter explanation pending - ssid=None, # parameter explanation pending - vid=None, # parameter explanation pending - wifi_mode=None, # parameter explanation pending + alias_prefix=None, # Port alias prefix, aka hostname prefix. + antenna=None, # Antenna count for this profile. + bandwidth=None, # 0 (auto), 20, 40, 80 or 160 + eap_id=None, # EAP Identifier + flags_mask=None, # Specify what flags to set. + freq=None, # WiFi frequency to be used, 0 means default. + instance_count=None, # Number of devices (stations, vdevs, etc) + mac_pattern=None, # Optional MAC-Address pattern, for instance: xx:xx:xx:*:*:xx + name=None, # Profile Name. + passwd=None, # WiFi Password to be used (AP Mode), [BLANK] means no password. + profile_flags=None, # Flags for this profile, see above. + profile_type=None, # Profile type: See above. + ssid=None, # WiFi SSID to be used, [BLANK] means any. + vid=None, # Vlan-ID (only valid for vlan profiles). + wifi_mode=None, # WiFi Mode for this profile. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4208,8 +4209,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_profile_notes(self, - dut=None, # parameter explanation pending - text=None, # parameter explanation pending + dut=None, # Profile Name. + text=None, # [BLANK] will erase all, any other text will be appended to existing text. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4236,11 +4237,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_rdd(self, - peer_ifname=None, # parameter explanation pending - port=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + peer_ifname=None, # The peer (other) RedirectDevice in this pair. + port=None, # Name of the Redirect Device to create. + report_timer=None, # Report timer for this port, leave blank or use NA for defaults. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4270,10 +4271,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_sec_ip(self, - ip_list=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + ip_list=None, # IP1/prefix,IP2/prefix,...IPZ/prefix. + port=None, # Name of network device (Port) to which these IPs will be added. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4426,28 +4427,28 @@ class LFJsonPost(LFCliBase): def post_add_sta(self, - ampdu_density=None, # parameter explanation pending - ampdu_factor=None, # parameter explanation pending - ap=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - ieee80211w=None, # parameter explanation pending - key=None, # parameter explanation pending - mac=None, # parameter explanation pending - max_amsdu=None, # parameter explanation pending - mode=None, # parameter explanation pending - nickname=None, # parameter explanation pending - radio=None, # parameter explanation pending - rate=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - ssid=None, # parameter explanation pending - sta_br_ip=None, # parameter explanation pending - sta_name=None, # parameter explanation pending - wpa_cfg_file=None, # parameter explanation pending - x_coord=None, # parameter explanation pending - y_coord=None, # parameter explanation pending - z_coord=None, # parameter explanation pending + ampdu_density=None, # 0-7, or 0xFF to not set. + ampdu_factor=None, # 0-3, or 0xFF to not set. + ap=None, # The Access Point BSSID this Virtual STA should be associated with (example: 00:11:22:33:4:55, or DEFAULT for any). + flags=None, # Flags for this interface (see above.) + flags_mask=None, # If set, only these flags will be considered. + ieee80211w=None, # Management Frame Protection: 0: disabled, 1: optional, 2: Required. + key=None, # Encryption key (WEP, WPA, WPA2, WPA3, etc) for this Virtual STA. Prepend with 0x for ascii-hex input. + mac=None, # The MAC address, can also use parent-pattern in 5.3.8 and higher: xx:xx:xx:*:*:xx + max_amsdu=None, # 1 == enabled, 0 == disabled, 0xFF == do not set. + mode=None, # WiFi mode: + nickname=None, # Nickname for this Virtual STA. (No longer used) + radio=None, # Name of the physical radio interface, for example: wiphy0 + rate=None, # Max rate, see help above. + resource=None, # Resource number. + shelf=None, # Shelf number. + ssid=None, # SSID for this Virtual STA. Use [BLANK] for empty SSID. Start with 0x for HEX interpretation. + sta_br_ip=None, # IP Address for station bridging. Set to 0.0.0.0 to use MAC bridging. + sta_name=None, # Name for this Virtual STA, for example: sta0 + wpa_cfg_file=None, # WPA Supplicant config file. + x_coord=None, # Floating point number. + y_coord=None, # Floating point number. + z_coord=None, # Floating point number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4511,19 +4512,19 @@ class LFJsonPost(LFCliBase): def post_add_t1_span(self, - buildout=None, # parameter explanation pending - coding=None, # parameter explanation pending - cpu_id=None, # parameter explanation pending - first_channel=None, # parameter explanation pending - framing=None, # parameter explanation pending - mtu=None, # parameter explanation pending - pci_bus=None, # parameter explanation pending - pci_slot=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span_num=None, # parameter explanation pending - timing=None, # parameter explanation pending - type=None, # parameter explanation pending + buildout=None, # Buildout, Integer, see above. + coding=None, # Coding: T1: ami or b8zs. E1: ami or hdb3 + cpu_id=None, # CPU identifier (A, B, etc) for multiport Sangoma resources. + first_channel=None, # The first DS0 channel for this span. + framing=None, # Framing: T1: esf or d4. E1: cas or ccs. + mtu=None, # MTU for this span (used by in-band management, if at all). + pci_bus=None, # PCI Bus number, needed for Sangoma resources. + pci_slot=None, # PCI slot number, needed for Sangoma resources. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + span_num=None, # The span number. First span is 1, second is 2... + timing=None, # Timing: 0 == do not use, 1 == primary, 2 == secondary.. + type=None, # Currently supported types are: Sangoma_T1, Sangoma_E1, Digium_T1 debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4561,9 +4562,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_text_blob(self, - name=None, # parameter explanation pending - text=None, # parameter explanation pending - type=None, # parameter explanation pending + name=None, # Text name, for instance '2-AP-test-case' + text=None, # [BLANK] will erase all, any other text will be appended to existing text. Unescaped Value + type=None, # Text type identifier stream, for instance 'cv-connectivity' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4591,8 +4592,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tgcx(self, - cxname=None, # parameter explanation pending - tgname=None, # parameter explanation pending + cxname=None, # The name of the CX. + tgname=None, # The name of the test group. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4645,11 +4646,11 @@ class LFJsonPost(LFCliBase): def post_add_threshold(self, - endp=None, # parameter explanation pending - thresh_id=None, # parameter explanation pending - thresh_max=None, # parameter explanation pending - thresh_min=None, # parameter explanation pending - thresh_type=None, # parameter explanation pending + endp=None, # Endpoint name or ID. + thresh_id=None, # Threshold ID. If adding new threshold, use -1, otherwise use correct ID. + thresh_max=None, # Maximum acceptable value for this threshold. + thresh_min=None, # Minimum acceptable value for this threshold. + thresh_type=None, # Threshold type, integer, (see above). debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4679,7 +4680,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_tm(self, - name=None, # parameter explanation pending + name=None, # The name of the test manager. Must be unique across test managers. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4776,16 +4777,16 @@ class LFJsonPost(LFCliBase): def post_add_traffic_profile(self, - instance_count=None, # parameter explanation pending - max_pdu=None, # parameter explanation pending - max_speed=None, # parameter explanation pending - min_pdu=None, # parameter explanation pending - min_speed=None, # parameter explanation pending - name=None, # parameter explanation pending - tos=None, # parameter explanation pending - traffic_profile_flags=None, # parameter explanation pending - traffic_profile_flags_mask=None, # parameter explanation pending - type=None, # parameter explanation pending + instance_count=None, # Number of connections per device + max_pdu=None, # Minimum PDU size + max_speed=None, # Opposite-Direction Speed in bps. + min_pdu=None, # Minimum PDU size + min_speed=None, # Opposite-Direction Speed in bps. + name=None, # Profile Name. + tos=None, # IP Type-of-Service + traffic_profile_flags=None, # Flags for this profile, none defined at this point. + traffic_profile_flags_mask=None, # Specify what flags to set. + type=None, # Profile type: See above.. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4820,8 +4821,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_traffic_profile_notes(self, - dut=None, # parameter explanation pending - text=None, # parameter explanation pending + dut=None, # Profile Name. + text=None, # [BLANK] will erase all, any other text will be appended to existing text. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -4953,26 +4954,26 @@ class LFJsonPost(LFCliBase): def post_add_vap(self, - ap_name=None, # parameter explanation pending - beacon=None, # parameter explanation pending - custom_cfg=None, # parameter explanation pending - dtim_period=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - frag_thresh=None, # parameter explanation pending - ieee80211w=None, # parameter explanation pending - key=None, # parameter explanation pending - mac=None, # parameter explanation pending - max_sta=None, # parameter explanation pending - mode=None, # parameter explanation pending - radio=None, # parameter explanation pending - rate=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - ssid=None, # parameter explanation pending - x_coord=None, # parameter explanation pending - y_coord=None, # parameter explanation pending - z_coord=None, # parameter explanation pending + ap_name=None, # Name for this Virtual AP, for example: vap0 + beacon=None, # The beacon interval, in 1kus (1.024 ms), default 100, range: 15..65535 + custom_cfg=None, # Custom hostapd config file, if you want to craft your own config. + dtim_period=None, # DTIM period, range 1..255. Default 2. + flags=None, # Flags for this interface (see above.) + flags_mask=None, # If set, only these flags will be considered. + frag_thresh=None, # UN-USED, Was Fragmentation threshold, which is now set with set_wifi_radio, use NA + ieee80211w=None, # Management Frame Protection: 0: disabled, 1: optional, 2: Required. + key=None, # Encryption key for this Virtual AP. Prepend with 0x for ascii-hex representation. + mac=None, # The MAC address, can also use parent-pattern in 5.3.8 and higher: xx:xx:xx:*:*:xx + max_sta=None, # Maximum number of Stations allowed to join this AP (1..2007) + mode=None, # WiFi mode: see table + radio=None, # Name of the physical radio interface, for example: wiphy0 + rate=None, # Max rate, see help for add_vsta + resource=None, # Resource number. + shelf=None, # Shelf number. + ssid=None, # SSID for this Virtual AP. + x_coord=None, # Floating point number. + y_coord=None, # Floating point number. + z_coord=None, # Floating point number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5155,16 +5156,16 @@ class LFJsonPost(LFCliBase): def post_add_venue(self, - description=None, # parameter explanation pending - freq_24=None, # parameter explanation pending - freq_5=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - venu_id=None, # parameter explanation pending - x1=None, # parameter explanation pending - x2=None, # parameter explanation pending - y1=None, # parameter explanation pending - y2=None, # parameter explanation pending + description=None, # User-supplied description, ie: Big City Ball Park; 47-characters max. + freq_24=None, # Frequency list for 2.4Ghz band, see above. + freq_5=None, # Frequency list for 5Ghz band, see above. + resource=None, # Resource number. + shelf=None, # Shelf number. + venu_id=None, # Number to uniquely identify this venue on this resource. + x1=None, # Floating point coordinate for lower-left corner. + x2=None, # Floating point coordinate for upper-right corner. + y1=None, # Floating point coordinate for lower-left corner. + y2=None, # Floating point coordinate for upper-right corner. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5199,12 +5200,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vlan(self, - old_name=None, # parameter explanation pending - port=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vid=None, # parameter explanation pending + old_name=None, # The temporary name, used for configuring un-discovered hardware. + port=None, # Port number of an existing Ethernet interface. + report_timer=None, # Report timer for this port, leave blank or use NA for defaults. + resource=None, # Resource number. + shelf=None, # Shelf number. + vid=None, # The VLAN-ID for this 802.1Q VLAN interface. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5235,23 +5236,23 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_voip_endp(self, - alias=None, # parameter explanation pending - auth_user_name=None, # parameter explanation pending - display_name=None, # parameter explanation pending - gateway_port=None, # parameter explanation pending - ip_addr=None, # parameter explanation pending - peer_phone_num=None, # parameter explanation pending - phone_num=None, # parameter explanation pending - port=None, # parameter explanation pending - proxy_passwd=None, # parameter explanation pending - resource=None, # parameter explanation pending - rtp_port=None, # parameter explanation pending - rx_sound_file=None, # parameter explanation pending - shelf=None, # parameter explanation pending - sip_gateway=None, # parameter explanation pending - tx_sound_file=None, # parameter explanation pending - vad_max_timer=None, # parameter explanation pending - vad_timer=None, # parameter explanation pending + alias=None, # Name of endpoint. + auth_user_name=None, # Use this field for authentication user name. AUTO or blank mean use phone number. + display_name=None, # User-Name to be displayed. Use AUTO to display phone number. + gateway_port=None, # IP Port for SIP gateway (defaults to 5060). + ip_addr=None, # Use this IP for local IP address. Useful when there are multiple IPs on a port. + peer_phone_num=None, # Use AUTO to use phone number of peer endpoint, otherwise specify a number: user[@host[:port]] + phone_num=None, # Phone number for Endpoint + port=None, # Port number or name. + proxy_passwd=None, # Password to be used when registering with proxy/gateway. + resource=None, # Resource number. + rtp_port=None, # RTP port to use for send and receive. + rx_sound_file=None, # File name to save received PCM data to. Will be in WAV format, or AUTO + shelf=None, # Shelf name/id. + sip_gateway=None, # SIP Gateway/Proxy Name, this is who to register with, or AUTO + tx_sound_file=None, # File name containing the sound sample we will be playing. + vad_max_timer=None, # How often should we force a packet, even if VAD is on. + vad_timer=None, # How much silence (milliseconds) before VAD is enabled. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5360,16 +5361,16 @@ class LFJsonPost(LFCliBase): def post_add_vr(self, - alias=None, # parameter explanation pending - flags=None, # parameter explanation pending - height=None, # parameter explanation pending - notes=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vr_id=None, # parameter explanation pending - width=None, # parameter explanation pending - x=None, # parameter explanation pending - y=None, # parameter explanation pending + alias=None, # Name of virtual router. + flags=None, # Virtual router flags, see above for definitions. + height=None, # Height to be used when drawn in the LANforge-GUI. + notes=None, # Notes for this Virtual Router. Put in quotes if the notes include white-space. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + vr_id=None, # Leave blank, use NA or 0xFFFF unless you are certain of the value you want to enter. + width=None, # Width to be used when drawn in the LANforge-GUI. + x=None, # X coordinate to be used when drawn in the LANforge-GUI. + y=None, # Y coordinate to be used when drawn in the LANforge-GUI. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5463,18 +5464,18 @@ class LFJsonPost(LFCliBase): def post_add_vr_bgp(self, - bgp_id=None, # parameter explanation pending - cluster_id=None, # parameter explanation pending - confed_id=None, # parameter explanation pending - flags=None, # parameter explanation pending - half_life=None, # parameter explanation pending - local_as=None, # parameter explanation pending - max_suppress=None, # parameter explanation pending - resource=None, # parameter explanation pending - reuse=None, # parameter explanation pending - shelf=None, # parameter explanation pending - suppress=None, # parameter explanation pending - vr_id=None, # parameter explanation pending + bgp_id=None, # BGP Identifier: IPv4 Address + cluster_id=None, # Cluster ID, IPv4 Address. Use NA if not clustering. + confed_id=None, # Confederation ID 1-65535. Use NA if not in a confederation. + flags=None, # Virtual router BGP flags, see above for definitions. + half_life=None, # Halflife in minutes for damping configuration. + local_as=None, # BGP Autonomous System number, 1-65535 + max_suppress=None, # Maximum hold down time in minutes for damping configuration. + resource=None, # Resource number. + reuse=None, # Route flag damping reuse threshold, in minutes. + shelf=None, # Shelf name/id. + suppress=None, # Route flag damping cutoff threshold, in minutes. + vr_id=None, # Name of virtual router. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5579,37 +5580,37 @@ class LFJsonPost(LFCliBase): def post_add_vrcx(self, - dhcp_dns=None, # parameter explanation pending - dhcp_dns6=None, # parameter explanation pending - dhcp_domain=None, # parameter explanation pending - dhcp_lease_time=None, # parameter explanation pending - dhcp_max=None, # parameter explanation pending - dhcp_max6=None, # parameter explanation pending - dhcp_min=None, # parameter explanation pending - dhcp_min6=None, # parameter explanation pending - flags=None, # parameter explanation pending - height=None, # parameter explanation pending - interface_cost=None, # parameter explanation pending - local_dev=None, # parameter explanation pending - local_dev_b=None, # parameter explanation pending - nexthop=None, # parameter explanation pending - ospf_area=None, # parameter explanation pending - remote_dev=None, # parameter explanation pending - remote_dev_b=None, # parameter explanation pending - resource=None, # parameter explanation pending - rip_metric=None, # parameter explanation pending - shelf=None, # parameter explanation pending - subnets=None, # parameter explanation pending - vr_name=None, # parameter explanation pending - vrrp_id=None, # parameter explanation pending - vrrp_interval=None, # parameter explanation pending - vrrp_ip=None, # parameter explanation pending - vrrp_ip_prefix=None, # parameter explanation pending - vrrp_priority=None, # parameter explanation pending - wanlink=None, # parameter explanation pending - width=None, # parameter explanation pending - x=None, # parameter explanation pending - y=None, # parameter explanation pending + dhcp_dns=None, # IP Address of DNS server. + dhcp_dns6=None, # IPv6 Address of DNS server. + dhcp_domain=None, # DHCP Domain name to serve. + dhcp_lease_time=None, # DHCP Lease time (in seconds) + dhcp_max=None, # Minimum IP address range to serve. + dhcp_max6=None, # Minimum IPv6 address to serve. + dhcp_min=None, # Minimum IP address range to serve. + dhcp_min6=None, # Minimum IPv6 address to serve. + flags=None, # Flags, specify if subnets 0-7 are in use, see above for others. + height=None, # Height to be used when drawn in the LANforge-GUI. + interface_cost=None, # If using OSPF, this sets the cost for this link (1-65535). + local_dev=None, # Name of port A, the local network device pair. + local_dev_b=None, # Name of port B for the local redirect device pair. + nexthop=None, # The next-hop to use when routing packets out this interface. + ospf_area=None, # If using OSPF, this sets the OSPF area for this interface. Default is 0.0.0.0. + remote_dev=None, # Name the remote network device. + remote_dev_b=None, # Name of port B for the remote network device. + resource=None, # Resource number. + rip_metric=None, # If using RIP, this determines the RIP metric (cost), (1-15, 15 is infinite). + shelf=None, # Shelf name/id. + subnets=None, # Subnets associated with this link, format: 1.1.1.1/24,1.1.2.1/16... + vr_name=None, # Virtual Router this endpoint belongs to. Use 'FREE_LIST' to add a stand-alone endpoint. + vrrp_id=None, # VRRP id, must be unique in this virtual router (1-255) + vrrp_interval=None, # VRRP broadcast message interval, in seconds (1-255) + vrrp_ip=None, # VRRP IPv4 address..ignored if not flagged for VRRP. + vrrp_ip_prefix=None, # Number of bits in subnet mask, ie 24 for 255.255.255.0 + vrrp_priority=None, # VRRP Priority (1-255, higher is more priority.) + wanlink=None, # The name of the WanLink that connects the two B ports. + width=None, # Width to be used when drawn in the LANforge-GUI. + x=None, # X coordinate to be used when drawn in the LANforge-GUI. + y=None, # Y coordinate to be used when drawn in the LANforge-GUI. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5665,12 +5666,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_add_vrcx2(self, - local_dev=None, # parameter explanation pending - nexthop6=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - subnets6=None, # parameter explanation pending - vr_name=None, # parameter explanation pending + local_dev=None, # Name of port A for the connection. + nexthop6=None, # The IPv6 next-hop to use when routing packets out this interface. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + subnets6=None, # IPv6 Subnets associated with this link, format: aaaa:bbbb::0/64,cccc:dddd:eeee::0/64... + vr_name=None, # Virtual Router this endpoint belongs to. Use 'FREE_LIST' to add a stand-alone endpoint. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5710,43 +5711,43 @@ class LFJsonPost(LFCliBase): def post_add_wl_endp(self, - alias=None, # parameter explanation pending - cpu_id=None, # parameter explanation pending - description=None, # parameter explanation pending - dest_ip=None, # parameter explanation pending - dest_ip_mask=None, # parameter explanation pending - drop_every_xth_pkt=None, # parameter explanation pending - drop_freq=None, # parameter explanation pending - dup_every_xth_pkt=None, # parameter explanation pending - dup_freq=None, # parameter explanation pending - extra_buffer=None, # parameter explanation pending - ignore_bandwidth=None, # parameter explanation pending - ignore_dup=None, # parameter explanation pending - ignore_latency=None, # parameter explanation pending - ignore_loss=None, # parameter explanation pending - jitter_freq=None, # parameter explanation pending - latency=None, # parameter explanation pending - max_drop_amt=None, # parameter explanation pending - max_jitter=None, # parameter explanation pending - max_lateness=None, # parameter explanation pending - max_rate=None, # parameter explanation pending - max_reorder_amt=None, # parameter explanation pending - min_drop_amt=None, # parameter explanation pending - min_reorder_amt=None, # parameter explanation pending - playback_capture=None, # parameter explanation pending - playback_capture_file=None, # parameter explanation pending - playback_loop=None, # parameter explanation pending - port=None, # parameter explanation pending - reorder_every_xth_pkt=None, # parameter explanation pending - reorder_freq=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - source_ip=None, # parameter explanation pending - source_ip_mask=None, # parameter explanation pending - speed=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending - wanlink=None, # parameter explanation pending - wle_flags=None, # parameter explanation pending + alias=None, # Name of WanPath. + cpu_id=None, # The CPU/thread that this process should run on (kernel-mode only). + description=None, # Description for this endpoint, put in single quotes if it contains spaces. + dest_ip=None, # Selection filter: Destination IP. + dest_ip_mask=None, # Selection filter: Destination IP MASK. + drop_every_xth_pkt=None, # YES to periodically drop every Xth pkt, NO to drop packets randomly. + drop_freq=None, # How often, out of 1,000,000 packets, should we purposefully drop a packet. + dup_every_xth_pkt=None, # YES to periodically duplicate every Xth pkt, NO to duplicate packets randomly. + dup_freq=None, # How often, out of 1,000,000 packets, should we purposefully duplicate a packet. + extra_buffer=None, # The extra amount of bytes to buffer before dropping pkts, in units of 1024, use -1 for AUTO. + ignore_bandwidth=None, # Should we ignore the bandwidth settings from the playback file? YES, NO, or NA. + ignore_dup=None, # Should we ignore the Duplicate Packet settings from the playback file? YES, NO, or NA. + ignore_latency=None, # Should we ignore the latency settings from the playback file? YES, NO, or NA. + ignore_loss=None, # Should we ignore the packet-loss settings from the playback file? YES, NO, or NA. + jitter_freq=None, # How often, out of 1,000,000 packets, should we apply random jitter. + latency=None, # The base latency added to all packets, in milliseconds (or add 'us' suffix for microseconds) + max_drop_amt=None, # Maximum amount of packets to drop in a row. Default is 1. + max_jitter=None, # The maximum jitter, in milliseconds (or add 'us' suffix for microseconds) + max_lateness=None, # Maximum amount of un-intentional delay before pkt is dropped. Default is AUTO + max_rate=None, # Maximum transmit rate (bps) for this WanLink. + max_reorder_amt=None, # Maximum amount of packets by which to reorder, Default is 10. + min_drop_amt=None, # Minimum amount of packets to drop in a row. Default is 1. + min_reorder_amt=None, # Minimum amount of packets by which to reorder, Default is 1. + playback_capture=None, # ON or OFF, should we play back a WAN capture file? + playback_capture_file=None, # Name of the WAN capture file to play back. + playback_loop=None, # Should we loop the playback file, YES or NO or NA. + port=None, # Port number. + reorder_every_xth_pkt=None, # YES to periodically reorder every Xth pkt, NO to reorder packets randomly. + reorder_freq=None, # How often, out of 1,000,000 packets, should we make a packet out of order. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + source_ip=None, # Selection filter: Source IP. + source_ip_mask=None, # Selection filter: Source IP MASK. + speed=None, # The maximum speed this WanLink will accept (bps). + test_mgr=None, # The name of the Test-Manager this WanPath is to use. Leave blank for no restrictions. + wanlink=None, # Name of WanLink to which we are adding this WanPath. + wle_flags=None, # WanLink Endpoint specific flags, see above. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5808,11 +5809,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_admin(self, - arg1=None, # parameter explanation pending - arg2=None, # parameter explanation pending - arg3=None, # parameter explanation pending - arg5=None, # parameter explanation pending - cmd=None, # parameter explanation pending + arg1=None, # Argument 1: xorp-port | scan-rslts-file | iface-name | iface-eid | rfgen-message | id + arg2=None, # Argument 2: scan key | message | angle | dest-radio + arg3=None, # Argument 3: noprobe | migrate-sta-mac-pattern + arg5=None, # Argument 4: table-speed + cmd=None, # Admin command: resync_clock|write_xorp_cfg|scan_complete|ifup_post_complete|flush_complete|req_migrate|rfgen|chamber|clean_logs debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5842,8 +5843,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_apply_vr_cfg(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # The number of the resource in question, or 'ALL'. + shelf=None, # The number of the shelf in question, or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5870,9 +5871,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_blink_attenuator(self, - resource=None, # parameter explanation pending - serno=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number. + serno=None, # Serial number for requested Attenuator, or 'all'. + shelf=None, # Shelf number, usually 1. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5961,10 +5962,10 @@ class LFJsonPost(LFCliBase): def post_c_show_ports(self, - port=None, # parameter explanation pending - probe_flags=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + port=None, # Port number, or 'all'. + probe_flags=None, # See above, add them together for multiple probings. Leave blank if you want stats only. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -5993,8 +5994,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_cancel_vr_cfg(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # The number of the resource in question, or 'ALL'. + shelf=None, # The number of the shelf in question, or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6021,7 +6022,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cd_counters(self, - cd_name=None, # parameter explanation pending + cd_name=None, # Name of Collision Domain, or 'all'. Null argument is same as 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6047,7 +6048,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_cx_counters(self, - cx_name=None, # parameter explanation pending + cx_name=None, # Name of Cross Connect, or 'all'. Null argument is same as 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6073,9 +6074,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_endp_counters(self, - endp_name=None, # parameter explanation pending - incr_seqno=None, # parameter explanation pending - just_latency=None, # parameter explanation pending + endp_name=None, # Name of Endpoint, or 'all'. Null argument is same as 'all'. + incr_seqno=None, # Enter 'YES' if you want the target to increment the cfg-seq-no. + just_latency=None, # Enter 'YES' if you only want to clear latency counters, and see above for RXGAP. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6103,7 +6104,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_group(self, - name=None, # parameter explanation pending + name=None, # The name of the test group. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6140,10 +6141,10 @@ class LFJsonPost(LFCliBase): def post_clear_port_counters(self, - extra=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + extra=None, # Clear something else instead: dhcp4_lease | dhcp6_lease | dhcp_leases + port=None, # The number of the port in question, or 'ALL'. + resource=None, # The number of the resource in question, or 'ALL'. + shelf=None, # The number of the shelf in question, or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6172,8 +6173,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_resource_counters(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # The number of the resource in question, or 'ALL'. + shelf=None, # The number of the shelf in question, or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6200,8 +6201,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_clear_wp_counters(self, - endp_name=None, # parameter explanation pending - wp_name=None, # parameter explanation pending + endp_name=None, # Name of WanLink Endpoint. + wp_name=None, # Name of WanPath to clear. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6228,9 +6229,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_create_client(self, - name=None, # parameter explanation pending - password=None, # parameter explanation pending - super_user=None, # parameter explanation pending + name=None, # A single name with no white-spaces (15 characters or less) + password=None, # Can be blank or 'NA' if no password is set, otherwise must be the password. Use IGNORE for no change. + super_user=None, # 1 If you want this user to have Administrative powers, 0 or blank otherwise. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6258,8 +6259,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_diag(self, - arg1=None, # parameter explanation pending - type=None, # parameter explanation pending + arg1=None, # Optional: Endpoint name to diag. + type=None, # Default (blank) is everything, options: alerts, license, counters, fds, clients, endpoints, shelf, iobuffer. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6286,9 +6287,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_discover(self, - disconnect=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + disconnect=None, # Set to 'disconnect' to force disconnect to remote resource process. + resource=None, # Resource ID. Use if discovering Attenuators. + shelf=None, # Shelf-ID, only used if discovering Attenuators. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6316,8 +6317,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_do_pesq(self, - endp_name=None, # parameter explanation pending - result_file_name=None, # parameter explanation pending + endp_name=None, # Name of Endpoint. + result_file_name=None, # The name of the file received by the endpoint. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6344,10 +6345,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_file(self, - card=None, # parameter explanation pending - cmd=None, # parameter explanation pending - filename=None, # parameter explanation pending - shelf=None, # parameter explanation pending + card=None, # Card ID + cmd=None, # Only 'Download' supported for now, 'Upload' reserved for future use. + filename=None, # File to transfer. + shelf=None, # Shelf ID debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6376,10 +6377,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_flash_attenuator(self, - filename=None, # parameter explanation pending - resource=None, # parameter explanation pending - serno=None, # parameter explanation pending - shelf=None, # parameter explanation pending + filename=None, # File to use when uploading to attenuator. + resource=None, # Resource number. + serno=None, # Serial number for requested Attenuator, or 'all'. + shelf=None, # Shelf number, usually 1. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6408,8 +6409,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getavglatency(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For AtoB, enter 'B', for BtoA, enter 'A'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6436,8 +6437,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxbps(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6464,8 +6465,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getinrxrate(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6492,8 +6493,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getintxrate(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6520,8 +6521,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getipadd(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6548,8 +6549,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmac(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6576,8 +6577,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getmask(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6604,8 +6605,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getpktdrops(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For AtoB, enter 'B', for BtoA, enter 'A'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6632,8 +6633,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxendperrpkts(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For AtoB, enter 'B', for BtoA, enter 'A'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6660,8 +6661,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxpkts(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6688,8 +6689,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_getrxporterrpkts(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For AtoB, enter 'B', for BtoA, enter 'A'. + cx=None, # Cross-connect name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6716,8 +6717,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gettxpkts(self, - aorb=None, # parameter explanation pending - cx=None, # parameter explanation pending + aorb=None, # For endpoint a, enter 'A', for endpoint b, enter 'B'. + cx=None, # Cross-connect or Test-Group name debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6744,7 +6745,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_gossip(self, - message=None, # parameter explanation pending + message=None, # Message to show to others currently logged on. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6770,7 +6771,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_help(self, - command=None, # parameter explanation pending + command=None, # The command to get help for. Can be 'all', or blank. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6796,10 +6797,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_init_wiser(self, - file_name=None, # parameter explanation pending - node_count=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + file_name=None, # The WISER file name for the desired emulation, or 'NA' for empty string. + node_count=None, # The number of WISER nodes for the desired emulation, or 'NA' for empty string. + resource=None, # The number of the resource in question. + shelf=None, # The number of the shelf in question. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6828,8 +6829,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_licenses(self, - popup=None, # parameter explanation pending - show_file=None, # parameter explanation pending + popup=None, # If 'popup', then cause a GUI popup msg, otherwise, just show text. + show_file=None, # If 'yes', then show the license file, not the parsed license information. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6856,11 +6857,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_load(self, - action=None, # parameter explanation pending - clean_chambers=None, # parameter explanation pending - clean_dut=None, # parameter explanation pending - clean_profiles=None, # parameter explanation pending - name=None, # parameter explanation pending + action=None, # Should be 'append' or 'overwrite'. + clean_chambers=None, # If yes, then Chambers will be cleaned up when overwrite is selected, otherwise they will be kept. + clean_dut=None, # If yes, then DUT will be cleaned up when overwrite is selected, otherwise they will be kept. + clean_profiles=None, # If yes, then clean all profiles when overwrite is selected, otherwise they will be kept. + name=None, # The name of the database to load. (DFLT is the default) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6961,8 +6962,8 @@ class LFJsonPost(LFCliBase): def post_log_level(self, - level=None, # parameter explanation pending - target=None, # parameter explanation pending + level=None, # Integer corresponding to the logging flags. + target=None, # Options: 'gnu' | [file-endp-name]. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -6989,7 +6990,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_log_msg(self, - message=None, # parameter explanation pending + message=None, # Message to log. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7015,8 +7016,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_login(self, - name=None, # parameter explanation pending - password=None, # parameter explanation pending + name=None, # A single name with no white-spaces (15 characters or less) + password=None, # Can be blank or 'NA' if no password is set, otherwise must be the password. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7067,9 +7068,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_cd(self, - collision_domain=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + collision_domain=None, # Name of the Collision Domain, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7097,9 +7098,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_channel_groups(self, - channel_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + channel_name=None, # Name of the channel, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7127,8 +7128,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_endpoints(self, - endpoint=None, # parameter explanation pending - extra=None, # parameter explanation pending + endpoint=None, # Name of endpoint, or 'all'. + extra=None, # See above. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7155,7 +7156,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_pesq(self, - endpoint=None, # parameter explanation pending + endpoint=None, # Name of endpoint, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7242,10 +7243,10 @@ class LFJsonPost(LFCliBase): def post_nc_show_ports(self, - port=None, # parameter explanation pending - probe_flags=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + port=None, # Port number, or 'all'. + probe_flags=None, # See above, add them together for multiple probings. Leave blank if you want stats only. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7274,9 +7275,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_ppp_links(self, - link_num=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + link_num=None, # Ppp-Link number of the span, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7304,9 +7305,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_spans(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span_number=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. + span_number=None, # Span-Number of the span, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7334,9 +7335,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vr(self, - resource=None, # parameter explanation pending - router=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + router=None, # Name of the Virtual Router, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7364,9 +7365,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_nc_show_vrcx(self, - cx_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + cx_name=None, # Name of the Virtual Router Connection, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7394,15 +7395,15 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_notify_dhcp(self, - cmd=None, # parameter explanation pending - netmask=None, # parameter explanation pending - new_dns=None, # parameter explanation pending - new_ip=None, # parameter explanation pending - new_ip6=None, # parameter explanation pending - new_mtu=None, # parameter explanation pending - new_router=None, # parameter explanation pending - port=None, # parameter explanation pending - reason=None, # parameter explanation pending + cmd=None, # set/down/timeout/info: What does DHCP want us to do? + netmask=None, # New subnet mask. + new_dns=None, # New DNS server(s) for use by this interface. + new_ip=None, # New IP address. + new_ip6=None, # New Global IPv6 address: ipv6/prefix + new_mtu=None, # New MTU. + new_router=None, # One or more default routers. LANforge will only use the first one. + port=None, # Interface name. + reason=None, # DHCP reason, informational mostly. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7436,9 +7437,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_port_reset_completed(self, - extra=None, # parameter explanation pending - port=None, # parameter explanation pending - type=None, # parameter explanation pending + extra=None, # IP for SECIP, blank for others. + port=None, # The port in question. + type=None, # SUNOS, NORMAL, or SECIP..let us know what kind of reset completed. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7466,10 +7467,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_port(self, - key=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + key=None, # Unique identifier for this request. Usually left blank.
+ port=None, # Port number or name + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7498,8 +7499,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_probe_ports(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7526,7 +7527,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_endp(self, - endp_name=None, # parameter explanation pending + endp_name=None, # Name of the endpoint, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7552,7 +7553,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_quiesce_group(self, - name=None, # parameter explanation pending + name=None, # The name of the test group, or 'all' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7602,8 +7603,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reboot_os(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or ALL. + shelf=None, # Shelf number, or ALL. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7630,11 +7631,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_report(self, - reporting_on=None, # parameter explanation pending - rpt_dir=None, # parameter explanation pending - save_endps=None, # parameter explanation pending - save_ports=None, # parameter explanation pending - save_resource=None, # parameter explanation pending + reporting_on=None, # Should we globally enable/disable reporting. (YES, NO or NA) + rpt_dir=None, # Directory in which reports should be saved. + save_endps=None, # Should we save endpoint reports or not. (YES, NO or NA) + save_ports=None, # Should we save Port reports or not. (YES, NO or NA) + save_resource=None, # Should we save Resource reports or not. (YES, NO or NA) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7675,11 +7676,11 @@ class LFJsonPost(LFCliBase): def post_reset_port(self, - port=None, # parameter explanation pending - pre_ifdown=None, # parameter explanation pending - reset_ospf=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + port=None, # Port number to reset, or ALL. + pre_ifdown=None, # See above. Leave blank or use NA if unsure. + reset_ospf=None, # If set to 'NO' or 'NA', then OSPF will not be updated. Otherwise, it will be updated. + resource=None, # Resource number, or ALL. + shelf=None, # Shelf number, or ALL. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7709,9 +7710,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_reset_serial_span(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span=None, # parameter explanation pending + resource=None, # Resource (machine) number. + shelf=None, # Shelf number + span=None, # Serial-Span number to reset. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7739,9 +7740,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_attenuator(self, - resource=None, # parameter explanation pending - serno=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number + serno=None, # Serial number for requested Attenuator. + shelf=None, # Shelf number, usually 1 debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7769,7 +7770,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd(self, - cd=None, # parameter explanation pending + cd=None, # Name of Collision Domain. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7795,8 +7796,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_endp(self, - cd=None, # parameter explanation pending - endp=None, # parameter explanation pending + cd=None, # Name of Collision Domain. + endp=None, # Endpoint name/id. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7823,8 +7824,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cd_vr(self, - cd=None, # parameter explanation pending - endp=None, # parameter explanation pending + cd=None, # Name of Collision Domain. + endp=None, # Virtual-Router name/id. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7851,7 +7852,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber(self, - chamber=None, # parameter explanation pending + chamber=None, # Chamber name, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7877,8 +7878,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_chamber_path(self, - chamber=None, # parameter explanation pending - path=None, # parameter explanation pending + chamber=None, # Chamber Name. + path=None, # Path Name, use 'ALL' to delete all paths. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7905,9 +7906,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_channel_group(self, - channel_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + channel_name=None, # Name of the channel, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7935,8 +7936,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_client(self, - client_name=None, # parameter explanation pending - client_password=None, # parameter explanation pending + client_name=None, # Name of the client profile you wish to remove. + client_password=None, # Client password. Not required if we are super-user. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7963,8 +7964,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_cx(self, - cx_name=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + cx_name=None, # Name of the cross-connect, or 'all'. + test_mgr=None, # Name of test-mgr, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -7991,7 +7992,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_db(self, - db_name=None, # parameter explanation pending + db_name=None, # Name of the database to delete. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8017,7 +8018,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_dut(self, - shelf=None, # parameter explanation pending + shelf=None, # DUT name, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8043,7 +8044,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_endp(self, - endp_name=None, # parameter explanation pending + endp_name=None, # Name of the endpoint, or 'YES_ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8069,7 +8070,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_event(self, - event_id=None, # parameter explanation pending + event_id=None, # Numeric event-id, or 'all' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8095,7 +8096,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_group(self, - name=None, # parameter explanation pending + name=None, # The name of the test group. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8121,9 +8122,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_ppp_link(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - unit_num=None, # parameter explanation pending + resource=None, # Resource number that holds this PppLink. + shelf=None, # Name/id of the shelf. + unit_num=None, # Unit-Number for the PppLink to be deleted. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8151,7 +8152,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_profile(self, - name=None, # parameter explanation pending + name=None, # Profile name, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8177,8 +8178,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_resource(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8205,8 +8206,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_rfgen(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number + shelf=None, # Shelf number, usually 1 debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8233,10 +8234,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_sec_ip(self, - ip_list=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + ip_list=None, # IP1/prefix,IP2/prefix,...IPZ/prefix, or ALL + port=None, # Name of network device (Port) from which these IPs will be removed. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8265,9 +8266,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_span(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span_num=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. + span_num=None, # Span-Number of the channel, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8295,7 +8296,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_test_mgr(self, - test_mgr=None, # parameter explanation pending + test_mgr=None, # Name of the test manager to be removed. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8321,8 +8322,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_text_blob(self, - name=None, # parameter explanation pending - type=None, # parameter explanation pending + name=None, # Text Blob Name, or 'ALL' + type=None, # Text Blob type, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8349,8 +8350,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_tgcx(self, - cxname=None, # parameter explanation pending - tgname=None, # parameter explanation pending + cxname=None, # The name of the CX. + tgname=None, # The name of the test group. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8377,8 +8378,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_threshold(self, - endp=None, # parameter explanation pending - thresh_id=None, # parameter explanation pending + endp=None, # Endpoint name or ID. + thresh_id=None, # Threshold ID to remove. Use 'all' to remove all. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8405,7 +8406,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_traffic_profile(self, - name=None, # parameter explanation pending + name=None, # Profile name, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8431,9 +8432,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_venue(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - venu_id=None, # parameter explanation pending + resource=None, # Resource number, or 'ALL' + shelf=None, # Shelf number. + venu_id=None, # Number to uniquely identify this venue on this resource, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8461,9 +8462,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vlan(self, - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + port=None, # Port number or name of the virtual interface. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8491,9 +8492,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vr(self, - resource=None, # parameter explanation pending - router_name=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + router_name=None, # Virtual Router name, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8521,11 +8522,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_vrcx(self, - connection_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vr_id=None, # parameter explanation pending - vrcx_only=None, # parameter explanation pending + connection_name=None, # Virtual Router Connection name, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. + vr_id=None, # If not removing from the free-list, then supply the virtual-router name/ID here. Leave blank or use NA for free-list. + vrcx_only=None, # If we should NOT delete underlying auto-created objects, enter 'vrcx_only' here, otherwise leave blank or use NA. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8555,8 +8556,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rm_wanpath(self, - endp_name=None, # parameter explanation pending - wp_name=None, # parameter explanation pending + endp_name=None, # Name of the endpoint. + wp_name=None, # Name of the wanpath. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8583,13 +8584,13 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_rpt_script(self, - endp=None, # parameter explanation pending - flags=None, # parameter explanation pending - group_action=None, # parameter explanation pending - loop_count=None, # parameter explanation pending - name=None, # parameter explanation pending - private=None, # parameter explanation pending - type=None, # parameter explanation pending + endp=None, # Endpoint name or ID. + flags=None, # See above for description of the defined flags. + group_action=None, # All or Sequential. + loop_count=None, # How many times to loop before stopping (0 is infinite). + name=None, # Script name. + private=None, # Private encoding for the particular script. + type=None, # One of: NONE, Script2544, ScriptHunt, ScriptWL debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8632,11 +8633,11 @@ class LFJsonPost(LFCliBase): def post_scan_wifi(self, - extra=None, # parameter explanation pending - key=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + extra=None, # Extra arguments to the scan script, see above. + key=None, # Unique identifier for this request. Usually left blank. + port=None, # Port number or name of the virtual interface. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8726,25 +8727,25 @@ class LFJsonPost(LFCliBase): def post_set_arm_info(self, - arm_flags=None, # parameter explanation pending - burst=None, # parameter explanation pending - dst_mac=None, # parameter explanation pending - dst_mac_count=None, # parameter explanation pending - ip_dst_max=None, # parameter explanation pending - ip_dst_min=None, # parameter explanation pending - ip_src_max=None, # parameter explanation pending - ip_src_min=None, # parameter explanation pending - max_pkt_size=None, # parameter explanation pending - min_pkt_size=None, # parameter explanation pending - multi_pkts=None, # parameter explanation pending - name=None, # parameter explanation pending - pkts_to_send=None, # parameter explanation pending - src_mac=None, # parameter explanation pending - src_mac_count=None, # parameter explanation pending - udp_dst_max=None, # parameter explanation pending - udp_dst_min=None, # parameter explanation pending - udp_src_max=None, # parameter explanation pending - udp_src_min=None, # parameter explanation pending + arm_flags=None, # Armageddon-related flags, see above for details. + burst=None, # Burst amount, can significantly improve throughput with some modern drivers, similar to 'multi_pkts', and uses the 'xmit_more' linux skb option. + dst_mac=None, # The destination MAC address. + dst_mac_count=None, # How many destination MACs to iterate through. + ip_dst_max=None, # Maximum destination IP address to use. + ip_dst_min=None, # Minimum destination IP address to use. + ip_src_max=None, # Maximum source IP address to use. + ip_src_min=None, # Minimum source IP address to use. + max_pkt_size=None, # Maximum packet size, including all Ethernet headers (but not CRC). + min_pkt_size=None, # Minimum packet size, including all Ethernet headers (but not CRC). + multi_pkts=None, # The number of identical packets to send before creating a new one. + name=None, # Name of the Endpoint we are setting. + pkts_to_send=None, # The number of packets to send. Set to zero for infinite. + src_mac=None, # The source MAC address. + src_mac_count=None, # How many source MACs to iterate through. + udp_dst_max=None, # Minimum destination UDP port. + udp_dst_min=None, # Minimum destination UDP port. + udp_src_max=None, # Maximum source UDP port. + udp_src_min=None, # Minimum source UDP port. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8788,16 +8789,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_attenuator(self, - atten_idx=None, # parameter explanation pending - mode=None, # parameter explanation pending - pulse_count=None, # parameter explanation pending - pulse_interval_ms=None, # parameter explanation pending - pulse_time_ms=None, # parameter explanation pending - pulse_width_us5=None, # parameter explanation pending - resource=None, # parameter explanation pending - serno=None, # parameter explanation pending - shelf=None, # parameter explanation pending - val=None, # parameter explanation pending + atten_idx=None, # Attenuator index, or 'all'. + mode=None, # 0 == normal attenuator, 1 == pulse mode (API Tech 4205A modules directly connected via USB only) + pulse_count=None, # Number of pulses (0-255) + pulse_interval_ms=None, # Time between pulses, in mili-seconds (0-60000). + pulse_time_ms=None, # Time interval between pulse groups in miliseconds (1-60000) + pulse_width_us5=None, # Pulse width in units of 1/2 micro second. So, if you want 1.5us, use value 3 (0-60000) + resource=None, # Resource number. + serno=None, # Serial number for requested Attenuator, or 'all'. + shelf=None, # Shelf number, usually 1. + val=None, # Requested attenution in 1/10ths of dB (ddB). debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8832,12 +8833,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_chamber(self, - chamber=None, # parameter explanation pending - cur_rotation=None, # parameter explanation pending - position=None, # parameter explanation pending - speed_rpm=None, # parameter explanation pending - tilt=None, # parameter explanation pending - turntable=None, # parameter explanation pending + chamber=None, # Chamber name + cur_rotation=None, # Primarily used to store the last known rotation for turntables that do not report absolute position. Use NA or leave blank if unsure. + position=None, # Absolute position in degrees. + speed_rpm=None, # Speed in rpm (floating point number is accepted + tilt=None, # Absolute tilt in degrees. + turntable=None, # Turn-table address, for instance: 192.168.1.22:3001 debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8868,10 +8869,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_cx_report_timer(self, - cx_name=None, # parameter explanation pending - cxonly=None, # parameter explanation pending - milliseconds=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + cx_name=None, # Name of cross-connect, or 'all'. + cxonly=None, # If you want to set the timer for ONLY the CX, and not + milliseconds=None, # Report timer length in milliseconds. + test_mgr=None, # Name of the test manager, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8913,9 +8914,9 @@ class LFJsonPost(LFCliBase): def post_set_cx_state(self, - cx_name=None, # parameter explanation pending - cx_state=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + cx_name=None, # Name of the cross-connect, or 'all'. + cx_state=None, # One of: RUNNING, SWITCH, QUIESCE, STOPPED, or DELETED. + test_mgr=None, # Name of the test-manager, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8943,11 +8944,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_addr(self, - ip=None, # parameter explanation pending - mac=None, # parameter explanation pending - max_port=None, # parameter explanation pending - min_port=None, # parameter explanation pending - name=None, # parameter explanation pending + ip=None, # The IP Address. Used for TCP/IP and UDP/IP protocols. + mac=None, # The MAC address. Only needed for LANforge protocol Endpoints. + max_port=None, # The Maximum IP Port. Used for TCP/IP and UDP/IP protocols. + min_port=None, # The Minimum IP Port. Used for TCP/IP and UDP/IP protocols. + name=None, # The name of the endpoint we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -8977,23 +8978,23 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_details(self, - conn_timeout=None, # parameter explanation pending - dst_mac=None, # parameter explanation pending - max_conn_timer=None, # parameter explanation pending - max_ip_port=None, # parameter explanation pending - max_reconn_pause=None, # parameter explanation pending - mcast_src_ip=None, # parameter explanation pending - mcast_src_port=None, # parameter explanation pending - min_conn_timer=None, # parameter explanation pending - min_reconn_pause=None, # parameter explanation pending - name=None, # parameter explanation pending - pkts_to_send=None, # parameter explanation pending - rcvbuf_size=None, # parameter explanation pending - sndbuf_size=None, # parameter explanation pending - tcp_delack_segs=None, # parameter explanation pending - tcp_max_delack=None, # parameter explanation pending - tcp_min_delack=None, # parameter explanation pending - tcp_mss=None, # parameter explanation pending + conn_timeout=None, # For TCP, the max time in miliseconds to wait for connection to establish. + dst_mac=None, # Destination MAC address, used for custom Ethernet replays. + max_conn_timer=None, # The maximum duration (in ms) this connection should run before re-establishing. + max_ip_port=None, # The maximum IP Port value. (The value for min ip port is set through the add_endp/ip_port parameter.) If greater than min, each connection will use a random value between min and max. + max_reconn_pause=None, # The maximum time between re-connects, in ms. + mcast_src_ip=None, # Multicast source address (used in SSM mode, multicast endpoints only) + mcast_src_port=None, # Multicast source address (used in SSM mode, multicast endpoints only) + min_conn_timer=None, # The minimum duration (in ms) this connection should run before re-establishing. + min_reconn_pause=None, # The minimum time between re-connects, in ms. + name=None, # The name of the endpoint we are configuring. + pkts_to_send=None, # Number of packets to send before stopping. 0 means infinite. + rcvbuf_size=None, # The receive buffer (window) size. Zero for AUTO + sndbuf_size=None, # The sending buffer (window) size. Zero for AUTO + tcp_delack_segs=None, # NA: No longer supported. + tcp_max_delack=None, # NA: No longer supported. + tcp_min_delack=None, # NA: No longer supported. + tcp_mss=None, # TCP Maximum Segment Size, affects packet size on the wire (88 - 32767). debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9035,9 +9036,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_file(self, - file=None, # parameter explanation pending - name=None, # parameter explanation pending - playback=None, # parameter explanation pending + file=None, # The file name to read the playback packets from. + name=None, # The name of the endpoint we are configuring. + playback=None, # Should we playback the capture or not? ON or OFF. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9085,9 +9086,10 @@ class LFJsonPost(LFCliBase): def post_set_endp_flag(self, - flag=None, # parameter explanation pending - name=None, # parameter explanation pending - val=None, # parameter explanation pending + flag=None, # The name of the flag. + name=None, # The name of the endpoint we are configuring. + val=None, # Either 1 (for on), or 0 (for off). + debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9134,9 +9136,9 @@ class LFJsonPost(LFCliBase): def post_set_endp_payload(self, - name=None, # parameter explanation pending - payload=None, # parameter explanation pending - payload_type=None, # parameter explanation pending + name=None, # The name of the endpoint we are configuring. + payload=None, # For custom payloads, enter the payload in hex, up to 2048 bytes. Unescaped Value + payload_type=None, # The payload type. See help for add_endp. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9164,11 +9166,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_pld_bounds(self, - is_random=None, # parameter explanation pending - max_pld_size=None, # parameter explanation pending - min_pld_size=None, # parameter explanation pending - name=None, # parameter explanation pending - use_checksum=None, # parameter explanation pending + is_random=None, # YES if random, anything else for NO. + max_pld_size=None, # The maximum payload size, in bytes. + min_pld_size=None, # The minimum payload size, in bytes. + name=None, # The name of the endpoint we are configuring. + use_checksum=None, # YES if use checksum on payload, anything else for NO. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9198,10 +9200,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_proxy(self, - enabled=None, # parameter explanation pending - endp_name=None, # parameter explanation pending - proxy_ip=None, # parameter explanation pending - proxy_ip_port=None, # parameter explanation pending + enabled=None, # YES or NO to enable or disable proxying. + endp_name=None, # Name of endpoint. + proxy_ip=None, # Proxy IP Address. + proxy_ip_port=None, # Proxy IP Port. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9230,8 +9232,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_quiesce(self, - name=None, # parameter explanation pending - quiesce=None, # parameter explanation pending + name=None, # The name of the endpoint we are configuring. + quiesce=None, # The number of seconds to quiesce this endpoint when told to quiesce. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9258,8 +9260,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_report_timer(self, - endp_name=None, # parameter explanation pending - milliseconds=None, # parameter explanation pending + endp_name=None, # Name of endpoint. + milliseconds=None, # Report timer length in milliseconds. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9298,9 +9300,9 @@ class LFJsonPost(LFCliBase): def post_set_endp_tos(self, - name=None, # parameter explanation pending - priority=None, # parameter explanation pending - tos=None, # parameter explanation pending + name=None, # The name of the endpoint we are configuring. + priority=None, # The socket priority, can be any positive number. + tos=None, # The Type of Service, can be HEX, see above. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9328,10 +9330,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_endp_tx_bounds(self, - is_bursty=None, # parameter explanation pending - max_tx_rate=None, # parameter explanation pending - min_tx_rate=None, # parameter explanation pending - name=None, # parameter explanation pending + is_bursty=None, # YES if bursty, anything else for NO. + max_tx_rate=None, # The maximum transmit rate, in bits per second (bps). + min_tx_rate=None, # The minimum transmit rate, in bits per second (bps). + name=None, # The name of the endpoint we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9571,13 +9573,13 @@ class LFJsonPost(LFCliBase): def post_set_event_interest(self, - ei_flags=None, # parameter explanation pending - event_cnt=None, # parameter explanation pending - events1=None, # parameter explanation pending - events2=None, # parameter explanation pending - events3=None, # parameter explanation pending - events4=None, # parameter explanation pending - var1=None, # parameter explanation pending + ei_flags=None, # Event Interest flags, see above. + event_cnt=None, # Maximum number of events to store. + events1=None, # See description for possible values. + events2=None, # See description for possible values. + events3=None, # See description for possible values. + events4=None, # See description for possible values. + var1=None, # Currently un-used. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9652,8 +9654,8 @@ class LFJsonPost(LFCliBase): def post_set_event_priority(self, - event=None, # parameter explanation pending - priority=None, # parameter explanation pending + event=None, # Number or name for the event, see above. + priority=None, # Number or name for the priority. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9680,16 +9682,16 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_fe_info(self, - directory=None, # parameter explanation pending - io_direction=None, # parameter explanation pending - max_file_size=None, # parameter explanation pending - max_rw_sz=None, # parameter explanation pending - min_file_size=None, # parameter explanation pending - min_rw_sz=None, # parameter explanation pending - name=None, # parameter explanation pending - num_files=None, # parameter explanation pending - prefix=None, # parameter explanation pending - quiesce_after_files=None, # parameter explanation pending + directory=None, # The directory to read/write in. Absolute path suggested. + io_direction=None, # Should we be reading or writing: options: read, write + max_file_size=None, # The maximum file size, in bytes. + max_rw_sz=None, # Maximum read/write size, in bytes. + min_file_size=None, # The minimum file size, in bytes. + min_rw_sz=None, # Minimum read/write size, in bytes. + name=None, # The name of the file endpoint we are configuring. + num_files=None, # Number of files to create when writing. + prefix=None, # The prefix of the file(s) to read/write. + quiesce_after_files=None, # If non-zero, quiesce test after this many files have been read/written. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9738,9 +9740,10 @@ class LFJsonPost(LFCliBase): def post_set_flag(self, - client=None, # parameter explanation pending - flag=None, # parameter explanation pending - val=None, # parameter explanation pending + client=None, # Specify the user, if it is not the current user. Requires admin privileges. + flag=None, # The name of the flag. + val=None, # Either 1 (for on), or 0 (for off). + debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9768,8 +9771,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gen_cmd(self, - command=None, # parameter explanation pending - name=None, # parameter explanation pending + command=None, # The rest of the command line arguments. Unescaped Value + name=None, # The name of the file endpoint we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9796,13 +9799,13 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_gps_info(self, - altitude=None, # parameter explanation pending - ew=None, # parameter explanation pending - lattitude=None, # parameter explanation pending - longitude=None, # parameter explanation pending - ns=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + altitude=None, # Altitude, assumes units are Meters. + ew=None, # East or west (Longitude). + lattitude=None, # The lattitude, as read from a GPS device. + longitude=None, # The longitude, as ready from a GPS device. + ns=None, # North or South (Latitude). + resource=None, # Resource number for the port to be modified. + shelf=None, # Shelf number for the port to be modified, or SELF. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9834,11 +9837,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ifup_script(self, - flags=None, # parameter explanation pending - port=None, # parameter explanation pending - post_ifup_script=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + flags=None, # Currently un-defined, use NA + port=None, # WiFi interface name or number. + post_ifup_script=None, # Script name with optional args, will run after interface comes up and gets IP. Unescaped Value + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9868,7 +9871,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_license(self, - licenses=None, # parameter explanation pending + licenses=None, # License keys all appended into a single line. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9894,11 +9897,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_mc_endp(self, - mcast_dest_port=None, # parameter explanation pending - mcast_group=None, # parameter explanation pending - name=None, # parameter explanation pending - rcv_mcast=None, # parameter explanation pending - ttl=None, # parameter explanation pending + mcast_dest_port=None, # Multicast destination IP Port, for example: 55000 + mcast_group=None, # Multicast group IP, ie: 224.1.1.2 IPv6 supported as well. + name=None, # The name of the endpoint we are configuring. + rcv_mcast=None, # Should we attempt to receive? Values: Yes or No + ttl=None, # Time to live for the multicast packets generated. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9928,9 +9931,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_password(self, - client=None, # parameter explanation pending - new_password=None, # parameter explanation pending - old_password=None, # parameter explanation pending + client=None, # Specify the client. If left blank, will use current client. + new_password=None, # New password, or 'NA' for blank password. + old_password=None, # Old password, or 'NA' for blank password. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -9958,7 +9961,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_poll_mode(self, - mode=None, # parameter explanation pending + mode=None, # 'polling' or 'push'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10317,43 +10320,43 @@ class LFJsonPost(LFCliBase): def post_set_port(self, - alias=None, # parameter explanation pending - br_aging_time=None, # parameter explanation pending - br_forwarding_delay=None, # parameter explanation pending - br_hello_time=None, # parameter explanation pending - br_max_age=None, # parameter explanation pending - br_port_cost=None, # parameter explanation pending - br_port_priority=None, # parameter explanation pending - br_priority=None, # parameter explanation pending - bypass_wdt=None, # parameter explanation pending - cmd_flags=None, # parameter explanation pending - cpu_mask=None, # parameter explanation pending - current_flags=None, # parameter explanation pending - current_flags_msk=None, # parameter explanation pending - dhcp_client_id=None, # parameter explanation pending - dhcp_hostname=None, # parameter explanation pending - dhcp_vendor_id=None, # parameter explanation pending - dns_servers=None, # parameter explanation pending - flags2=None, # parameter explanation pending - gateway=None, # parameter explanation pending - interest=None, # parameter explanation pending - ip_addr=None, # parameter explanation pending - ipsec_concentrator=None, # parameter explanation pending - ipsec_local_id=None, # parameter explanation pending - ipsec_passwd=None, # parameter explanation pending - ipsec_remote_id=None, # parameter explanation pending - ipv6_addr_global=None, # parameter explanation pending - ipv6_addr_link=None, # parameter explanation pending - ipv6_dflt_gw=None, # parameter explanation pending - mac=None, # parameter explanation pending - mtu=None, # parameter explanation pending - netmask=None, # parameter explanation pending - port=None, # parameter explanation pending - report_timer=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - sta_br_id=None, # parameter explanation pending - tx_queue_len=None, # parameter explanation pending + alias=None, # A user-defined name for this interface. Can be BLANK or NA. + br_aging_time=None, # MAC aging time, in seconds, 32-bit number (or peer IP for GRE). + br_forwarding_delay=None, # How long to wait until the bridge will start forwarding packets. + br_hello_time=None, # How often does the bridge send out STP hello packets. + br_max_age=None, # How long until STP considers a non-responsive bridge dead. + br_port_cost=None, # STP Port cost for a port (this applies only to NON-BRIDGE interfaces). + br_port_priority=None, # STP Port priority for a port (this applies only to NON-BRIDGE interfaces). + br_priority=None, # Bridge priority, 16-bit number. + bypass_wdt=None, # Watch Dog Timer (in seconds) for this port. Zero (0) to disable. + cmd_flags=None, # Command Flags: See above, or NA. + cpu_mask=None, # CPU Mask for CPUs that should service this interface. Zero is don't set (let OS make the decision). This value will be applied to the proper /proc/irq/[irq-num]/smp_affinity file by the pin_irq.pl script. + current_flags=None, # See above, or NA. + current_flags_msk=None, # This sets 'interest' for flags 'Enable RADIUS service' and higher. See above, or NA. + dhcp_client_id=None, # Optional string of up to 63 bytes in length to be passed to the dhclient process. See above. + dhcp_hostname=None, # Optional string of up to 63 bytes in length to be passed to the dhclient process. Option 12, see above. + dhcp_vendor_id=None, # Optional string of up to 63 bytes in length to be passed to the dhclient process. See above. + dns_servers=None, # DNS servers for use by traffic on this port, comma-separated list, BLANK means zero-length string. + flags2=None, # Bridge & other flags, see above. + gateway=None, # IP address of the gateway device - used for IP routing, or NA. + interest=None, # Which things are we really interested in setting. Can over-ride defaults based on the other arguments. + ip_addr=None, # IP address for the port, or NA. + ipsec_concentrator=None, # IP Address of IPSec concentrator. + ipsec_local_id=None, # Local Identifier for this IPSec tunnel. + ipsec_passwd=None, # Password for IPSec, for pubkey, use: pubkey:[pem-file-name], for instance: pubkey:station.pem + ipsec_remote_id=None, # Remote Identifier for this IPSec tunnel. + ipv6_addr_global=None, # Global scoped IPv6 address. + ipv6_addr_link=None, # Link scoped IPv6 address. + ipv6_dflt_gw=None, # IPv6 default gateway. + mac=None, # MAC address to set this port to, or leave blank to not set it, or NA. + mtu=None, # Maximum Transmit Unit (MTU) for this interface. Can be blank or NA. + netmask=None, # Netmask which this port should use, or NA. + port=None, # Port number for the port to be modified. + report_timer=None, # How often, in milliseconds, should we poll stats on this interface? + resource=None, # Resource number for the port to be modified. + shelf=None, # Shelf number for the port to be modified. + sta_br_id=None, # WiFi STAtion bridge ID. Zero means none. + tx_queue_len=None, # Transmit Queue Length for this interface. Can be blank or NA. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10415,11 +10418,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_port_alias(self, - alias=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vport=None, # parameter explanation pending + alias=None, # New alias to assign to this virtual interface. + port=None, # Physical Port identifier that owns the virtual interface. + resource=None, # Resource number for the port to be modified. + shelf=None, # Shelf number for the port to be modified. + vport=None, # Virtual port identifier. MAC for MAC-VLANs, VLAN-ID for 802.1Q vlans. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10449,10 +10452,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_ppp_link_state(self, - link=None, # parameter explanation pending - ppp_state=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + link=None, # Unit Number of the PPP Link, or 'all'. + ppp_state=None, # One of: RUNNING, STOPPED, or DELETED. + resource=None, # Number of the Resource, or 'all'. + shelf=None, # Name of the Shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10490,17 +10493,17 @@ class LFJsonPost(LFCliBase): def post_set_resource(self, - device_profiles=None, # parameter explanation pending - max_helper_count=None, # parameter explanation pending - max_staged_bringup=None, # parameter explanation pending - max_station_bringup=None, # parameter explanation pending - max_trying_ifup=None, # parameter explanation pending - resource=None, # parameter explanation pending - resource_flags=None, # parameter explanation pending - resource_flags_mask=None, # parameter explanation pending - shelf=None, # parameter explanation pending - top_left_x=None, # parameter explanation pending - top_left_y=None, # parameter explanation pending + device_profiles=None, # List of profiles, see above + max_helper_count=None, # Maximum number of helper traffic generation processes. 0 means CPU-core-count (AUTO). + max_staged_bringup=None, # Maximum amount of interfaces attempting to come up at once. Default is 50 + max_station_bringup=None, # Maximum amount of stations to bring up per radio per tick. Default is 12. + max_trying_ifup=None, # Maximum amount of interfaces running the network config 'ifup' logic. Default is 15 + resource=None, # Number of the Resource, or all. + resource_flags=None, # System wide flags, often requires a reboot for changes to take effect. + resource_flags_mask=None, # What flags to change. If unset, default is all. + shelf=None, # Name of the Shelf, or all. + top_left_x=None, # X Location for Chamber View. + top_left_y=None, # X Location for Chamber View. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10592,19 +10595,19 @@ class LFJsonPost(LFCliBase): def post_set_rfgen(self, - bb_gain=None, # parameter explanation pending - freq_khz=None, # parameter explanation pending - gain=None, # parameter explanation pending - id=None, # parameter explanation pending - if_gain=None, # parameter explanation pending - pulse_count=None, # parameter explanation pending - pulse_interval_us=None, # parameter explanation pending - pulse_width_us=None, # parameter explanation pending - resource=None, # parameter explanation pending - rfgen_flags=None, # parameter explanation pending - rfgen_flags_mask=None, # parameter explanation pending - shelf=None, # parameter explanation pending - sweep_time_ms=None, # parameter explanation pending + bb_gain=None, # RX Gain, 0 - 62 in 2dB steps + freq_khz=None, # Center frequency in Khz + gain=None, # Main TX/RX Amp, 0 or 14 (dB), default is 14 + id=None, # RF Generator ID, not used at this time, enter 'NA' or 0. + if_gain=None, # Fine-tune TX/RX Gain, 0 - 40 dB + pulse_count=None, # Number of pulses (0-255) + pulse_interval_us=None, # Time between pulses, in micro-seconds. + pulse_width_us=None, # Requested pulse width, units are in micro-seconds. + resource=None, # Resource number. + rfgen_flags=None, # RF Generator flags, see above. + rfgen_flags_mask=None, # Mask of what flags to set, see above. + shelf=None, # Shelf number, usually 1. + sweep_time_ms=None, # Time interval between pulse groups in miliseconds debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10726,13 +10729,13 @@ class LFJsonPost(LFCliBase): def post_set_script(self, - endp=None, # parameter explanation pending - flags=None, # parameter explanation pending - group_action=None, # parameter explanation pending - loop_count=None, # parameter explanation pending - name=None, # parameter explanation pending - private=None, # parameter explanation pending - type=None, # parameter explanation pending + endp=None, # Endpoint, Test Group or Attenuator name or ID. + flags=None, # See above for description of the defined flags. + group_action=None, # How to handle group script operations: ALL, Sequential + loop_count=None, # How many times to loop before stopping (0 is infinite). + name=None, # Script name. + private=None, # Private encoding for the particular script. + type=None, # One of: NONE, Script2544, ScriptHunt, ScriptWL, ScriptAtten debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10764,10 +10767,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_sec_ip(self, - ip_list=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + ip_list=None, # IP1/prefix,IP2/prefix,...IPZ/prefix. + port=None, # Name of network device (Port) to which these IPs will be added. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10796,24 +10799,24 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_voip_info(self, - codec=None, # parameter explanation pending - first_call_delay=None, # parameter explanation pending - jitter_buffer_sz=None, # parameter explanation pending - local_sip_port=None, # parameter explanation pending - loop_call_count=None, # parameter explanation pending - loop_wavefile_count=None, # parameter explanation pending - max_call_duration=None, # parameter explanation pending - max_inter_call_gap=None, # parameter explanation pending - messaging_protocol=None, # parameter explanation pending - min_call_duration=None, # parameter explanation pending - min_inter_call_gap=None, # parameter explanation pending - name=None, # parameter explanation pending - pesq_server_ip=None, # parameter explanation pending - pesq_server_passwd=None, # parameter explanation pending - pesq_server_port=None, # parameter explanation pending - reg_expire_timer=None, # parameter explanation pending - ringing_timer=None, # parameter explanation pending - sound_dev=None, # parameter explanation pending + codec=None, # Codec to use for the voice stream, supported values: G711U, G711A, SPEEX, g726-16, g726-24, g726-32, g726-40, g729a. + first_call_delay=None, # How long to wait before making first call, in seconds. + jitter_buffer_sz=None, # The size of the jitter buffer in packets. Default value is 8. + local_sip_port=None, # Local SIP UDP port. Default is min-rtp-port + 2. + loop_call_count=None, # How many calls to make, zero means infinite. + loop_wavefile_count=None, # How many times to play the wave file, zero means infinite. + max_call_duration=None, # How long should the call be, in seconds. + max_inter_call_gap=None, # Maximum time to wait between calls, in seconds. + messaging_protocol=None, # Messaging protocol, supported values: SIP. + min_call_duration=None, # How long should the call be, in seconds. + min_inter_call_gap=None, # Minimum time to wait between calls, in seconds. + name=None, # The name of the endpoint we are configuring. + pesq_server_ip=None, # LANforge PESQ server IP address. + pesq_server_passwd=None, # LANforge PESQ server password. Default is to use no authentication (blank entry). + pesq_server_port=None, # LANforge PESQ server port, default is 3998. + reg_expire_timer=None, # SIP Registration expire timer, in seconds. + ringing_timer=None, # How long (milliseconds) to wait in the ringing state before flagging call as no-answer. + sound_dev=None, # Which sound device should we play sound to. (see set_endp_flags). debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10856,15 +10859,15 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_vrcx_cost(self, - interface_cost=None, # parameter explanation pending - local_dev=None, # parameter explanation pending - local_dev_b=None, # parameter explanation pending - remote_dev=None, # parameter explanation pending - remote_dev_b=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - vr_name=None, # parameter explanation pending - wanlink=None, # parameter explanation pending + interface_cost=None, # If using OSPF, this sets the cost for this link (1-65535). + local_dev=None, # Name of port A for the local redirect device pair. + local_dev_b=None, # Name of port B for the local redirect device pair. + remote_dev=None, # Name of port B for the remote redirect device pair. + remote_dev_b=None, # Name of port B for the remote redirect device pair. + resource=None, # Resource number. + shelf=None, # Shelf name/id. + vr_name=None, # Virtual Router this endpoint belongs to. Use 'FREE_LIST' to add a stand-alone endpoint. + wanlink=None, # The name of the WanLink that connects the two B ports. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10898,21 +10901,21 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanlink_info(self, - drop_freq=None, # parameter explanation pending - dup_freq=None, # parameter explanation pending - extra_buffer=None, # parameter explanation pending - jitter_freq=None, # parameter explanation pending - latency=None, # parameter explanation pending - max_drop_amt=None, # parameter explanation pending - max_jitter=None, # parameter explanation pending - max_lateness=None, # parameter explanation pending - max_reorder_amt=None, # parameter explanation pending - min_drop_amt=None, # parameter explanation pending - min_reorder_amt=None, # parameter explanation pending - name=None, # parameter explanation pending - playback_capture_file=None, # parameter explanation pending - reorder_freq=None, # parameter explanation pending - speed=None, # parameter explanation pending + drop_freq=None, # How often, out of 1,000,000 packets, should we purposefully drop a packet. + dup_freq=None, # How often, out of 1,000,000 packets, should we purposefully duplicate a packet. + extra_buffer=None, # The extra amount of bytes to buffer before dropping pkts, in units of 1024. Use -1 for AUTO. + jitter_freq=None, # How often, out of 1,000,000 packets, should we apply jitter. + latency=None, # The base latency added to all packets, in milliseconds (or add 'us' suffix for microseconds + max_drop_amt=None, # Maximum amount of packets to drop in a row. Default is 1. + max_jitter=None, # The maximum jitter, in milliseconds (or ad 'us' suffix for microseconds) + max_lateness=None, # Maximum amount of un-intentional delay before pkt is dropped. Default is AUTO + max_reorder_amt=None, # Maximum amount of packets by which to reorder, Default is 10. + min_drop_amt=None, # Minimum amount of packets to drop in a row. Default is 1. + min_reorder_amt=None, # Minimum amount of packets by which to reorder, Default is 1. + name=None, # The name of the endpoint we are configuring. + playback_capture_file=None, # Name of the WAN capture file to play back. + reorder_freq=None, # How often, out of 1,000,000 packets, should we make a packet out of order. + speed=None, # The maximum speed of traffic this endpoint will accept (bps). debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -10952,9 +10955,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanlink_pcap(self, - capture=None, # parameter explanation pending - directory=None, # parameter explanation pending - name=None, # parameter explanation pending + capture=None, # Should we capture or not? ON or OFF. + directory=None, # The directory name in which packet capture files will be written. + name=None, # The name of the endpoint we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11042,14 +11045,14 @@ class LFJsonPost(LFCliBase): def post_set_wanpath_corruption(self, - byte=None, # parameter explanation pending - flags=None, # parameter explanation pending - index=None, # parameter explanation pending - max_offset=None, # parameter explanation pending - min_offset=None, # parameter explanation pending - name=None, # parameter explanation pending - path=None, # parameter explanation pending - rate=None, # parameter explanation pending + byte=None, # The byte to use for OVERWRITE_FIXED (or NA). + flags=None, # The flags for this corruption. + index=None, # The corruption to modify (0-5). + max_offset=None, # The maximum offset from start of Ethernet packet for the byte to be modified. + min_offset=None, # The minimum offset from start of Ethernet packet for the byte to be modified. + name=None, # WanLink name + path=None, # WanPath name + rate=None, # Specifies how often, per million, this corruption should be applied. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11082,14 +11085,14 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wanpath_filter(self, - defer_flush=None, # parameter explanation pending - dst_filter=None, # parameter explanation pending - filter_type=None, # parameter explanation pending - passive=None, # parameter explanation pending - reverse=None, # parameter explanation pending - src_filter=None, # parameter explanation pending - wl_name=None, # parameter explanation pending - wp_name=None, # parameter explanation pending + defer_flush=None, # Enter 'YES' if you do NOT want this flushed to the remote. + dst_filter=None, # The destination MAC or IP/Mask, 'NA' for PCAP. + filter_type=None, # The filter type, one of: MAC, IP, PCAP. + passive=None, # Enter 'YES' if you do NOT want to use this filter currently. + reverse=None, # If you want the logic reversed, use 'ON', otherwise set to 'OFF' + src_filter=None, # The source MAC or IP/Mask. For PCAP, this is the only filter. + wl_name=None, # The name of the WanLink endpoint we are configuring. + wp_name=None, # The name of the WanPath we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11133,9 +11136,9 @@ class LFJsonPost(LFCliBase): def post_set_wanpath_running(self, - running=None, # parameter explanation pending - wl_name=None, # parameter explanation pending - wp_name=None, # parameter explanation pending + running=None, # The state, one of: AS_PARENT, RUNNING, STOPPED. + wl_name=None, # The name of the WanLink endpoint we are configuring. + wp_name=None, # The name of the WanPath we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11231,19 +11234,19 @@ class LFJsonPost(LFCliBase): def post_set_wifi_corruptions(self, - corrupt_flags=None, # parameter explanation pending - corrupt_per_mil=None, # parameter explanation pending - delay_flags=None, # parameter explanation pending - delay_max=None, # parameter explanation pending - delay_min=None, # parameter explanation pending - dup_flags=None, # parameter explanation pending - dup_per_65535=None, # parameter explanation pending - ignore_flags=None, # parameter explanation pending - ignore_per_mil=None, # parameter explanation pending - port=None, # parameter explanation pending - req_flush=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + corrupt_flags=None, # Specify packet types to corrupt (see flags above). + corrupt_per_mil=None, # Per-million: Station to randomly corrupt selected message types by this amount. + delay_flags=None, # Specify packet types to delay (see flags above). + delay_max=None, # miliseconds: Station to randomly delay processing received messages, max time + delay_min=None, # miliseconds: Station to randomly delay processing received messages, min time + dup_flags=None, # Specify packet types to duplicate (see flags above). + dup_per_65535=None, # Percentage, represented as x per 65535 of packets we should duplicate. + ignore_flags=None, # Specify packet types to ignore (see flags above). + ignore_per_mil=None, # Per-million: Station to randomly ignore selected message types by this amount. + port=None, # WiFi interface name or number. + req_flush=None, # Set to 1 if you wish to flush changes to kernel now. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11281,11 +11284,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_custom(self, - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - text=None, # parameter explanation pending - type=None, # parameter explanation pending + port=None, # WiFi interface name or number. + resource=None, # Resource number. + shelf=None, # Shelf number. + text=None, # [BLANK] will erase all, any other text will be appended to existing text. Unescaped Value + type=None, # NA for now, may specify specific locations later. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11315,38 +11318,38 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_extra(self, - anonymous_identity=None, # parameter explanation pending - anqp_3gpp_cell_net=None, # parameter explanation pending - ca_cert=None, # parameter explanation pending - client_cert=None, # parameter explanation pending - domain=None, # parameter explanation pending - eap=None, # parameter explanation pending - group=None, # parameter explanation pending - hessid=None, # parameter explanation pending - identity=None, # parameter explanation pending - imsi=None, # parameter explanation pending - ipaddr_type_avail=None, # parameter explanation pending - key=None, # parameter explanation pending - key_mgmt=None, # parameter explanation pending - milenage=None, # parameter explanation pending - network_auth_type=None, # parameter explanation pending - network_type=None, # parameter explanation pending - pac_file=None, # parameter explanation pending - pairwise=None, # parameter explanation pending - password=None, # parameter explanation pending - phase1=None, # parameter explanation pending - phase2=None, # parameter explanation pending - pin=None, # parameter explanation pending - pk_passwd=None, # parameter explanation pending - port=None, # parameter explanation pending - private_key=None, # parameter explanation pending - psk=None, # parameter explanation pending - realm=None, # parameter explanation pending - resource=None, # parameter explanation pending - roaming_consortium=None, # parameter explanation pending - shelf=None, # parameter explanation pending - venue_group=None, # parameter explanation pending - venue_type=None, # parameter explanation pending + anonymous_identity=None, # Anonymous identity string for EAP. + anqp_3gpp_cell_net=None, # 802.11u 3GCPP Cellular Network Info, VAP only. + ca_cert=None, # CA-CERT file name. + client_cert=None, # 802.11u Client cert file: /etc/wpa_supplicant/ca.pem + domain=None, # 802.11u domain: mytelco.com + eap=None, # EAP method: MD5, MSCHAPV2, OTP, GTC, TLS, PEAP, TTLS. + group=None, # Group cyphers: CCMP, TKIP, WEP104, WEP40, or combination. + hessid=None, # 802.11u HESSID (MAC address format) (or peer for WDS stations). + identity=None, # EAP Identity string. + imsi=None, # 802.11u IMSI: 310026-000000000 + ipaddr_type_avail=None, # 802.11u network type available, integer, VAP only. + key=None, # WEP key0. This should be entered in ascii-hex. Use this only for WEP. + key_mgmt=None, # Key management: WPA-PSK, WPA-EAP, IEEE8021X, NONE, WPA-PSK-SHA256, WPA-EAP-SHA256 or combo. + milenage=None, # 802.11u milenage: 90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82 + network_auth_type=None, # 802.11u network authentication type, VAP only. + network_type=None, # 802.11u network type, integer, VAP only. + pac_file=None, # EAP-FAST PAC-File name. (For AP, this field is the RADIUS secret password) + pairwise=None, # Pairwise ciphers: CCMP, TKIP, NONE, or combination. + password=None, # EAP Password string. + phase1=None, # Outer-authentication, ie TLS tunnel parameters. + phase2=None, # Inner authentication with TLS tunnel. + pin=None, # EAP-SIM pin string. (For AP, this field is HS20 Operating Class) + pk_passwd=None, # EAP private key password. (For AP, this field is HS20 connection capability) + port=None, # WiFi interface name or number. + private_key=None, # EAP private key certificate file name. (For AP, this field is HS20 WAN Metrics) + psk=None, # WPA(2) pre-shared key. If unsure, use this field for any password entry. Prepend with 0x for ascii-hex representation. + realm=None, # 802.11u realm: mytelco.com + resource=None, # Resource number. + roaming_consortium=None, # 802.11u roaming consortium: 223344 (15 characters max) + shelf=None, # Shelf number. + venue_group=None, # 802.11u Venue Group, integer. VAP only. + venue_type=None, # 802.11u Venue Type, integer. VAP only. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11403,22 +11406,23 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_extra2(self, - corrupt_gtk_rekey_mic=None, # parameter explanation pending - freq_24=None, # parameter explanation pending - freq_5=None, # parameter explanation pending - ignore_assoc=None, # parameter explanation pending - ignore_auth=None, # parameter explanation pending - ignore_probe=None, # parameter explanation pending - ignore_reassoc=None, # parameter explanation pending - ocsp=None, # parameter explanation pending - port=None, # parameter explanation pending - post_ifup_script=None, # parameter explanation pending - radius_ip=None, # parameter explanation pending - radius_port=None, # parameter explanation pending - req_flush=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - venue_id=None, # parameter explanation pending + corrupt_gtk_rekey_mic=None, # Per-million: AP corrupts GTK Rekey MIC. + freq_24=None, # Frequency list for 2.4Ghz band, see above. + freq_5=None, # Frequency list for 5Ghz band, see above. + ignore_assoc=None, # Per-million: AP ignore assoc request percentage. + ignore_auth=None, # Per-million: AP ignore auth request percentage. + ignore_probe=None, # Per-million: AP ignore probe percentage. + ignore_reassoc=None, # Per-million: AP ignore re-assoc request percentage. + ocsp=None, # OCSP settings: 0=disabled, 1=try, but to not require response, 2=require valid OCSP stapling response. + port=None, # WiFi interface name or number. + post_ifup_script=None, # Script name with optional args, will run after interface comes up and gets IP. + + radius_ip=None, # RADIUS server IP Address (AP Only) + radius_port=None, # RADIUS server IP Port (AP Only) + req_flush=None, # Set to 1 if you wish to flush changes to kernel now. + resource=None, # Resource number. + shelf=None, # Shelf number. + venue_id=None, # Venue-ID for this wifi device. VAP in same venue will share neigh reports as appropriate. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11544,39 +11548,39 @@ class LFJsonPost(LFCliBase): def post_set_wifi_radio(self, - active_peer_count=None, # parameter explanation pending - ampdu_factor=None, # parameter explanation pending - antenna=None, # parameter explanation pending - channel=None, # parameter explanation pending - const_tx=None, # parameter explanation pending - country=None, # parameter explanation pending - flags=None, # parameter explanation pending - flags_mask=None, # parameter explanation pending - frag_thresh=None, # parameter explanation pending - frequency=None, # parameter explanation pending - fwname=None, # parameter explanation pending - fwver=None, # parameter explanation pending - mac=None, # parameter explanation pending - max_amsdu=None, # parameter explanation pending - mode=None, # parameter explanation pending - peer_count=None, # parameter explanation pending - pref_ap=None, # parameter explanation pending - pulse2_interval_us=None, # parameter explanation pending - pulse_interval=None, # parameter explanation pending - pulse_width=None, # parameter explanation pending - radio=None, # parameter explanation pending - rate=None, # parameter explanation pending - rate_ctrl_count=None, # parameter explanation pending - resource=None, # parameter explanation pending - rts=None, # parameter explanation pending - shelf=None, # parameter explanation pending - skid_limit=None, # parameter explanation pending - stations_count=None, # parameter explanation pending - tids_count=None, # parameter explanation pending - tx_pulses=None, # parameter explanation pending - txdesc_count=None, # parameter explanation pending - txpower=None, # parameter explanation pending - vdev_count=None, # parameter explanation pending + active_peer_count=None, # Number of locally-cached peer objects for this radio. + ampdu_factor=None, # ax200/ax210 only, currently. Requires module reload. OS Default: 0xFF + antenna=None, # Antenna configuration: 0 Diversity/All, 1 Fixed-A (1x1), 4 AB (2x2), 7 ABC (3x3), 8 ABCD (4x4), 9 8x8 + channel=None, # Channel number for this radio device. Frequency takes precedence if both are set to non-default values. 0xFFFF, AUTO or DEFAULT means ANY. + const_tx=None, # RF Pattern Generator , encoded as a single 32-bit integer. See above. + country=None, # Country number for this radio device. + flags=None, # Flags for this interface (see above.) + flags_mask=None, # If set, only these flags will be considered. + frag_thresh=None, # Fragmentation Threshold (256 - 2346, 2346 == disabled). + frequency=None, # Frequency for this radio. 0xFFFF, AUTO or DEFAULT means ANY. + fwname=None, # Firmware name (for example: firmware-5.bin) + fwver=None, # Firmware API version (for example, 5 if firmware is based on firmware-5.bin + mac=None, # Used to identify when name cannot be trusted (2.6.34+ kernels). + max_amsdu=None, # Maximum number of frames per AMSDU that may be transmitted. See above. + mode=None, # WiFi mode, see table + peer_count=None, # Number of peer objects for this radio. + pref_ap=None, # Preferred AP BSSID for all station vdevs on this radio. + pulse2_interval_us=None, # Pause between pattern burst for RF noise generator. + pulse_interval=None, # RF Pattern generator: interval between pulses in usecs. + pulse_width=None, # RF Pattern generator: pulse width in usecs. + radio=None, # Name of the physical radio interface, for example: wiphy0 + rate=None, # No longer used, specify the rate on the virtual station(s) instead. + rate_ctrl_count=None, # Number of rate-ctrl objects for this radio. + resource=None, # Resource number. + rts=None, # The RTS Threshold for this radio (off, or 1-2347). + shelf=None, # Shelf number. + skid_limit=None, # Firmware hash-table Skid Limit for this radio. + stations_count=None, # Number of stations supported by this radio. + tids_count=None, # TIDs count for this radio. + tx_pulses=None, # Number of pattern pulses per burst for RF noise generator. + txdesc_count=None, # Transmit descriptor count for this radio. + txpower=None, # The transmit power setting for this radio. (AUTO for system defaults) + vdev_count=None, # Configure radio vdev count. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11634,17 +11638,17 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_set_wifi_txo(self, - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - txo_bw=None, # parameter explanation pending - txo_enable=None, # parameter explanation pending - txo_mcs=None, # parameter explanation pending - txo_nss=None, # parameter explanation pending - txo_pream=None, # parameter explanation pending - txo_retries=None, # parameter explanation pending - txo_sgi=None, # parameter explanation pending - txo_txpower=None, # parameter explanation pending + port=None, # WiFi interface name or number. + resource=None, # Resource number. + shelf=None, # Shelf number. + txo_bw=None, # Configure bandwidth: 0 == 20, 1 == 40, 2 == 80, 3 == 160, 4 == 80+80. + txo_enable=None, # Set to 1 if you wish to enable transmit override, 0 to disable. + txo_mcs=None, # Configure the MCS (0-3 for CCK, 0-7 for OFDM, 0-7 for HT, 0-9 for VHT, 0-11 for HE + txo_nss=None, # Configure number of spatial streams (0 == nss1, 1 == nss2, ...). + txo_pream=None, # Select rate preamble: 0 == OFDM, 1 == CCK, 2 == HT, 3 == VHT, 4 == HE_SU. + txo_retries=None, # Configure number of retries. 0 or 1 means no retries). + txo_sgi=None, # Should rates be sent with short-guard-interval or not? + txo_txpower=None, # Configure TX power in db. Use 255 for system defaults. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11740,13 +11744,13 @@ class LFJsonPost(LFCliBase): def post_set_wl_corruption(self, - byte=None, # parameter explanation pending - flags=None, # parameter explanation pending - index=None, # parameter explanation pending - max_offset=None, # parameter explanation pending - min_offset=None, # parameter explanation pending - name=None, # parameter explanation pending - rate=None, # parameter explanation pending + byte=None, # The byte to use for OVERWRITE_FIXED (or NA). + flags=None, # The flags for this corruption. + index=None, # The corruption to modify (0-5). + max_offset=None, # The maximum offset from start of Ethernet packet for the byte to be modified. + min_offset=None, # The minimum offset from start of Ethernet packet for the byte to be modified. + name=None, # WanLink name + rate=None, # Specifies how often, per million, this corruption should be applied. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11788,8 +11792,8 @@ class LFJsonPost(LFCliBase): def post_set_wl_qdisc(self, - name=None, # parameter explanation pending - qdisc=None, # parameter explanation pending + name=None, # WanLink name + qdisc=None, # FIFO, WRR,a,b,c,d,e,f,g etc debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11836,12 +11840,12 @@ class LFJsonPost(LFCliBase): def post_show_alerts(self, - card=None, # parameter explanation pending - endp=None, # parameter explanation pending - extra=None, # parameter explanation pending - port=None, # parameter explanation pending - shelf=None, # parameter explanation pending - type=None, # parameter explanation pending + card=None, # Alert resource filter. + endp=None, # Alert endpoint filter. + extra=None, # Extra filter, currently ignored. + port=None, # Alert port filter (can be port name or number). + shelf=None, # Alert shelf filter. + type=None, # Alert type filter. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11872,9 +11876,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_attenuators(self, - resource=None, # parameter explanation pending - serno=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + serno=None, # Serial number for requested Attenuator, or 'all'. + shelf=None, # Shelf number or alias, can be 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11902,9 +11906,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cd(self, - collision_domain=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + collision_domain=None, # Name of the Collision Domain, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11932,7 +11936,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_chamber(self, - name=None, # parameter explanation pending + name=None, # Chamber Name or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -11958,9 +11962,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_channel_groups(self, - channel_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + channel_name=None, # Name of the channel, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12012,8 +12016,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cx(self, - cross_connect=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + cross_connect=None, # Specify cross-connect to act on, or 'all'. + test_mgr=None, # Specify test-mgr to act on, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12040,8 +12044,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_cxe(self, - cross_connect=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + cross_connect=None, # Specify cross-connect to show, or 'all'. + test_mgr=None, # Specify test-mgr to use, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12092,7 +12096,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_dut(self, - name=None, # parameter explanation pending + name=None, # DUT Name or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12118,8 +12122,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endp_payload(self, - max_bytes=None, # parameter explanation pending - name=None, # parameter explanation pending + max_bytes=None, # The max number of payload bytes to print out, default is 128. + name=None, # The name of the endpoint we are configuring. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12146,8 +12150,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_endpoints(self, - endpoint=None, # parameter explanation pending - extra=None, # parameter explanation pending + endpoint=None, # Name of endpoint, or 'all'. + extra=None, # See above. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12174,7 +12178,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_err(self, - message=None, # parameter explanation pending + message=None, # Message to show to others currently logged on. Unescaped Value debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12244,12 +12248,12 @@ class LFJsonPost(LFCliBase): def post_show_events(self, - card=None, # parameter explanation pending - endp=None, # parameter explanation pending - extra=None, # parameter explanation pending - port=None, # parameter explanation pending - shelf=None, # parameter explanation pending - type=None, # parameter explanation pending + card=None, # Event resource filter. + endp=None, # Event endpoint filter. + extra=None, # Extra filter, currently ignored. + port=None, # Event port filter (can be port name or number). + shelf=None, # Event shelf filter. + type=None, # Event type filter. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12280,12 +12284,12 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_files(self, - dir_flags=None, # parameter explanation pending - directory=None, # parameter explanation pending - filter=None, # parameter explanation pending - key=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + dir_flags=None, # Determines format of listing, see above. + directory=None, # The sub-directory in which to list. + filter=None, # An optional filter, as used by the 'ls' command. + key=None, # A special key, can be used for scripting. + resource=None, # The machine to search in. + shelf=None, # The virtual shelf to search in. Use 0 for manager machine. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12316,7 +12320,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_group(self, - group=None, # parameter explanation pending + group=None, # Can be name of test group. Use 'all' or leave blank for all groups. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12342,7 +12346,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_pesq(self, - endpoint=None, # parameter explanation pending + endpoint=None, # Name of endpoint, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12368,10 +12372,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ports(self, - port=None, # parameter explanation pending - probe_flags=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + port=None, # Port number, or 'all'. + probe_flags=None, # See above, add them together for multiple probings. Leave blank if you want stats only. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12400,9 +12404,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_ppp_links(self, - link_num=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + link_num=None, # Ppp-Link number of the span, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12430,7 +12434,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_profile(self, - name=None, # parameter explanation pending + name=None, # Profile Name or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12456,8 +12460,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_resources(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Shelf number or alias, can be 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12484,8 +12488,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rfgen(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Shelf number or alias, can be 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12512,10 +12516,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_rt(self, - key=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - virtual_router=None, # parameter explanation pending + key=None, # Unique identifier for this request. Usually left blank. + resource=None, # Resource number. + shelf=None, # Shelf number. + virtual_router=None, # Name of the virtual router. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12544,8 +12548,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_script_results(self, - endpoint=None, # parameter explanation pending - key=None, # parameter explanation pending + endpoint=None, # Name of endpoint, test-group, or 'all'. + key=None, # Optional 'key' to be used in keyed-text message result. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12572,9 +12576,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_spans(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - span_number=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. + span_number=None, # Span-Number of the span, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12602,9 +12606,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_text_blob(self, - brief=None, # parameter explanation pending - name=None, # parameter explanation pending - type=None, # parameter explanation pending + brief=None, # Set to 'brief' for a brief listing of all text blobs. + name=None, # Text Blob Name or 'ALL'. + type=None, # Text Blob type or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12632,7 +12636,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_tm(self, - test_mgr=None, # parameter explanation pending + test_mgr=None, # Can be name of test manager, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12658,7 +12662,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_traffic_profile(self, - name=None, # parameter explanation pending + name=None, # Profile Name or 'ALL'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12684,9 +12688,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_venue(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - venu_id=None, # parameter explanation pending + resource=None, # Resource number, or 'ALL' + shelf=None, # Shelf number. + venu_id=None, # Number to uniquely identify this venue on this resource, or 'ALL' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12714,9 +12718,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vr(self, - resource=None, # parameter explanation pending - router=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or 'all'. + router=None, # Name of the Virtual Router, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12744,9 +12748,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_vrcx(self, - cx_name=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + cx_name=None, # Name of the Virtual Router Connection, or 'all'. + resource=None, # Resource number, or 'all'. + shelf=None, # Name/id of the shelf, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12774,8 +12778,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_show_wanpaths(self, - endpoint=None, # parameter explanation pending - wanpath=None, # parameter explanation pending + endpoint=None, # Name of endpoint, or 'all'. + wanpath=None, # Name of wanpath, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12802,9 +12806,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown(self, - chdir=None, # parameter explanation pending - really=None, # parameter explanation pending - serverctl=None, # parameter explanation pending + chdir=None, # Directory to cd to before dying. Only useful when using gprof to debug, or 'NA' to ignore. + really=None, # Must be 'YES' for command to really work. + serverctl=None, # Enter 'YES' to do a ./serverctl.bash restart to restart all LANforge processes. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12832,8 +12836,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_os(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or ALL. + shelf=None, # Shelf number, or ALL. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12860,8 +12864,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_shutdown_resource(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or ALL. + shelf=None, # Shelf number, or ALL. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12946,13 +12950,13 @@ class LFJsonPost(LFCliBase): def post_sniff_port(self, - display=None, # parameter explanation pending - duration=None, # parameter explanation pending - flags=None, # parameter explanation pending - outfile=None, # parameter explanation pending - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + display=None, # The DISPLAY option, for example: 192.168.1.5:0.0. Will guess if left blank. + duration=None, # Duration for doing a capture (in seconds). Default is 5 minutes for dumpcap/tshark, and forever for wireshark + flags=None, # Flags that control how the sniffing is done. + outfile=None, # Optional file location for saving a capture. + port=None, # The port we are trying to run the packet sniffer on. + resource=None, # Resource number. + shelf=None, # Shelf number. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -12984,7 +12988,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_endp(self, - endp_name=None, # parameter explanation pending + endp_name=None, # Name of the cross-connect, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13010,7 +13014,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_group(self, - name=None, # parameter explanation pending + name=None, # The name of the test group. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13036,9 +13040,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_start_ppp_link(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - unit_num=None, # parameter explanation pending + resource=None, # Resource number that holds this PppLink. + shelf=None, # Name/id of the shelf. + unit_num=None, # Unit-Number for the PppLink to be started. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13066,7 +13070,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_endp(self, - endp_name=None, # parameter explanation pending + endp_name=None, # Name of the endpoint, or 'all'. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13092,7 +13096,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_group(self, - name=None, # parameter explanation pending + name=None, # The name of the test group, or 'all' debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13118,9 +13122,9 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_stop_ppp_link(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - unit_num=None, # parameter explanation pending + resource=None, # Resource number that holds this PppLink. + shelf=None, # Name/id of the shelf. + unit_num=None, # Unit-Number for the PppLink to be stopped. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13148,11 +13152,11 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tail(self, - cmd=None, # parameter explanation pending - key=None, # parameter explanation pending - message=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + cmd=None, # Command: start, stop, results + key=None, # File-name that we should be tailing. + message=None, # The contents to display (for results only) Unescaped Value + resource=None, # Resource that holds the file. + shelf=None, # Shelf that holds the resource that holds the file. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13182,8 +13186,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_register(self, - client_name=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + client_name=None, # Name of client to be registered. (dflt is current client) + test_mgr=None, # Name of test manager (can be all.) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13210,8 +13214,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_tm_unregister(self, - client_name=None, # parameter explanation pending - test_mgr=None, # parameter explanation pending + client_name=None, # Name of client to be un-registered. (dflt is current client) + test_mgr=None, # Name of test manager (can be all.) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13286,10 +13290,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_cli_cmd(self, - port=None, # parameter explanation pending - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending - wpa_cli_cmd=None, # parameter explanation pending + port=None, # Name of the WiFi station or AP interface to which this command will be directed. + resource=None, # Resource number. + shelf=None, # Shelf number. + wpa_cli_cmd=None, # Command to pass to wpa_cli or hostap_cli. This must be single-quoted. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13318,10 +13322,10 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wifi_event(self, - device=None, # parameter explanation pending - event=None, # parameter explanation pending - msg=None, # parameter explanation pending - status=None, # parameter explanation pending + device=None, # Interface or PHY in most cases. + event=None, # What happened. + msg=None, # Entire event in human readable form. + status=None, # Status on what happened. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13350,8 +13354,8 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_wiser_reset(self, - resource=None, # parameter explanation pending - shelf=None, # parameter explanation pending + resource=None, # Resource number, or ALL. + shelf=None, # Shelf number, or ALL. debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: @@ -13378,7 +13382,7 @@ class LFJsonPost(LFCliBase): ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- -----""" def post_write(self, - db_name=None, # parameter explanation pending + db_name=None, # The name the backup shall be saved as (blank means dflt) debug_=False): """----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- ----- Example Usage: