Command-line interface – command summary

The command-line interface is operated with the following commands. An overview of the available configuration parameters and actions is available in the LCOS LX Menu Reference Guide.

Note: Which commands are available depends upon the equipment of the device.
Note: For an overview of the available commands, just press the tab key twice. Enter the option --help after the command for an overview of the available parameters.
Important: Changes to the configuration are not immediately boot-persistent. They have to be saved explicitly by using the command flash.
Table 1. Overview of all commands available at the command line
Command Description
add [<Path>] Adds a row to the table.
beginscript Resets the CLI session to script mode. In this state, commands entered are not transferred directly to the device's configuration RAM but initially to its script memory. The mode is terminated by the command exit.
cd <Path> Changes the current menu or directory.
default Resets the table or the value to the default setting.
Important: This command works recursively. Therefore, all values and tables in the current path and those below it will be reset.
del <Path> <Index> Deletes the value or the table row in the branch of the menu tree referenced by <Path>. Enter the line number for the <Index>.
delete Synonymous with del.
dir Synonymous with ls.
do <Path> [<Parameter>] Executes the action in the current or referenced directory. If the action has additional parameters, they can be added at the end.
exit Ends the terminal session.
flash Store the configuration
Important: Changes to the configuration are not immediately boot-persistent. They have to be saved explicitly by using the command flash.
history Displays a list of recently executed commands.
ll2mdetect LL2Mdetect finds LL2M-capable devices in the network. The LL2M client uses this command to send a SYSINFO request to the LL2M server. The server then sends its system information, such as hardware and serial number, back to the client for display. The LL2Mdetect command can be restricted with the following parameters:
-a <MAC-address>
Restricts the command to those devices with the specified MAC address only. Enter the MAC address in the format 00a057010203, 00-a0-57-01-02-03 or 00:a0:57:01:02:03.If no MAC limitations are set, the "detect" is sent as a multicast (or alternatively using -b as a broadcast) to all LL2M-compatible devices. To contact groups of MAC addresses, * and x can be used as wildcards in individual MAC address positions, e.g., 00-a0-57-xx-xx-xx for all device MAC addresses.
Important: In a command line with multiple parameters, the final parameter must be -a. A different order is not allowed.
-b
Explicitly sends the LL2Mdetect request as a broadcast and not as a multicast.
-f <Version>
Restricts the command to those devices with the corresponding firmware version only.
-r <Hardware-Release>
Restricts the command to those devices with the corresponding hardware release only.
-s <Serial number>
Restricts the command to those devices with the corresponding serial number only.
-t <Hardware-Type>
Restricts the command to those devices of the corresponding hardware type only.
-v <VLAN-ID>
Only sends the LL2Mdetect request on the VLAN specified. If no VLAN ID is specified, the VLAN ID of the first defined IP network is used.
The command ll2mdetect -r A sends a SYSINFO request to all devices of the hardware release "A". The response from the LL2M server then contains the following information:
  • Device name
  • Device type
  • Serial number
  • MAC address
  • Hardware release
  • Firmware version with date
ll2mexec The command ll2mexec sends commands to or initiates terminal sessions on devices found by ll2mdetect. The LL2M client uses this command to send a single-line command to run on the LL2M server. Multiple commands can be combined in one LL2M command by using semicolons as separators. Depending on the command, the actions are run on the remote device and the responses from the remote device are sent to the LL2M client for display. The LL2Mexec command conforms to the following syntax:
ll2mexec -i <(W)LAN-Interface> <User>[:<Password>]@<MAC address>
The LL2Mexec command can be restricted with the following parameters:
-i <(W)LAN-Interface>
Sends the LL2Mexec command via the specified (W)LAN interface only.
-v <VLAN-ID>
Only sends the LL2Mexec command on the VLAN specified. If no VLAN ID is specified, the VLAN ID of the first defined IP network is used.
For example, the command line ll2mexec -i ETH1 root@00a057010203 set /setup/name MyDevice logs in the LL2M client as "root" on the LL2M server with the MAC address "00a057010203". Since the password was not included, the device first looks for the corresponding username in the local database and automatically uses the password for this user. If the username is also not included, the login data of the currently registered user for the CLI session is used. Then the LL2M client sets the name of the remote device to the value 'MyDevice'.
list Synonymous with ls.
ls [<Path>] Displays the contents of the current directory or path.
passwd <Password> Changes the password of the current user account.
ping [-c count] [-i interval] [-s packetsize] destination Sends an ICMP echo request to the IP address specified. Possible arguments are:
  • -c count: Send count pings.
  • -i interval: Time between packets in seconds.
  • -s packetsize: Sets the packet size to packetsize bytes (max. 65500).
  • destination: Address or host name of the target computer
rm Synonymous with del.
set <Index> {Column} <Value> Sets the value of a table row in a specific column to <Value>.
set <Path> <Value(s)> Sets the value or values of a specific path to the specified value(s).
show diag [<Parameter>] Output diagnostic information on the CLI.
show 3rd-party-licenses Output the device license information on the CLI.
startlmc <Activation Code> [Domain] After you have generated an activation code in the LANCOM Management Cloud, you use this code to pair the device with the LANCOM Management Cloud. You can optionally specify a new LMC domain as well.
sysinfo Shows the system information (e.g., hardware release, software version, MAC address, serial number, etc.).
trace [--log] [+|-|#|?] <Parameter> Starts (+) or stops (-) a trace command to output diagnosis data. # switches between different trace outputs and ? displays a help text. The parameter --log restricts the output to "historical" log information. For further information on this command refer to the section Diagnosis.
writeconfig [noflash] Writes a new configuration in the LCF file format to the device. The system interprets all of the following lines as configuration values until two empty lines are read. This is used by management systems, for example. Possible arguments are:
  • noflash: The transferred configuration is not persistent. This can be done subsequently by running the flash command.

Legend

Explanations for addressing, syntax and command input

Command-specific help

www.lancom-systems.com

LANCOM Systems GmbH | A Rohde & Schwarz Company | Adenauerstr. 20/B2 | 52146 Wuerselen | Germany | E‑Mail info@lancom.de

LANCOM Logo