To connect to the LANforge-CLI, open a tcp socket connection to the IP address of the management interface and IP port 4001. For instance:

telnet localhost 4001

Notes about entering commands:

1. Numbers may be entered as decimal or HEX. If entering in HEX, you must prepend 0x and ensure that the next number after that is not a zero (or it will be parsed as OCTAL instead of HEX. For example, if you want to enter decimal 11, you could enter: 11 or 0xB
2. Strings consisting of a single word may be entered by themselves, but if you wish to have a multi-word string considered a single token by the parser, surround it with single quotes. Adding single quotes around a single word token is OK too, and may make scripting easier in some cases.

1. add_arm_endp   Add an Armageddon (Kernel accelerated) endpoint.
2. add_cx   Add a cross-connect to a test-manager.
3. add_cd   Add an Collision Domain (grouping of WanLinks).
4. add_cd_endp   Add an Endpoint to a Collision Domain.
5. add_cd_vr   Add a Virtual Router to a Collision Domain.
6. add_file_endp   Add a File endpoint to the LANforge Manager.
7. add_gen_endp   Add a Generic endpoint to the LANforge Manager.
8. add_l4_endp   Add a Layer-4 endpoint to the LANforge Manager.
9. add_channel_group   Add a grouping of DS0 channels to be used by PPP connections.
10. add_ppp_link   Add a PPP interface connection.
11. add_t1_span   Add a T1/E1 SPAN to the LANforge Manager.
12. add_voip_endp   Add a VOIP endpoint to the LANforge Manager.
13. add_vlc_endp   Add a VLC endpoint to the LANforge Manager.
14. add_vr   Add or modify a Virtual Router object.
15. add_vrcx   Add or modify a Virtual Router Connection Endpoint object.
16. add_endp   Add an endpoint to the LANforge Manager.
17. add_br   Add a Linux Bridge Device.
18. add_mvlan   Add a MAC based VLAN (Requires kernel support).
19. add_rdd   Add a Redirect-Device (Requires kernel support).
20. add_vlan   Add an 802.1Q VLAN (Requires kernel support).
21. add_sta   Add/modify a WIFI Virtual Station (Virtual STA) interface.
22. add_vap   Add/modify a WIFI Virtual Access Point (VAP) interface.
23. add_tm   Create and add a new test manager to the system.
24. add_wl_endp   Add a WanLink (ICE) endpoint to the LANforge Manager.
25. add_t1_wl_endp   Add a T1 wanlink endpoint.
26. add_wanpath   Add a WanPath (ICE) personality to a WanLink.
27. admin   Various admin commands.
28. apply_vr_cfg   Apply all of the virtual routing settings for this Resource.
29. cancel_vr_cfg   Cancel a virtual-router configuration process for this Resource.
30. clear_cx_counters   Clear counters for one or all cross-connects.
31. clear_endp_counters   Clear counters for one or all endpoints.
32. clear_cd_counters   Clear counters for one or all Collision Domains.
33. clear_port_counters   Clear counters on one or all ports on one or all resources.
34. clear_resource_counters   Clear counters on one or all resources.
35. discover   Force discovery of nodes on the management network.
36. diag   Get diagnostic information from the LANforge server.
37. notify_dhcp   Handle input from the DHCP client process.
38. do_pesq   Start a PESQ calculation.
39. gossip   Send a message to everyone else logged in to the server.
40. getintxrate   Get tx packets per second rate over the last 3 seconds.
41. getinrxrate   Get rx packets per second rate over the last 3 seconds.
42. getinrxbps   Get rx bits-per-second per second rate over the last 3 seconds.
43. gettxpkts   Get the total tx packets sent.
44. getrxpkts   Get the total rx packets sent.
45. getpktdrops   Get the total packets dropped (based on sequence number gaps).
46. getavglatency   Get the average latency for an endpoint.
47. getrxporterrpkts   Get the total error packets detected on the receiving port (interface)
48. getrxendperrpkts   Get the total error packets detected on the endpoint.
49. getipadd   Get the IP for an endpoint.
50. getmask   Get the IP Mask for an endpoint.
51. getmac   Get the MAC address for an endpoint.
52. ?   Show help for command(s).
53. init_wiser   Initialize the Wiser NCW/HNW module.
54. licenses   Print out license information. See also: set_license
55. load   Load a previously saved test database.
56. login   Login as the client who's name you enter.
57. create_client   Create a new client.
58. log_level   Query or modify the logging level.
59. motd   Get the message of the day (alerts, etc)
60. nc_show_endpoints   Non-Cached Show one or all endpoints.
61. nc_show_pesq   Non-Cached Show PESQ results for one or all VOIP endpoints.
62. nc_show_ports   Show one/all ports for one/all resources in one/all shelves. No caching.
63. c_show_ports   Show one/all ports for one/all resources in one/all shelves. Always uses cache.
64. nc_show_channel_groups   Show one/all ChannelGroups for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. Will always request the absolute latest information from the remote system(s)
65. nc_show_spans   Show one/all Spans for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. Will always request the absolute latest information from the remote system(s)
66. nc_show_vr   Show one/all Virtual Routers for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. This command will always request the absolute latest information from the remote system(s)
67. nc_show_vrcx   Show one/all Virtual Router Connections for one/all resources in one/all shelves. Only Connections on the 'free-list', those not associated with any Virtual Router will be shown with this command unless you exactly specify the VRCX Name. If the VRCX is in a virtual router, only cached results will be shown. Connections associated with routers will be shown whith the 'show_vr' command with the rest of the router information. This command will always request the absolute latest information from the remote system(s)
68. nc_show_cd   Show one/all Collision Domains.
69. nc_show_ppp_links   Show one/all PPP Links for one/all resources in one/all shelves. An empty specifier will be treated as 'all'.
70. probe_ports   Check for the existence of new (virtual) interfaces.
71. port_reset_completed   Internal command used by port-reset script to notify LANforge the reset has completed. This is only valid for Resource processes.
72. exit   Log out of the LANforge control server.
73. reset_port   Reset an ethernet port or ports.
74. reset_serial_span   Reset a serial span.
75. reboot_os   Restart the OS on a remote resource.
76. rm_cd   Remove a Collision Domain.
77. rm_cd_endp   Remove an Endpoint from a Collision Domain.
78. rm_cd_vr   Remove a Virtual Router from a Collision Domain.
79. rm_endp   Remove one or all endpoints.
80. rm_channel_group   Remove a channel group, or set of groups.
81. rm_vr   Remove one or all Virtual Routers.
82. rm_vrcx   Remove one or all Virtual Router Connections on the free-list. Underlying objects will be deleted if they were auto-created to begin with unless you specify the last argument as 'vrcx_only'.
83. rm_span   Remove a Serial Span (T1, etc), or a set of spans.
84. rm_ppp_link   Remove a PppLink.
85. rm_client   Delete a stored client profile.
86. rm_cx   Delete a cross-connect from the system.
87. rm_wanpath   Remove one or all wanpaths from an endpoint.
88. rm_db   Delete a database.
89. rm_vlan   Remove a virtual interface.
90. rm_test_mgr   Remove a single test manager.
91. save   Save the current configuration to a file, to be loaded later.
92. scan_wifi   Scan for WiFi access points.
93. set_arm_info   Set Armagheddon Endpoint configuration.
94. set_cx_report_timer   Set time between reports from Test-Manager(s) to client(s).
95. set_endp_report_timer   Set the report timer for and endpoint.
96. set_cx_state   Set the state of the Cross-Connect(s).
97. set_license   Install license keys on the manager machine.
98. set_password   Set the password for the current or another client.
99. set_ppp_link_state   Set the state of the PPP Link(s).
100. set_wifi_radio   Modify a WIFI Radio interface.
101. set_endp_addr   Set the MAC, IP, and Port addresses for an UN_MANAGED endpoint.
102. set_endp_payload   Payload type and payload for an endpoint.
103. set_endp_details   Modify low-level settings such as TCP window sizes.
104. set_mc_endp   Set multicast-specific info for multicast endpointts.
105. show_err   Send an error message to everyone else logged in to the server.
106. start_endp   Start an endpoint.
107. start_ppp_link   Start a PppLink.
108. stop_endp   Stop an endpoint.
109. quiesce_endp   Quiesce an endpoint.
110. stop_ppp_link   Stop a PppLink.
111. set_endp_tos   Type of Service metrics for this endpoint's transmitted packets.
112. set_endp_quiesce   Set the quiesce timer, in sectons.
113. set_endp_pld_bounds   Set the min/max payload size bounds for an endpoint.
114. set_endp_tx_bounds   Set the min/max transmit rate bounds for an endpoint.
115. set_fe_info   Set read/write size and file information for File Endpoints.
116. set_gen_cmd   Set command to be executed for this generic endpoint.
117. set_endp_flag   Set a flag to modify some Endpoint option.
118. set_flag   Set a flag to modify some client option.
119. set_gps_info   Set information that could be obtained from a GPS device.
120. set_poll_mode   Set mode to polling or push algorithm.
121. set_port   Configure the attributes on an ethernet port.
122. set_port_alias   Set the alias for a virtual interface specified by MAC or 802.1Q VLAN-ID.
123. set_voip_info   Set various VOIP endpoint related values.
124. set_wanpath_filter   Set the Filter type for the WanPath
125. set_wanpath_running   Set the Running state of the WanPath
126. set_wanpath_corruption   Set corruption values on a WanLink.
127. set_wanlink_info   Set various WAN-Link Endpoint data members.
128. set_wanlink_pcap   Set the WanLink packet capture information.
129. set_wl_corruption   Set corruption values on a WanLink.
130. set_wl_qdisc   Set the Queuing Discipline for a WanLink.
131. set_endp_file   Set the file name for a particular endpoint. Used for packet playback.
132. show_resources   Show one or all resources for one or all shelves.
133. show_clients   Show all unique clients that have registered in the past.
134. show_cx   Show one or all cross-connects for one or all test managers.
135. show_cxe   Show one or all cross-connects and their endpoints for one or all test managers.
136. show_cd   Show one/all Collision Domains.
137. show_rt   Show Virtual Router's routing table.
138. show_vr   Show one/all Virtual Routers for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. May use cached values if the values are fresh enough.
139. show_vrcx   Show one/all Virtual Router Connections for one/all resources in one/all shelves. Only Connections on the 'free-list', those not associated with any Virtual Router will be shown with this command unless the VRCX is specified by name. If the VRCX is in a virtual router, only cached results will be shown. Connections associated with routers will be shown whith the 'show_vr' command with the rest of the router information. Cached values may be used if they are recent enough.
140. show_dbs   Show all available databases that may be loaded.
141. show_endpoints   Show one or all endpoints.
142. show_pesq   Show PESQ results for one or all VOIP endpoints.
143. show_endp_payload   Show the payloads for one or all endpoints.
144. show_files   Show files in a particular directory.
145. show_ports   Show one/all ports for one/all resources in one/all shelves.
146. show_channel_groups   Show one/all ChannelGroups for one/all resources in one/all shelves. An empty specifier will be treated as 'all'.
147. show_spans   Show one/all Spans for one/all resources in one/all shelves. An empty specifier will be treated as 'all'.
148. show_ppp_links   Show one/all PPP Links for one/all resources in one/all shelves. An empty specifier will be treated as 'all'.
149. show_tm   Show one or all test managers.
150. show_wps   Show one or all WanPaths for one or all WanLink Endpoints.
151. shutdown   Restart the LANforge manager process.
152. shutdown_resource   Restart all LANforge processes on a remote resource.
153. shutdown_os   Shutdown the OS on a remote resource.
154. sniff_port   Launch Wireshark or Ethereal on a traffic generator port.
155. tm_register   Register interest in one or all test managers.
156. tm_unregister   Un-register interest in one or all test managers.
157. version   Print out the version of the LANforge server.
158. wiser_reset   Reset WISER library on the specified machine.
159. who   Show who is currently logged into the system.

1. add_arm_endp

   Add an Armageddon endpoint. Armageddon endpoints are kernel accellerated, and run 10 to 20 times faster than regular LANforge endpoints. The feature set is diffent for these endpoints, however. Unlike many other endpoints, Armageddon endpoints can transmit and receive to/from the same machine.

   
   

   Argument	Description
   alias	Name of endpoint.
   shelf	Shelf name/id.
   resource	Resource number.
   port	Port number.
   type	Endpoint Type : arm_udp
   pps	Packets per second to generate.
   pkt_sz	Minimum packet size, including all ethernet headers.
   mx_pkt_sz	Maximum packet size, including all ethernet headers.

   
   Syntax: add_arm_endp alias shelf resource port type pps pkt_sz mx_pkt_sz
2. add_cx

   Add a cross-connect to a test-manager. The endpoints must have already been created.

   
   

   Argument	Description
   alias	Name of the Cross Connect to create.
   test_mgr	Name of test-manager to create the CX on.
   tx_endp	Name of Transmitting endpoint.
   rx_endp	Name of Receiving endpoint.

   
   Syntax: add_cx alias test_mgr tx_endp rx_endp
3. add_cd

   Add an Collision Domain (CD). A CD is a group of WanLinks and/or Virtual-Routers that are considered to be in the same collision domain. For instance, when emulating clients talking to an AP, all of the WanLinks associated with this emulated AP should be in the same Collision Domain. All WanLinks or Virtual Routers in a CD must be on the same Resource (machine). Currently only the 'WIFI' type is supported unless you have the third-party WISER module loaded (contact your sales rep for info.) The WIFI emulation counts bandwidth when it is transmitted or received (ie, it emulates stations <--> AP behaviour.) The WISER emulation emulates special military waveforms. An ethernet Hub emulation is planned for future releases. Flags are defined as follows. The 'state' field over-rides the 'running' flag if state is not 'NA'. You can enter the value in HEX if you prefix it with 0x.

      RUNNING   = 1,   (0x1)   Set to running state.
      ERR       = 2,   (0x2)   Set to kernel mode.
   

   
   

   Argument	Description
   shelf	Shelf name/id.
   resource	Resource number.
   alias	Name of Collision Domain.
   type	CD Type: WIFI, WISER_SURFACE, WISER_SURFACE_AIR, WISER_AIR_AIR, WISER_NCW
   bps	Maximum speed at which this collision domain can run.
   report_timer	How often to report stats.
   state	RUNNING or STOPPED (default is RUNNING). Use this to start/stop.
   flags	See above. Leave blank or use 'NA' for no default values.

   
   Syntax: add_cd shelf resource alias type bps report_timer state flags
4. add_cd_endp

   Add an Endpoint to a Collision Domain. The endpoint must be a WanLink Endpoint. If the endpoint is currently in another Collision Domain, it will be migrated to the new one safely.

   
   

   Argument	Description
   cd	Name of Collision Domain.
   endp	Endpoint name/id.

   
   Syntax: add_cd_endp cd endp
5. add_cd_vr

   Add a Virtual Router to a Collision Domain. If the VR is currently in another Collision Domain, it will be migrated to the new one safely.

   
   

   Argument	Description
   cd	Name of Collision Domain.
   vr	Virtual-Router name/ID.

   
   Syntax: add_cd_vr cd vr
6. add_file_endp

   Add a File endpoint to the LANforge Manager. This endpoint can then be used to read and/or write data from/to the file system. This is most interesting when the file system in question is some sort of network file system like NFS or iSCSI. If the endpoint already exists, then this command may be used to update the values. This defaults to 4096 read/write sizes, but you can change that with the set_fe_info command. Pattern:
   - increasing : bytes start at 00 and increase, wrapping if needed.
   
   - decreasing : bytes start at FF and decrease, wrapping if needed.
   
   - random : generate a new random payload each time it's sent.
   
   - random_fixed : means generate one random payload, and send it over and over again.
   
   - zeros : Payload is all zeros (00).
   
   - ones : Payload is all ones (FF).
   
   - PRBS_4_0_3 : Use linear feedback shift register to generate psuedo random sequence. First number is bit-length of register, second two are TAPS (zero-based indexs) Seed value is always 1. - PRBS_7_0_6 : PRBS (see above) - PRBS_11_8_10 : PRBS (see above) - PRBS_15_0_14 : PRBS (see above) - custom : Enter your own payload with the set_endp_payload cmd.
   
   

   
   

   Argument	Description
   alias	Name of endpoint.
   shelf	Shelf name/id.
   resource	Resource number.
   port	Port number.
   type	Endpoint Type : fe_generic, fe_nfs, fe_iscsi
   min_read_rate	Minimum read rate, bits-per-second.
   max_read_rate	Maximum read rate, bits-per-second.
   min_write_rate	Minimum write rate, bits-per-second.
   max_write_rate	Maximum write rate, bits-per-second.
   payload_pattern	Payload pattern, see above.
   directory	The directory to read/write in. Absolute path suggested.
   prefix	The prefix of the file(s) to read/write.

   
   Syntax: add_file_endp alias shelf resource port type min_read_rate max_read_rate min_write_rate max_write_rate payload_pattern directory prefix
7. add_gen_endp

   Add a Generic endpoint to the LANforge Manager. This endpoint will cause an external program to be run, and the results will be sent back to the LANforge system. Due to parsing constraints, you can only use certain programs, but if LANforge does not support a program you want to use, please request the feature from Candela Technologies. Set the actual command to be executed command with set_gen_cmd

   
   

   Argument	Description
   alias	Name of endpoint.
   shelf	Shelf name/id.
   resource	Resource number.
   port	Port number.
   type	Endpoint Type : gen_generic, gen_bonnie

   
   Syntax: add_gen_endp alias shelf resource port type
8. add_l4_endp

   Add a Layer-4 (HTTP, FTP, TELNET, ...) endpoint to the LANforge Manager. This endpoint can then be used to handle URL(s). If the endpoint already exists, then this command may be used to update the values. When entering a URL, use this syntax: [dl | upl] URL [file-to-upload-from-or-download-to], for example: 'dl http://www.candelatech.com/index.html /tmp/index.html' If the url-is-file flag is set, then the URL entered below should be a local file name, and it should contain one or more URLs according to our special syntax. If you do not wish to change certain fields from the current value, use 'NA' for the value of these fields. The authenticate methods are as follows. The USE_CACHE is a special flag for the proxy_auth_type argument that lets the endpoint use cache values (for instance, as cached by squid). If this is NOT selected, cached values will not be allowed. Select one or more by adding the values together:

   BASIC:        1
   DIGEST:       2
   GSSNEGOTIATE: 4
   NTLM:         8
   USE_CACHE:   32 
   

   
   

   Argument	Description
   alias	Name of endpoint.
   shelf	Shelf name/id.
   resource	Resource number.
   port	Port number.
   type	Endpoint Type : l4_generic (URL can be: http, ftp, telnet, or dict)
   proxy_port	HTTP Proxy port if you are using a proxy.
   timeout	How long to wait for a connection, in milliseconds
   url_rate	How often should we process the URL(s), per 10 minutes.
   URL	The URL, see syntax above. Can also be a local file.
   proxy_server	The name of our proxy server if using one.
   proxy_userpwd	The user-name and password for proxy authentication, format: user:passwd.
   ssl_cert_fname	Name of SSL Certs file.
   user_agent	User-Agent string. Leave blank for default.
   proxy_auth_type	Bit-field for allowable proxy-authenticate methods.
   http_auth_type	Bit-field for allowable http-authenticate methods.

   
   Syntax: add_l4_endp alias shelf resource port type proxy_port timeout url_rate URL proxy_server proxy_userpwd ssl_cert_fname user_agent proxy_auth_type http_auth_type
9. add_channel_group

   Add a grouping of DS0 channels to be used by PPP connections.
   
   Supported formats for the channels entry include:
   

   '0-23', '0,1,2,3,4,5,7' or '1-5,7,20-23'
   

   ChannelTypes (for Digium) are described here:
   

    e&m     : Channel(s) are signalled using E&M signalling (specific
                implementation, such as Immediate, Wink, or Feature Group D
                are handled by the userspace library).
    fxsls   : Channel(s) are signalled using FXS Loopstart protocol.
    fxsgs   : Channel(s) are signalled using FXS Groundstart protocol.
    fxsks   : Channel(s) are signalled using FXS Koolstart protocol.
    fxols   : Channel(s) are signalled using FXO Loopstart protocol.
    fxogs   : Channel(s) are signalled using FXO Groundstart protocol.
    fxoks   : Channel(s) are signalled using FXO Koolstart protocol.
    unused  : No signalling is performed, each channel in the list remains idle
    clear   : Channel(s) are bundled into a single span.  No conversion or
                signalling is performed, and raw data is available on the master.
    indclear: Like 'clear' except all channels are treated individually and
                are not bundled.  'bchan' is an alias for this.
    rawhdlc : The zaptel driver performs HDLC encoding and decoding on the 
                bundle, and the resulting data is communicated via the master
                device.
    fcshdlc : The zapdel driver performs HDLC encoding and decoding on the
                bundle and also performs incoming and outgoing FCS insertion
                and verification.  'dchan' is an alias for this.
    nethdlc : The zaptel driver bundles the channels together into an
                hdlc network device, which in turn can be configured with
                sethdlc (available separately).

   These are not currently supported:
   

    sf      : Channel(s) are signalled using in-band single freq tone.
   		Syntax as follows: 
   		 channel# => sf:,,,,,
   		rxfreq is rx tone freq in hz, rxbw is rx notch (and decode)
   		bandwith in hz (typically 10.0), rxflag is either 'normal' or
   		'inverted', txfreq is tx tone freq in hz, txlevel is tx tone 
   		level in dbm, txflag is either 'normal' or 'inverted'. Set 
   		rxfreq or txfreq to 0.0 if that tone is not desired.
    dacs    : The zaptel driver cross connects the channels starting at
                the channel number listed at the end, after a colon
    dacsrbs : The zaptel driver cross connects the channels starting at
                the channel number listed at the end, after a colon and 
                also performs the DACSing of RBS bits.

   
   

   Argument	Description
   alias	Name for this Channel Group.
   shelf	Shelf name/id.
   resource	Resource number.
   span_num	The span number. First span is 1, second is 2...
   channels	List of channels to add to this group.
   type	The channel-type. Use 'clear' for PPP links.
   MTU	MTU (and MRU) for this channel group. Must be a multiple of the number of channels if configuring a T1 WanLink.
   idle_flag	Idle flag (byte) for this channel group, for instance: 0x7e

   
   Syntax: add_channel_group alias shelf resource span_num channels type MTU idle_flag
10. add_ppp_link

    Add a PPP interface connection. Currently we only support PPP over channel-groups on T1 interfaces. Some of the arguments below are passed directly to the pppd process which negotiates and otherwise creates the ppp interface. You may want to read the man page for pppd for more in-depth discussion of the features. channel_groups selects the hardware resources that the PPP link will use. For Multi-Link PPP, you can select multiple Channel-Groups, otherwise select a single one. If you are entering multiple groups, surround all groups with single quotes, like: 'cg1 cg2 cg3' mlppp_descriptor should start with 'magic:' and have some ascii-hex trailing it. For instance: magic:00:11:22:33:44 You can use 'NA' if you are not using Multi-Link PPP If you need to pass extra arguments to the pppd software, you can add those arguments to the 'extra_args' value. Be sure to surround the input with single quotes so it is parsed correctly by LANforge.

    
    

    Argument	Description
    shelf	Shelf name/id.
    resource	Resource (machine) number.
    unit	Unit number for the PPP link. ie, the 7 in ppp7.
    src_ip	Source IP address for this PPP connection.
    dst_ip	Destination IP address for this PPP connection.
    channel_groups	List of channel groups, see above.
    debug	YES for debug, otherwise debugging for the ppp connection is off.
    auth	YES if you want to authenticate. Default is NO.
    persist	YES if you want to persist the connection. This is suggested.
    lcp-echo-interval	Seconds between LCP echos, suggest 1.
    lcp-echo-failure	LCP echo failures before we determine links is dead, suggest 5.
    holdoff	Seconds between attempt to bring link back up if it dies, suggest 1.
    mlppp_descriptor	A unique key for use with multi-link PPP connections.
    extra_args	Extra arguments to be passed directly to the pppd server.
    transport_type	What sort of transport this ppp link uses.
    pppoe_transport_port	Port number (or name) for underlying PPPoE transport.
    tty_transport_device	TTY device for PPP links associated with TTYs.
    run_time_min_ms	Minimum uptime (ms) for PPP link during an experiment, or 0 for the link to be always up.
    run_time_max_ms	Maximum uptime (ms) for PPP link during an experiment, or 0 for the link to be always up.
    down_time_min_ms	Minimum length of downtime (ms) for PPP link between runs, or 0 for the link to be always up.
    down_time_max_ms	Maximum length of downtime (ms) for PPP link between runs, or 0 for the link to be always up.

    
    Syntax: add_ppp_link shelf resource unit src_ip dst_ip channel_groups debug auth persist lcp-echo-interval lcp-echo-failure holdoff mlppp_descriptor extra_args transport_type pppoe_transport_port tty_transport_device run_time_min_ms run_time_max_ms down_time_min_ms down_time_max_ms
11. add_t1_span

    Add a T1/E1 SPAN to the LANforge Manager. You will have to actually have T1/E1 hardware in the system before this is a useful thing to do. You will then be able to create channel-groups and PPP links. For the 'first_channel', the setting will depend on the T1/E1 port you wish to use. The first T1/E1 resource will have the first_channel of 1, the second at 25, the third at 49, etc. Build-out: 0 == 1-133 feet, 1 == 122-266, 2 == 266-399 3 == 399-533, 4 == 533-655, 5 == -7.5db (CSU) 6 == -15db (CSU), 7 ==-22.5db (CSU), 8 == 0db (CSU) Framing NOTE: d4 is also known as 'sf' or 'superframe'.

    
    

    Argument	Description
    shelf	Shelf name/id.
    resource	Resource number.
    type	Currently supported types are: Sangoma_T1, Sangoma_E1, Digium_T1
    span_num	The span number. First span is 1, second is 2...
    first_channel	The first DS0 channel for this span.
    timing	Timing: 0 == don't use, 1 == primary, 2 == secondary..
    buildout	Buildout, Integer, see above.
    framing	Framing: T1: esf or d4. E1: cas or ccs.
    coding	Coding: T1: ami or b8zs. E1: ami or hdb3
    pci_bus	PCI Bus number, needed for Sangoma resources.
    pci_slot	PCI slot number, needed for Sangoma resources.
    CPU_ID	CPU identifer (A, B, etc) for multiport Sangoma resources.
    MTU	MTU for this span (used by in-band management, if at all).

    
    Syntax: add_t1_span shelf resource type span_num first_channel timing buildout framing coding pci_bus pci_slot CPU_ID MTU
12. add_voip_endp

    Add a VOIP (Voice over IP) to the LANforge Manager. If the endpoint already exists, then this command may be used to update the values. If the sip_gateway is 'AUTO', then the management IP for that particular machine will be used.

    
    

    Argument	Description
    alias	Name of endpoint.
    shelf	Shelf name/id.
    resource	Resource number.
    port	Port number or name.
    phone_num	Endpoint's phone number.
    rtp_port	RTP port to use for send and receive.
    sip_gateway	SIP Gateway/Proxy Name, this is who we'll register with, or AUTO
    tx_sound_file	File name containing the sound sample we will be playing.
    rx_sound_file	File name to save received PCM data to. Will be in WAV format.
    VAD_timer	How much silence (milliseconds) before VAD is enabled.
    VAD_max_timer	How often should we force a packet, even if VAD is on.
    gateway_port	IP Port for SIP/h323 gateway (defaults to 5060).
    display_name	User-Name to be displayed. Use AUTO to display phone number.
    proxy_passwd	Password to be used when registering with proxy/gateway.
    peer_phone_num	Use AUTO to use phone number of peer endpoint, otherwise specify a number: user[@host[:port]]

    
    Syntax: add_voip_endp alias shelf resource port phone_num rtp_port sip_gateway tx_sound_file rx_sound_file VAD_timer VAD_max_timer gateway_port display_name proxy_passwd peer_phone_num
13. add_vlc_endp

    Add a VLC (Streaming Audio/Video) to the LANforge Manager. If the endpoint already exists, then this command may be used to update the values. The Display syntax relates to X Display, for example, the 192.168.1.100:0.0 in DISPLAY=192.168.1.100:0.0

    
    

    Argument	Description
    alias	Name of endpoint.
    shelf	Shelf name/id.
    resource	Resource number.
    port	Port number or name.
    url	What media file to play?
    rtp_port	RTP port to use for send and receive.
    mgt_port	Management IP port.
    rx_sound_file	File name to save received PCM data to. Will be in WAV format.
    display	X Display for where to show the video. 'AUTO' will attempt to use the CLI/GUI's IP.
    min_duration	Minumum stream duration in seconds.

    
    Syntax: add_vlc_endp alias shelf resource port url rtp_port mgt_port rx_sound_file display min_duration
14. add_vr

    Add or modify a Virtual Router. Virtual Routers are used in conjunction with LANforge-ICE to provide advanced network emulation. Flags are defined as:

      USE_XORP_OSPF         0x1   # Enable Xorp router daemon with OSPF (IPv4) protocol
      USE_XORP_MCAST        0x2   # Enable Xorp Multicast routing (requires OSPF to be enabled currently)
      USE_XORP_SHA          0x4   # Enable Telcordia's Xorp SHA option (requires OSPF to be enabled)
      USE_IPV6_RADVD        0x8   # Enable IPv6 RADV Daemon for interfaces in this virtual router.
       USE_IPV6              0x10  # Enable IPv6 OSPF routing for this virtual router.
    

    
    

    Argument	Description
    alias	Name of virtual router.
    shelf	Shelf name/id.
    resource	Resource number.
    notes	Notes for this Virtual Router. Put in quotes if the notes include white-space.
    X	X coordinate to be used when drawn in the LANforge-GUI.
    Y	Y coordinate to be used when drawn in the LANforge-GUI.
    width	Width to be used when drawn in the LANforge-GUI.
    height	Height to be used when drawn in the LANforge-GUI.
    flags	Virtual router flags, see above for definitions.
    vr_id	Leave blank, use NA or 0xFFFF unless you are certain of the value you want to enter.

    
    Syntax: add_vr alias shelf resource notes X Y width height flags vr_id
15. add_vrcx

    Add or modify a Virtual Router Connection Endpoint. Virtual Router Connection Endpoints are used to logically connect two Virtual Routers with an emulated network link. Typically, 2 pairs of redirect virtual interfaces are bridged by a WanLink (which provides the network emulation.) The 'A' port in each pair of redirect devices is associated with one virtual router and has and IP address. Both endpoints should have the IP on the same subnet. The WanLink bridges the two 'B' sides of the redirect device pair. A pair of Connection Endpoint objects are required, with reversed values in their port configuration to make a connection. Flags can be entered in HEX if preceded by 0x. Add flags together to get desired options. Must use apply_vr_cfg for changes to take effect.

    Flags:  Specify subnet 0                          = 1   (0x1)
            Specify subnet 1                          = 2   (0x2)
            Specify subnet 2                          = 4   (0x4)
            Specify subnet 3                          = 8   (0x8)   
            Specify subnet 4                          = 16  (0x10)
            Specify subnet 5                          = 32  (0x20)
            Specify subnet 6                          = 64  (0x40)
            Specify subnet 7                          = 128 (0x80)
            This connection will NAT outgoing packets = 256 (0x100)
            Serve DHCP on this interface              = 512 (0x200)
            Use custom DHCP config file              = 1024 (0x400)
            Use this interface for multicast cand-rp = 2048 (0x800)
    

    
    

    Argument	Description
    shelf	Shelf name/id.
    resource	Resource number.
    vr-name	Virtual Router this endpoint belongs to. Use 'FREE_LIST' to add a stand-alone endpoint.
    local_dev	Name of port A for the local redirect device pair.
    local_dev_b	Name of port B for the local redirect device pair.
    remote_dev	Name of port B for the remote redirect device pair.
    remote_dev_b	Name of port B for the remote redirect device pair.
    wanlink	The name of the WanLink that connects the two B ports.
    X	X coordinate to be used when drawn in the LANforge-GUI.
    Y	Y coordinate to be used when drawn in the LANforge-GUI.
    width	Width to be used when drawn in the LANforge-GUI.
    height	Height to be used when drawn in the LANforge-GUI.
    flags	Flags, specify if subnets 0-7 are in use, see above for others.
    subnets	Subnets associated with this subnet, format: 1.1.1.1/24,1.1.2.1/16...
    nexthop	The next-hop to use when routing packets out this interface.
    dhcp_lease_time	DHCP Lease time (in seconds)
    dhcp_dns	IP Address of DNS server.
    dhcp_min	Minimum IP address range to serve.
    dhcp_max	Minimum IP address range to serve.
    dhcp_domain	DHCP Domain name to serve.
    interface_cost	If using OSPF, this sets the cost for this link (1-65535).
    ospf_area	If using OSPF, this sets the OSPF area for this interface. Default is 0.0.0.0.

    
    Syntax: add_vrcx shelf resource vr-name local_dev local_dev_b remote_dev remote_dev_b wanlink X Y width height flags subnets nexthop dhcp_lease_time dhcp_dns dhcp_min dhcp_max dhcp_domain interface_cost ospf_area
16. add_endp

    Add an endpoint to the LANforge Manager. The endpoint may then be added to a cross-connect. If the endpoint already exists, then this command may be used to update the values. Note that you can leave everything after 'port' off the command, and default values will be used. If you are configuring a TCP connection to make many connections, then use 0 (zero) for the IP Port so that the OS can choose a new one for each connection. Pattern:
    - increasing : bytes start at 00 and increase, wrapping if needed.
    
    - decreasing : bytes start at FF and decrease, wrapping if needed.
    
    - random : generate a new random payload each time it's sent.
    
    - random_fixed : means generate one random payload, and send it over and over again.
    
    - zeros : Payload is all zeros (00).
    
    - ones : Payload is all ones (FF).
    
    - PRBS_4_0_3 : Use linear feedback shift register to generate psuedo random sequence. First number is bit-length of register, second two are TAPS (zero-based indexs) Seed value is always 1. - PRBS_7_0_6 : PRBS (see above) - PRBS_11_8_10 : PRBS (see above) - PRBS_15_0_14 : PRBS (see above) - custom : Enter your own payload with the set_endp_payload cmd.
    
    

    
    

    Argument	Description
    alias	Name of endpoint.
    shelf	Shelf name/id.
    resource	Resource number.
    port	Port/Interface name or number.
    type	Endpoint Type : lf, lf_udp, lf_tcp, custom_ether, custom_udp, custom_tcp, mc_udp, custom_mc_udp
    ip_port	IP Port: Ip port for layer three endpoints. Use -1 to let the server automatically configure the ip_port. Layer 2 endpoints will ignore this argument. Use 0 for 'ANY', and let the OS choose.
    is_rate_bursty	Yes means it's bursty, anything else means NO.
    min_rate	Minimum transmit rate (bps), or only rate if not bursty.
    max_rate	Maximum transmit rate (bps), used if in bursty mode.
    is_pkt_sz_random	Yes means use random sized packets, anything else means NO.
    min_pkt	Minimum packet size, including all headers.
    max_pkt	Maximum packet size, including all headers.
    payload_pattern	Payload pattern, see above.
    use_checksum	Yes means checksum the payload, anything else means NO.
    ttl	Time-to-live, used by UDP Multicast Endpoints only.
    send_bad_crc_per_million	If NIC supports it, will randomly send X per million packets with bad ethernet Frame Check Sum.

    
    Syntax: add_endp alias shelf resource port type ip_port is_rate_bursty min_rate max_rate is_pkt_sz_random min_pkt max_pkt payload_pattern use_checksum ttl send_bad_crc_per_million
17. add_br

    Add a Linux Bridge Device. Specify one or more network devices to be added to the bridge. This requires that the 'bridge-utils' package be installed on your Linux system. Most of the bridge settings are only used if spanning-tree is enabled. For more information on the spanning-tree values, see: br_* configuration is ignored. br_flags can be:

    
        0x1         Enable Spanning Tree Protocol (STP)
    

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Name of the bridge device.
    network_devs	Comma-separated list of network devices: eth1,eth2,eth3...
    br_flags	Bridge flags, see above.
    br_priority	Bridge priority, 16-bit number.
    br_aging_time	MAC aging time, in seconds, 32-bit number.
    br_max_age	How long until STP considers a non-responsive bridge dead.
    br_hello_time	How often does the bridge send out STP hello packets.
    br_forwarding_delay	How long to wait until the bridge will start forwarding packets.

    
    Syntax: add_br shelf resource port network_devs br_flags br_priority br_aging_time br_max_age br_hello_time br_forwarding_delay
18. add_mvlan

    Add a MAC based VLAN. This command requires that the designated machine support the macvlan kernel module. A MAC-VLAN interface is a light-weight virtual interface that is made unique by it's MAC address. Do not add two MAC vlans with the same MAC to the same interface. In most cases, you do not want to duplicate a MAC at all! After creating the MAC-VLAN interface, you will need to configure it's IP and other information. If you wish to create a MAC VLAN with a specific name, specify the index as well. If not specified, one will be automatically selected for you.

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Port number of an existing Ethernet interface.
    mac	The MAC address for this MAC VLAN interface.
    index	Optional: The 'index' of the VLAN, (the 4 in eth0#4).
    old_name	The temporary name, used for configuring un-discovered hardware.
    report_timer	Report timer for this port, leave blank or use NA for defaults.

    
    Syntax: add_mvlan shelf resource port mac index old_name report_timer
19. add_rdd

    Add a Redirect-Device. This command requires that the designated machine support the redirdev kernel module. Redirect-Devices act like a pair of physical ethernet interfaces connected externally by a loop-back cable, and are useful for creating virtual networks. Currently, the main reason to do this is to run LANforge ICE on a single interface in conjunction with routing. The basic idea is to create a pair of redirect devices. Give one an IP address that you want the local machine to have. The other redirect interface in the pair will not have an IP address and will be bridged by LANforge ICE (WanLink) to the real ethernet interface, which also will not have an IP address. It is possible to add 802.1Q and MAC-VLANs on top of redirect devices as well. To create an redirect-device pair, run this command twice, for example: add_rdd 1 1 rdd0 rdd1 add_rdd 1 1 rdd1 rdd0

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Name of the Redirect Device to create.
    peer_ifname	The peer (other) RedirectDevice in this pair.
    report_timer	Report timer for this port, leave blank or use NA for defaults.

    
    Syntax: add_rdd shelf resource port peer_ifname report_timer
20. add_vlan

    Add an 802.1Q VLAN. This command requires that the designated machine support the 8021q kernel module. After creating the 802.1Q VLAN interface, you will need to configure it's IP and other information.

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Port number of an existing Ethernet interface.
    vid	The VLAN-ID for this 802.1Q VLAN interface.
    old_name	The temporary name, used for configuring un-discovered hardware.
    report_timer	Report timer for this port, leave blank or use NA for defaults.

    
    Syntax: add_vlan shelf resource port vid old_name report_timer
21. add_sta

    Add a WIFI Virtual Station (Virtual STA) interface. This command requires that the designated machine support LANforge's madwifi driver for the Atheros brand WIFI NICs. A Virtual STA interface is a virtual interface that acts like a real wireless client. After creating the Virtual STA interface, you will need to configure it's IP and other information. 'NA' can be used for any values that you do not wish to modify. Flags are currently defined as: 0x10 Enable WPA 0x20 Use Custom Config file. The config file should be a shell script consisting of wpa_cli commands, for example: wpa_cli -iwlan0 set_network 0 ssid '"MySSID"' wpa_cli -iwlan0 set_network 0 key_mgmt WPA-PSK wpa_cli -iwlan0 set_network 0 psk '"MyPreSharedSuperSecretKey"' wpa_cli -iwlan0 set_network 0 pairwise TKIP wpa_cli -iwlan0 set_network 0 group TKIP wpa_cli -iwlan0 set_network 0 proto WPA The script will be passed the device name as the first argument to allow a single script to handle many interfaces. To set any value to the DEFAULT (or un-set), use 'DEFAULT'. You may have to reboot the system to have the defaults take affect.

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    radio	Name of the physical radio interface, for example: ath0
    sta_name	Name for this Virtual STA, for example: sta0
    flags	Flags for this interface (see above.)
    essid	ESSID for this Virtual STA.
    nickname	Nickname for this Virtual STA.
    key	Encryption key for this Virtual STA.
    AP	The Access point this Virtual STA should be associated with (example: 00:11:22:33:4:55).
    wpa_cfg_file	WPA Supplicant config script.

    
    Syntax: add_sta shelf resource radio sta_name flags essid nickname key AP wpa_cfg_file
22. add_vap

    Add a WIFI Virtual Access Point (VAP) interface. This command requires that the designated machine support LANforge's madwifi driver for the Atheros brand WIFI NICs. A Virtual AP interface is a virtual interface that acts like a real Access Point. After creating the Virtual AP interface, you will need to configure it's IP and other information. 'NA' can be used for any values that you do not wish to modify. Flags are not currently defined. To set any value to the DEFAULT (or un-set), use 'DEFAULT'. You may have to reboot the system to have the defaults take affect.

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    radio	Name of the physical radio interface, for example: ath0
    ap_name	Name for this Virtual AP, for example: vap0
    flags	Flags for this interface (see above.)
    essid	ESSID for this Virtual AP.
    key	Encryption key for this Virtual STA.

    
    Syntax: add_vap shelf resource radio ap_name flags essid key
23. add_tm

    Create and add a new test manager to the system. A test manager is a group of cross-connects that compose a test group. The idea is that you may wish to segregate one physical LANforge shelf into several test groups to either test different configurations or different sets of hardware. The LANforge system will allow the user to run several test sets simultaneously, but it is up to the user to make sure that that actually makes sense. A test manager may span several shelves, and should be considered global to the LANforge system. See Also: tm_register

    
    

    Argument	Description
    name	The name of the test manager. Must be unique across test managers.

    
    Syntax: add_tm name
24. add_wl_endp

    Add a WanLink (ICE) endpoint to the LANforge Manager. The endpoint may then be added to a cross-connect. If the endpoint already exists, then this command may be used to update the values. Note that you can leave everything after 'port' off the command, and default values will be used.

    
    

    Argument	Description
    alias	Name of endpoint.
    shelf	Shelf name/id.
    resource	Resource number.
    port	Port number.
    latency	The latency (ms) that will be added to each packet entering this WanLink.
    max_rate	Maximum transmit rate (bps) for this WanLink.
    description	Description for this endpoint, put in single quotes if it contains spaces.

    
    Syntax: add_wl_endp alias shelf resource port latency max_rate description
25. add_t1_wl_endp

    Add a T1 wanlink endpoint.

    
    

    Argument	Description
    alias	Name of endpoint.
    shelf	Shelf name/id.
    resource	Resource number.
    channel_group	Name of channel group
    latency	The latency (ms) that will be added to each packet.
    bit_flip_rate	How many bits per billion to flip.
    transpose_rate	How many bits per billion to tranpose with their neighbour?

    
    Syntax: add_t1_wl_endp alias shelf resource channel_group latency bit_flip_rate transpose_rate
26. add_wanpath

    Add a WanPath personality to a WanLink. The WanPath is like a virtual WanLink between a source and destination IP or IP range. For instance, if you want communications between server A and client C to be different from communications between server B and client C, then you can set up two WanPaths to specify that behaviour. If the specified WanPath already exists, this command can be used to modify the existing values

    
    

    Argument	Description
    wanlink	Name of WanLink to which we are adding this WanPath.
    alias	Name of WanPath.
    speed	The maximum speed this WanLink will accept (bps).
    latency	The base latency added to all packets, in milliseconds.
    max_jitter	The maximum jitter, in milliseconds.
    extra_buffer	The extra amount of bytes to buffer before dropping pkts, in units of 1024, use -1 for AUTO.
    reorder_freq	How often, out of 1,000,000 packets, should we make a packet out of order.
    drop_freq	How often, out of 1,000,000 packets, should we purposefully drop a packet.
    dup_freq	How often, out of 1,000,000 packets, should we purposefully duplicate a packet.
    source_ip	Selection filter: Source IP.
    source_ip_mask	Selection filter: Source IP MASK.
    dest_ip	Selection filter: Destination IP.
    dest_ip_mask	Selection filter: Destination IP MASK.
    playback_capture	ON or OFF, should we play back a WAN capture file?
    playback_capture_file	Name of the WAN capture file to play back.
    playback_loop	Should we loop the playback file, YES or NO or NA.
    ignore_bandwidth	Should we ignore the bandwidth settings from the playback file? YES, NO, or NA.
    ignore_loss	Should we ignore the packet-loss settings from the playback file? YES, NO, or NA.
    ignore_latency	Should we ignore the latency settings from the playback file? YES, NO, or NA.
    ignore_dup	Should we ignore the Duplicate Packet settings from the playback file? YES, NO, or NA.
    jitter_freq	How often, out of 1,000,000 packets, should we apply random jitter.
    min_drop_amt	Minimum amount of packets to drop in a row. Default is 1.
    max_drop_amt	Maximum amount of packets to drop in a row. Default is 1.
    min_reorder_amt	Minimum amount of packets by which to reorder, Default is 1.
    max_reorder_amt	Maximum amount of packets by which to reorder, Default is 10.
    drop_every_xth_pkt	YES to periodically drop every Xth pkt, NO to drop lackets randomly.
    dup_every_xth_pkt	YES to periodically duplicate every Xth pkt, NO to duplicate lackets randomly.
    reorder_every_xth_pkt	YES to periodically reorder every Xth pkt, NO to reorder lackets randomly.
    test_mgr	The name of the Test-Manager this WanPath is to use. Leave blank for no restrictions.

    
    Syntax: add_wanpath wanlink alias speed latency max_jitter extra_buffer reorder_freq drop_freq dup_freq source_ip source_ip_mask dest_ip dest_ip_mask playback_capture playback_capture_file playback_loop ignore_bandwidth ignore_loss ignore_latency ignore_dup jitter_freq min_drop_amt max_drop_amt min_reorder_amt max_reorder_amt drop_every_xth_pkt dup_every_xth_pkt reorder_every_xth_pkt test_mgr
27. admin

    Various back-door commands. Current supported commands are: resync_clock # Used on windows to force re-sync with the system clock. write_xorp_cfg [xorp-port] # Re-write out the xorp-congif file. write_xorp_cfg only works on 'resource' processes.

    
    

    Argument	Description
    cmd	Admin command: resync_clock|write_xorp_cfg
    arg1	Argument 1: xorp-port

    
    Syntax: admin cmd arg1
28. apply_vr_cfg

    Apply all of the virtual routing settings for this Resource. This causes the routing tables to be created and configured properly for the specified configuration. This command should be run after making one or more changes to the virtual routers or virtual router connections. Please note that running this command when there are lots of virtual routers configured can take a long time. Check the Card's status for percentage complete. Also, while this process is running, you will not be able to configure ports or virtual-router configuration.

    
    

    Argument	Description
    shelf	The number of the shelf in question, or 'ALL'.
    resource	The number of the resource in question, or 'ALL'.

    
    Syntax: apply_vr_cfg shelf resource
29. cancel_vr_cfg

    Setting up virtual router configurations can take a long time when there are lots of virtual routers. This command can cancel a configuration process before it is complete. Please note: the routing tables will be in an un-determined state after this, untill you re-run the virtual router setup.

    
    

    Argument	Description
    shelf	The number of the shelf in question, or 'ALL'.
    resource	The number of the resource in question, or 'ALL'.

    
    Syntax: cancel_vr_cfg shelf resource
30. clear_cx_counters

    Clear counters for one or all cross-connects.

    
    

    Argument	Description
    cx_name	Name of Cross Connect, or 'all'. Null argument is same as 'all'.

    
    Syntax: clear_cx_counters cx_name
31. clear_endp_counters

    Clear counters for one or all endpoints.

    
    

    Argument	Description
    endp_name	Name of Endpoint, or 'all'. Null argument is same as 'all'.

    
    Syntax: clear_endp_counters endp_name
32. clear_cd_counters

    Clear counters for one or all Collision Domains.

    
    

    Argument	Description
    cd_name	Name of Collision Domain, or 'all'. Null argument is same as 'all'.

    
    Syntax: clear_cd_counters cd_name
33. clear_port_counters

    Clear counters on one or all ports on one or all resources.

    
    

    Argument	Description
    shelf	The number of the shelf in question, or 'ALL'.
    resource	The number of the resource in question, or 'ALL'.
    port	The number of the port in question, or 'ALL'.

    
    Syntax: clear_port_counters shelf resource port
34. clear_resource_counters

    Clear counters on one or all resources.

    
    

    Argument	Description
    shelf	The number of the shelf in question, or 'ALL'.
    resource	The number of the resource in question, or 'ALL'.

    
    Syntax: clear_resource_counters shelf resource
35. discover

    Force discovery of nodes on the management network. Note that discovery runs automatically about every minute.

    
    
    Syntax: discover
36. diag

    This command prints out information that can be used by support staff to diagnose certain issues.

    
    

    Argument	Description
    type	Default (blank) is everything, options: alerts, license, counters, clients, endpoints, shelf.

    
    Syntax: diag type
37. notify_dhcp

    Handle input from the DHCP client process. This should not normally be called by users, but only by other LANforge processes. This always assumes local shelf/card, so they are not specified.

    
    

    Argument	Description
    cmd	set/down/timeout/info: What does DHCP want us to do?
    port	Interface name.
    reason	DHCP reason, informational mostly.
    new_ip	New IP address.
    netmask	New subnet mask.
    new_mtu	New MTU.
    new_router	One or more default routers. We will only use the first.

    
    Syntax: notify_dhcp cmd port reason new_ip netmask new_mtu new_router
38. do_pesq

    This command starts a PESQ calculation for the results saved by a VOIP endpoint. This command is usually used internally by LANforge so it is unlikely you will ever use it directly. The LANforge system will determine the source file (which must exist on the receiving machine in the same place it does on the transmitting machine) and send a request to the LANforge PESQ server to compare the source to the result file specified in this command. The results will be associated with the VOIP endpoint and may be displayed with the 'show_pesq' command

    
    

    Argument	Description
    endp_name	Name of Endpoint.
    result_file_name	The name of the file received by the endpoint.

    
    Syntax: do_pesq endp_name result_file_name
39. gossip

    Send a message to everyone else logged in to the server.

    
    

    Argument	Description
    message	Message to show to others currently logged on.

    
    Syntax: gossip message
40. getintxrate

    Get the tx rate (packets per second) over the last 3 seconds. Values will always be fresh (cached values are not used). Value will be an integer. Response: InTxRate=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getintxrate CX AorB
41. getinrxrate

    Get the rx rate (packets per second) over the last 3 seconds. Values will always be fresh (cached values are not used). Value will be an integer. Response: InRxRate=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getinrxrate CX AorB
42. getinrxbps

    Get the rx bits-per-second rate over the last 3 seconds. Values will always be fresh (cached values are not used). Value will be an integer. Response: InRxBps=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getinrxbps CX AorB
43. gettxpkts

    Get the total tx packets count. Values will always be fresh (cached values are not used). Value will be an integer. Response: TxPkts=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: gettxpkts CX AorB
44. getrxpkts

    Get the total rx packets count. Values will always be fresh (cached values are not used). Value will be an integer. Response: RxPkts=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getrxpkts CX AorB
45. getpktdrops

    Get the total packets dropped. The drops will be detected by sequence number gaps, and will be based on packets RECEIVED by this endpoint. Values will always be fresh (cached values are not used). Value will be an integer. Response: PkdDrops=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For AtoB, enter 'B', for BtoA, enter 'A'.

    
    Syntax: getpktdrops CX AorB
46. getavglatency

    Get the average latency (over the last 30 seconds) for packets received by and endpoint. Values will always be fresh (cached values are not used). Value will be an integer, units are milliseconds. Response: AvgLatency=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For AtoB, enter 'B', for BtoA, enter 'A'.

    
    Syntax: getavglatency CX AorB
47. getrxporterrpkts

    Get the total error packets detected on the receiving port (interface). The errors will be based on what is reported by the driver and/or hardware for this interface. Values will always be fresh (cached values are not used). Value will be an integer. Response: RxPortErrPkts=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For AtoB, enter 'B', for BtoA, enter 'A'.

    
    Syntax: getrxporterrpkts CX AorB
48. getrxendperrpkts

    Get the total error packets detected on the receiving endpoint. The errors will be the sum of things like CRC errors, packets received on the wrong device, and any other errors we can detect for this particular endpoint. Values will always be fresh (cached values are not used). Value will be an integer. Response: RxEndpErrPkts=INTEGER

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For AtoB, enter 'B', for BtoA, enter 'A'.

    
    Syntax: getrxendperrpkts CX AorB
49. getipadd

    Get the IP for the endpoint. Value will be cached (but IP addresses do not often change, so the result should almost always be immediately correct.) Response: IPAdd=xxx.xxx.xxx.xxx

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getipadd CX AorB
50. getmask

    Get the IP Mask for the endpoint. Value will be cached (but IP addresses do not often change, so the result should almost always be immediately correct.) Response: Mask=xxx.xxx.xxx.xxx

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getmask CX AorB
51. getmac

    Get the MAC address for the endpoint. Value will be cached (but IP addresses do not often change, so the result should almost always be immediately correct.) Response: MAC=aa:bb:cc:dd:ee:ff

    
    

    Argument	Description
    CX	Cross-connect name
    AorB	For endpoint a, enter 'A', for endpoint b, enter 'B'.

    
    Syntax: getmac CX AorB
52. ?

    Show help for commands(s). If no command is specified, then a brief listing of all commands will be printed out. If a command is specified, then a verbose printing of that command will be printed.

    
    

    Argument	Description
    command	The command to get help for. Can be 'all', or blank.

    
    Syntax: ? command
53. init_wiser

    Initialize the Wiser NCW/HNW module. This requires that one have the proper library installed. Contact sales@candelatech.com if you have questions. If the file_name has spaces in it, be sure to enclose it in double quotes.

    
    

    Argument	Description
    shelf	The number of the shelf in question.
    resource	The number of the resource in question.
    file_name	The WISER file name for the desired emulation, or 'NA' for empty string.
    node_count	The number of WISER nodes for the desired emulation, or 'NA' for empty string.

    
    Syntax: init_wiser shelf resource file_name node_count
54. licenses

    Print out license information. See also: set_license

    
    

    Argument	Description
    popup	If 'popup', then cause a GUI popup msg, otherwise, just show text.
    show_file	If 'yes', then show the license file, not the parsed license information.

    
    Syntax: licenses popup show_file
55. load

    This command will completely erase the current setup in memory and replace it with the database specified with this command. You must specify a database to be loaded, though note that if you specify a database that does not exist, and chose 'overwrite', you will effectively initialize the LANforge system to defaults. The default database is called: DFLT

    
    

    Argument	Description
    name	The name of the database to load. (DFLT is the default)
    action	Should be 'append' or 'overwrite'.

    
    Syntax: load name action
56. login

    If you are the first to use this name, a new client will be created for you. If this is an existing client account, then you take on the characteristics of that client. At this time, that is only a few flags. If the password is set for this client, and the password given here is invalid, the client will not be logged in as the new user. See set_password to modify the password.

    
    

    Argument	Description
    name	A single name with no white-spaces (15 characters or less)
    password	Can be blank or 'NA' if no password is set, otherwise must be the password.

    
    Syntax: login name password
57. create_client

    Create a new client (user).

    
    

    Argument	Description
    name	A single name with no white-spaces (15 characters or less)
    password	Can be blank or 'NA' if no password is set, otherwise must be the password.
    super_user	1 If you want this user to have Administrative powers, 0 or blank otherwise.

    
    Syntax: create_client name password super_user
58. log_level

    Sets the logging level for the primary log stream. The values are as follows, add them together to get the desired level. If you enter log_level by itself, then you can see the current level. If the second argument exists, it will apply to the entity specified. Without an argument it just modifies the local server in general. You can enter the value in HEX if you prefix it with 0x.

       DIS       = 1,    //disasters                (0x1)
       ERR       = 2,    //errors                   (0x2)
       WRN       = 4,    //warnings                 (0x4)
       INF       = 8,    //info                     (0x8)
       TRC       = 16,   //function trace           (0x10)
       DBG       = 32,   //debug                    (0x20)
       SEC       = 64,   //log security violations  (0x40)
       DB        = 128,  //Database related logging (0x80)
       XMT       = 256   //Output going to clients  (0x100)
       SCRIPT    = 1024, //Scripting specific stuff (0x400)
       PARSE     = 2048, //PARSE specific           (0x800)
       DBG2      = 4096  //very verbose logging     (0x1000)
       LIO       = 8192  //IO logging               (0x2000)
       OUT1      = 16384 //Some std-out logging     (0x4000)
       LL_PROF   = 32768 //Profiling information    (0x8000)
       CUST1     = 65536 //Cust-1, latency info     (0x10000)
       ALL       = 0xFFFFFF //Log everything        (0xFFFFFFFF) 

    
    

    Argument	Description
    level	Integer corresponding to the logging flags.
    target	Options: 'gnu' | [file-endp-name].

    
    Syntax: log_level level target
59. motd

    This command prints out alerts and other info that may be useful for debugging LANforge configuration problems.

    
    
    Syntax: motd
60. nc_show_endpoints

    Show one or all endpoints. Will NOT use cached values.

    
    

    Argument	Description
    endpoint	Name of endpoint, or 'all'.

    
    Syntax: nc_show_endpoints endpoint
61. nc_show_pesq

    Show PESQ results for one or all VOIP endpoints. Will NOT use cached values.

    
    

    Argument	Description
    endpoint	Name of endpoint, or 'all'.

    
    Syntax: nc_show_pesq endpoint
62. nc_show_ports

    Show one/all ports for one/all resources in one/all shelves. This command WILL NOT use cached values, so it will be a little slower. It is useful for scripts and situations where the 3-5 second caching is to slow to yield the results needed. Probe-Flags: WIFI 1 MII 2 ETHTOOL 4 BRIDGE 8 EASY_IP_INFO 16 # Everything but gateway, which is expensive to probe. GW 32 GW_FORCE_REFRESH 64 # Force GW (re)probe. Otherwise, cached values *might* be used.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    port	Port number, or 'all.
    probe_flags	See above, add them together for multiple probings. Leave blank if you want stats only.

    
    Syntax: nc_show_ports shelf resource port probe_flags
63. c_show_ports

    Show one/all ports for one/all resources in one/all shelves. This command will ALWAYS use cached values, so it may return stale values. It is useful when the system cannot return non-cached values due to timeouts, and perhaps for configuration information that does not need to be probed. Probe-Flags: WIFI 1 MII 2 ETHTOOL 4 BRIDGE 8 EASY_IP_INFO 16 # Everything but gateway, which is expensive to probe. GW 32 GW_FORCE_REFRESH 64 # Force GW (re)probe. Otherwise, cached values *might* be used.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    port	Port number, or 'all.
    probe_flags	See above, add them together for multiple probings. Leave blank if you want stats only.

    
    Syntax: c_show_ports shelf resource port probe_flags
64. nc_show_channel_groups

    Show one/all ChannelGroups for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. Will always request the absolute latest information from the remote system(s)

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    channel_name	Name of the channel, or 'all'.

    
    Syntax: nc_show_channel_groups shelf resource channel_name
65. nc_show_spans

    Show one/all Spans for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. Will always request the absolute latest information from the remote system(s)

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    span_number	Span-Number of the span, or 'all.

    
    Syntax: nc_show_spans shelf resource span_number
66. nc_show_vr

    Show one/all Virtual Routers for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. This command will always request the absolute latest information from the remote system(s)

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    router	Name of the Virtual Router, or 'all'.

    
    Syntax: nc_show_vr shelf resource router
67. nc_show_vrcx

    Show one/all Virtual Router Connections for one/all resources in one/all shelves. Only Connections on the 'free-list', those not associated with any Virtual Router will be shown with this command unless you exactly specify the VRCX Name. If the VRCX is in a virtual router, only cached results will be shown. Connections associated with routers will be shown whith the 'show_vr' command with the rest of the router information. This command will always request the absolute latest information from the remote system(s)

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    cx_name	Name of the Virtual Router Connection, or 'all'.

    
    Syntax: nc_show_vrcx shelf resource cx_name
68. nc_show_cd

    Show one/all Collision Domains for one/all resources in one/all shelves. An empty specifier will be treated as 'all'. This command will always request the absolute latest information from the remote system(s)

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    collision-domain	Name of the Collision Domain, or 'all'.

    
    Syntax: nc_show_cd shelf resource collision-domain
69. nc_show_ppp_links

    Show one/all PPP Links for one/all resources in one/all shelves. An empty specifier will be treated as 'all'.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    link_num	Ppp-Link number of the span, or 'all.

    
    Syntax: nc_show_ppp_links shelf resource link_num
70. probe_ports

    Check for the existence of new (virtual) interfaces.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.

    
    Syntax: probe_ports shelf resource
71. port_reset_completed

    Internal command used by port-reset script to notify LANforge the reset has completed. This is only valid for Resource processes.

    
    

    Argument	Description
    port	The port in question.

    
    Syntax: port_reset_completed port
72. exit

    Log out of the LANforge control server.

    
    
    Syntax: exit
73. reset_port

    This command will cause the driver on the data-production ports to reset the ethernet hardware. It will also re-initialize all of the routing information for that interface. This command will disrupt traffic, but it can be useful if the ethernet port locks up or if you wish to change any of the routing information. See the user-guide section on setting up IP addresses and routing for more information. Don't override the default of 'YES' for reset_ospf unless you are certain that is the right thing to do.

    
    

    Argument	Description
    shelf	Shelf number, or ALL.
    resource	Resource number, or ALL.
    port	Port number to reset, or ALL.
    reset_ospf	If set to 'NO', then OSPF will not be updated. Otherwise, it will be updated.

    
    Syntax: reset_port shelf resource port reset_ospf
74. reset_serial_span

    This command will cause the Serial Span (T1, etc) driver to be reloaded. This may help work around bugs in the T1 driver and/or hardware.

    
    

    Argument	Description
    shelf	Shelf number
    resource	Resource (machine) number.
    span	Serial-Span number to reset.

    
    Syntax: reset_serial_span shelf resource span
75. reboot_os

    This will reboot the Operating System on the resource specified. All processes will be killed on that resource, of course. Upon reboot, server processes will be re-started, including the LANforge server. See also: reboot_OS

    
    

    Argument	Description
    shelf	Shelf number, or ALL.
    resource	Resource number, or ALL.

    
    Syntax: reboot_os shelf resource
76. rm_cd

    Remove a Collision Domain. Any endpoints still associated with this CD will be gracefully removed from the CD, but will not otherwise be affected.

    
    

    Argument	Description
    cd	Name of Collision Domain.

    
    Syntax: rm_cd cd
77. rm_cd_endp

    Remove an Endpoint from a Collision Domain.

    
    

    Argument	Description
    cd	Name of Collision Domain.
    endp	Endpoint name/id.

    
    Syntax: rm_cd_endp cd endp
78. rm_cd_vr

    Remove a Virtual Router from a Collision Domain.

    
    

    Argument	Description
    cd	Name of Collision Domain.
    endp	Virtual-Router name/id.

    
    Syntax: rm_cd_vr cd endp
79. rm_endp

    Remove an endpoint. 'YES_ALL' for endp-name will delete all endpoints.

    
    

    Argument	Description
    endp_name	Name of the endpoint, or 'YES_ALL'.

    
    Syntax: rm_endp endp_name
80. rm_channel_group

    Remove a channel group, or set of groups.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    channel_name	Name of the channel, or 'all'.

    
    Syntax: rm_channel_group shelf resource channel_name
81. rm_vr

    Remove one or all Virtual Routers.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    router_name	Virtual Router name, or 'all'.

    
    Syntax: rm_vr shelf resource router_name
82. rm_vrcx

    Remove one or all Virtual Router Connections on the free-list. Underlying objects will be deleted if they were auto-created to begin with unless you specify the last argument as 'vrcx_only'.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    connection_name	Virtual Router Connection name, or 'all'.
    vrcx_only	If we should NOT delete underlying auto-created objects, enter 'vrcx_only' here, otherwise leave blank or use NA.
    vr_id	If not removing from the free-list, then supply the virtual-router name/ID here. Leave blank or use NA for free-list.

    
    Syntax: rm_vrcx shelf resource connection_name vrcx_only vr_id
83. rm_span

    Remove a Serial Span (T1, etc), or a set of spans.

    
    

    Argument	Description
    shelf	Name/id of the shelf, or 'all'.
    resource	Resource number, or 'all'.
    span_num	Span-Number of the channel, or 'all'.

    
    Syntax: rm_span shelf resource span_num
84. rm_ppp_link

    Remove a PppLink.

    
    

    Argument	Description
    shelf	Name/id of the shelf.
    resource	Resource number that holds this PppLink.
    unit_num	Unit-Number for the PppLink to be deleted.

    
    Syntax: rm_ppp_link shelf resource unit_num
85. rm_client

    Delete a stored client profile. The client cannot be logged on currently. Changes will not be permanent until you write out the database. The client will be removed from all test managers as well.

    
    

    Argument	Description
    client_name	Name of the client profile you wish to remove.
    client_password	Client's password. Not required if we are super-user.

    
    Syntax: rm_client client_name client_password
86. rm_cx

    Delete a cross-connect from the system.

    
    

    Argument	Description
    test_mgr	Name of test-mgr, or 'all'.
    cx_name	Name of the cross-connect, or 'all'.

    
    Syntax: rm_cx test_mgr cx_name
87. rm_wanpath

    Remove one or all wanpaths from an endpoint.

    
    

    Argument	Description
    endp_name	Name of the endpoint.
    wp_name	Name of the wanpath.

    
    Syntax: rm_wanpath endp_name wp_name
88. rm_db

    Delete a database.

    
    

    Argument	Description
    db_name	Name of the database to delete.

    
    Syntax: rm_db db_name
89. rm_vlan

    Remove an 802.1Q VLAN or MAC-VLAN.

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Port number or name of the virtual interface.

    
    Syntax: rm_vlan shelf resource port
90. rm_test_mgr

    Remove a test manager. Cross-connects will not be directly affected. There is no need to un-register clients first: This command will take care of that for you.

    
    

    Argument	Description
    test_mgr	Name of the test manager to be removed.

    
    Syntax: rm_test_mgr test_mgr
91. save

    This command allows you to save the current test configuration, including all Endpoints, and all TestManagers. You may then use the 'load' command to initialize the LANforge Manager with the previously saved database. If you don't specify a name, it will be saved as the default database (DFLT), and will be automatically loaded at startup.

    
    

    Argument	Description
    db_name	The name the backup shall be saved as (blank means dflt)

    
    Syntax: save db_name
92. scan_wifi

    Scan for WiFI access points. Only works for WiFI Virtual Station Interfaces (Virtual STA).

    
    

    Argument	Description
    shelf	Shelf number.
    resource	Resource number.
    port	Port number or name of the virtual interface.
    key	Unique identifier for this request. Usually left blank.

    
    Syntax: scan_wifi shelf resource port key
93. set_arm_info

    Set Armagheddon Endpoint configuration. You may enter 'AUTO' for any value that you wish LANforge to calculate for you or set to defaults. Note that randomizing many of these values will mean packets may not be received on the receiving port due to routing or switching issues. If multi_pkts is set to a value greater than 1, that number of identical packets will be sent before creating a new packet. This can significantly increase performance, but at the cost of not having as much accuracy when calculating latency values. It will also cause the 'duplicate packet' to increment.

    
    

    Argument	Description
    name	Name of the Endpoint we are setting.
    min_pkt_size	Minimum packet size, including all Ethernet headers (but not CRC).
    max_pkt_size	Maximum packet size, including all Ethernet headers (but not CRC).
    udp_src_min	Minimum source UDP port.
    udp_src_max	Maximum source UDP port.
    udp_dst_min	Minimum destination UDP port.
    udp_dst_max	Minimum destination UDP port.
    ip_src_min	Minimum source IP address to use.
    ip_src_max	Maximum source IP address to use.
    ip_dst_min	Minimum destination IP address to use.
    ip_dst_max	Maximum destination IP address to use.
    src_mac_count	How many source MACs to iterate through.
    dst_mac_count	How many destination MACs to iterate through.
    src_mac	The source MAC address.
    dst_mac	The destination MAC address.
    multi_pkts	The number of identical packets to send before creating a new one.
    pkts_to_send	The number of packets to send. Set to zero for infinite.

    
    Syntax: set_arm_info name min_pkt_size max_pkt_size udp_src_min udp_src_max udp_dst_min udp_dst_max ip_src_min ip_src_max ip_dst_min ip_dst_max src_mac_count dst_mac_count src_mac dst_mac multi_pkts pkts_to_send
94. set_cx_report_timer

    You must be registered with the Test-Manager(s) in order for this operation to succeed. The timer should be >= 500ms. This command will also cause the LANforge Resources to report to the LANforge Manager on a similar time interval.

    
    

    Argument	Description
    test_mgr	Name of the test manager, or 'all'.
    cx_name	Name of cross-connect, or 'all'.
    milliseconds	Report timer length in milliseconds.
    CXONLY	If you want to set the timer for ONLY the CX, and not the endpoints, enter 'cxonly'. Otherwise, leave it blank..

    
    Syntax: set_cx_report_timer test_mgr cx_name milliseconds CXONLY
95. set_endp_report_timer

    The timer should be >= 500ms. This will cause the LANforge-GUI to request reports at the specified interval. For large numbers of entities, it is suggested to use longer report times to decrease load on the GUI.

    
    

    Argument	Description
    endp_name	Name of endpoint.
    milliseconds	Report timer length in milliseconds.

    
    Syntax: set_endp_report_timer endp_name milliseconds
96. set_cx_state

    Set the state of the Cross-Connect(s). Valid states are: RUNNING -- Sets the CX(s) in the running state. SWITCH -- Sets the CX(s) in the running state, stopping any conflicting tests. QUIESCE -- Stop transmitting and gracefully stop cross-connect. STOPPED -- Sets the CX(s) in the stopped state. DELETED -- Deletes the CX(s). SWITCH only works on WanLink cross-connects at this time.

    
    

    Argument	Description
    test_mgr	Name of the test-manager, or 'all'.
    cx_name	Name of the cross-connect, or 'all'.
    cx_state	One of: RUNNING, SWITCH, QUIESCE, STOPPED, or DELETED.

    
    Syntax: set_cx_state test_mgr cx_name cx_state
97. set_license

    Install license keys on the manager machine. Enter the license keys as a single command. LANforge will break them into separate lines internally.

    
    

    Argument	Description
    licenses	License keys all appended into a single line.

    
    Syntax: set_license licenses
98. set_password

    Set the password for the current client (if client is not specified), or the specified client if we are logged in as 'admin'.

    
    

    Argument	Description
    old_password	Old password, or 'NA' for blank password.
    new_password	New password, or 'NA' for blank password.
    client	Specify the client. If left blank, will use current client.

    
    Syntax: set_password old_password new_password client
99. set_ppp_link_state

    Set the state of the PPP Link(s). Valid states are: RUNNING -- Sets the PPP Link(s) in the running state. STOPPED -- Sets the PPP Link(s) in the stopped state. DELETED -- Deletes the PPP Link(s).

    
    

    Argument	Description
    shelf	Name of the Shelf, or 'all'.
    resource	Number of the Resource, or 'all'.
    link	Unit Number of the PPP Link, or 'all'.
    ppp_state	One of: RUNNING, STOPPED, or DELETED.

    
    Syntax: set_ppp_link_state shelf resource link ppp_state
100. set_wifi_radio

     Modify a WIFI Radio Interface (such as 'ath0'). This command requires that the designated machine support LANforge's madwifi driver for the Atheros brand WIFI NICs. The radio interface holds common configuration for the Virtual STA interfaces. 'NA' can be used for any values that you do not wish to modify. Most of these values are passed directly to the iwconfig and/or iwpriv tool. To set any value to the DEFAULT (or un-set), use 'DEFAULT'. You may have to reboot the system to have the defaults take affect.

     
     

     Argument	Description
     shelf	Shelf number.
     resource	Resource number.
     radio	Name of the physical radio interface, for example: ath0
     mode	WiFi mode: 0 == AUTO, 1 == 802.11a, 2 == 802.11b 3 == 802.11g
     channel	Channel number for this radio device.
     country	Country number for this radio device.
     frequency	Frequency for this radio.
     sens	The sensitivity of this radio.
     rate	The (maximum) rate at which this radio should run.
     rts	The RTS for this radio.
     txpower	The transmit power setting for this radio.

     
     Syntax: set_wifi_radio shelf resource radio mode channel country frequency sens rate rts txpower
101. set_endp_addr

     Set the MAC, IP, and Port addresses for an UN_MANAGED endpoint. The endpoint must be created as UN_MANAGED, and you must set it's addresses before you can start it. The syntax for MAC addresses is: 01:BB:CC:DD:EE:FF, IP addresses should be entered in dot notation, ie: 172.4.1.1, and port is the IP port (1-65534).

     
     

     Argument	Description
     name	The name of the endpoint we are configuring.
     mac	The MAC address. Only needed for LANforge protocol Endpoints.
     ip	The IP Address. Used for TCP/IP and UDP/IP protocols.
     port	The IP Port. Used for TCP/IP and UDP/IP protocols.

     
     Syntax: set_endp_addr name mac ip port
102. set_endp_payload

     Set the payload type, and potentially the payload for a particular Endpoint. To see the payload types, see the help for add_endp. To enter an actual payload, use space separated Hexadecimal. For example: 00 00 01 04 bb de ad be ef. The payload must be entered all at once on one line. The payload cannot be longer than 2048 bytes (though when represented as ascii HEX, the actual input can be longer than that.)

     
     

     Argument	Description
     name	The name of the endpoint we are configuring.
     payload_type	The payload type. See help for add_endp.
     payload	For custom payloads, enter the payload in hex, up to 2048 bytes.

     
     Syntax: set_endp_payload name payload_type payload
103. set_endp_details

     Modify TCP window sizes. The rcvbuf_size will be passed to setsockopt(desc, SOL_SOCKET, SO_RCVBUF, &size, sizeof(size)) and the sndbuf will be set similarly: setsockopt(desc, SOL_SOCKET, SO_SNDBUF, &size, sizeof(size)). See the socket man page: man socket for more detailed information about what this means. conn_timer is used to create TCP connections of short duration. If this is set to some value other than 0xFFFFFFFF, then the connection will be closed and reopened at that duration. Set to a low value for testing firewalls and devices that are interested in connections-per-second.

     
     

     Argument	Description
     name	The name of the endpoint we are configuring.
     rcvbuf_size	The receive buffer (window) size.
     sndbuf_size	The sending buffer (window) size.
     conn_timer	The duration (in ms) this connection should run before re-establishing.

     
     Syntax: set_endp_details name rcvbuf_size sndbuf_size conn_timer
104. set_mc_endp
     
     

     Argument	Description
     name	The name of the endpoint we are configuring.
     ttl	Time to live for the multicast packets generated.
     mcast-group	Multicast group IP, ie: 224.1.1.2 IPv6 supported as well.
     mcast-dest-port	Multicast destination IP Port, for example: 55000
     rcv_mcast	Should we attempt to receive? Values: Yes or No

     
     Syntax: set_mc_endp name ttl mcast-group mcast-dest-port rcv_mcast
105. show_err

     Send an error message to everyone else logged in to the server.

     
     

     Argument	Description
     message	Message to show to others currently logged on.

     
     Syntax: show_err message
106. start_endp

     Start and endpoint. This command is only valid for Multicast endpoints, which are NOT managed by a cross-connect like the rest of the endpoints. See Also: set_cx_state

     
     

     Argument	Description
     endp_name	Name of the cross-connect, or 'all'.

     
     Syntax: start_endp endp_name
107. start_ppp_link

     Start a PppLink.

     
     

     Argument	Description
     shelf	Name/id of the shelf.
     resource	Resource number that holds this PppLink.
     unit_num	Unit-Number for the PppLink to be started.

     
     Syntax: start_ppp_link shelf resource unit_num
108. stop_endp

     Stop an endpoint. This command is only valid for Multicast endpoints, which are NOT managed by a cross-connect like the rest of the endpoints. See Also: set_cx_state

     
     

     Argument	Description
     endp_name	Name of the endpoint, or 'all'.

     
     Syntax: stop_endp endp_name
109. quiesce_endp

     Quiesce an endpoint. This command is only valid for Multicast endpoints, which are NOT managed by a cross-connect like the rest of the endpoints. See Also: set_cx_state

     
     

     Argument	Description
     endp_name	Name of the endpoint, or 'all'.

     
     Syntax: quiesce_endp endp_name
110. stop_ppp_link

     Stop a PppLink.

     
     

     Argument	Description
     shelf	Name/id of the shelf.
     resource	Resource number that holds this PppLink.
     unit_num	Unit-Number for the PppLink to be stopped.

     
     Syntax: stop_ppp_link shelf resource unit_num
111. set_endp_tos

     Set the IP Type of Service (TOS) byte for this Endpoint. Only valid for TCP/IP and UDP/IP based endpoint types. You should consult RFC-791, RFC-1349 and RFC-2474 for ideas of what this value can and should be. RFC 1394 standard TOS settings can be entered by name: LOWDELAY, THROUGHPUT, RELIABILITY, LOWCOST. You may also instruct the Endpoint to NOT set any TOS with the TOS keyword: DONT-SET. This will make the Endpoint use the kernel defaults. If you have already set the TOS, then you must stop and restart the Endpoint to have the new default values take affect. For Priority, please read the Linux socket man page: man 7 socket

     
     

     Argument	Description
     name	The name of the endpoint we are configuring.
     TOS	The