INSYS Router. Add-On Manual for CLI Configuration. Add-On Manual

Transcription

1 INSYS Router Add-On Manual for CLI Configuration Add-On Manual

2

3 Copyright April 15 INSYS MICROELECTRONICS GmbH Any duplication of this manual is prohibited. All rights on this documentation and the devices are with INSYS MICROELECTRONICS GmbH Regensburg. Trademarks The use of a trademark not shown below is not an indication that it is freely available for use. MNP is a registered trademark of Microcom Inc. IBM PC, AT, XT are registered trademarks of International Business Machine Corporation. INSYS, VCom, e-mobility LSG and e-mobility PLC are registered trademarks of INSYS MICROELECTRONICS GmbH. Windows is a registered trademark of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds. Publisher: INSYS MICROELECTRONICS GmbH Hermann-Köhl-Str. 22 D Regensburg, Germany Phone: Fax: info@insys-icom.com Internet: Date: Apr-15 Item: Version: 1.2 Language: EN

4 Content 1 General Information Command Line Interface (CLI) Functional principle of the CLI Reading out values Reading out the complete configuration Entering parameters CLI commands Executing a profile Displaying a profile Deleting a line in the profile Inserting a line into the profile Deleting a profile Listing all saved profiles Loading a saved profile Saving a profile Displaying the system state Displaying the system data Displaying the status information Displaying the log files Displaying the ADSL status information (only MoRoS ADSL) Terminating the CLI session Debugging commands Syntax Strings Endless lists Double parameters Deleting object values Mutually exclusive settings Restart at the end of the configuration Reloading the old configuration after configuration aborts Multiline entries / including files Apr-15

5 INSYS Router General Information 1 General Information This add-on manual describes the command line interface (CLI) of the INSYS routers and may only be used together with the operator manual of the respective router. The CLI allows a configuration of the router from the local network or remote via Telnet or SSH. The available parameters and their syntax can be found in the add-on manual for the ASCII configuration file. Safety instructions, technical data, and functional descriptions must be taken from the operator manual. This add-on manual is valid for all routers of INSYS icom with a firmware version of 2.12.x or higher. 5

6 Command Line Interface (CLI) INSYS Router 2 Command Line Interface (CLI) The router provides a command line interface (CLI) for a configuration from the local network or remote via Telnet or SSH. Before an access to the router via Telnet or SSH is possible, this must be configured accordingly. You'll find further details about this in the "Functions - Basic Settings" section of the router's manual. 2.1 Functional principle of the CLI One parameter after the other will be entered line by line via the CLI and a so-called profile will be created with this. The parameters entered will not be taken over into the configuration of the router directly; they are in the so-called temporary profile first. The temporary profile can also be saved and a saved profile can be loaded again. It is also possible to load the current configuration of the router into a profile by opening the profile "/active". All entries in a new profile or changes to an opened profile get lost when closing the session, if they have not been saved before. A profile consists of a series of parameters and can be edited, saved, displayed or executed using different CLI commands. The parameters will be transferred to the router with the execution. This saves the new configuration and activates it immediately afterwards. The parameters are composed of the sections and objects that are described in detail in the add-on manual of the ASCII configuration file. All sections and objects are case sensitive, i.e. capitalisation is considered. 2.2 Reading out values It is possible to read out the currently configured values from the router in the CLI. In order to do this, enter at the command prompt the section name followed by the object name separated by a dot in the form "Section.Object" and press the enter key. The actual value will then be displayed under the parameter. > dialout.start_dialout = Reading out the complete configuration The profile "/active" must be opened to get the complete current configuration of the router. The complete configuration will be loaded into the temporary profile with this. > cli.open /active 6

7 INSYS Router Command Line Interface (CLI) 2.4 Entering parameters In order to enter a parameter, enter at the command prompt the section name followed by the object name separated by a dot and then the object value separated by an equal sign in the form "Section.Object=ObjectValue" and press the enter key. The entered parameter will be taken over to the profile. If the section name is missing and the input line starts with a dot followed by the object name, the previous section name will be used. > dialout.start_dialout=1 2.5 CLI commands A series of commands are available on CLI level for editing, saving, displaying and executing the profiles. The command help lists all available commands. > help Manage profiles: cli.exit cli.list cli.open [profile name] cli.save [profile name] cli.print [profile name] cli.exec [profile name] cli.clear [profile name] end this session list all available profiles open a profile save the currently open profile print content of a profile execute profile delete profile and all its lines Edit lines of current profile cli.delete <line nr.> delete line cli.insert <line nr.> <..> insert line Print system information cli.info print device info cli.status print short system status cli.system print extensive system status cli.log [log number [lines]]print available logfiles, or selected logfile Diagnostic commands (interrupt with <ESC>) ping [target] ping target with IPv4 ping6 [target] ping target with IPv6 nslookup [domain name] resolve a domain name traceroute [target] print route to IPv4 target traceroute6 [target] print route to IPv6 target tcpdump [options] trace IP packets <..> mandatory; [..] optional Hint: Use TAB key for auto completion of sections and their objects The Tab key will auto-complete the command or parameter that is currently being entered. Pressing the Tab key a second time will list all commands or parameters that are available at this point. 7

8 Command Line Interface (CLI) INSYS Router Executing a profile The command "cli.exec [ProfileName]" transmits a profile to the router for executing the parameters contained in it. If no profile name is specified, the currently opened profile will be transmitted. The parameters are saved by the router and executed immediately (some changes (e.g. VPN, Firewall, etc.) become effective only if the WAN connection is re-initiated or the router is restarted) Displaying a profile The command "cli.print [ProfileName]" displays the lines of a profile at the screen. If no profile name is specified, the currently opened profile will be displayed. > cli.print 1 webinterface.http_port=80 2 webinterface.https_port= webinterface.location= Location Deleting a line in the profile The command "cli.delete <LineNumber> deletes the line with the respective line number in the currently opened profile. > cli.print 1 webinterface.http_port=80 2 webinterface.https_port= webinterface.location= Location > cli.delete 2 > cli.print 1 webinterface.http_port=80 2 webinterface.location= Location 8

9 INSYS Router Command Line Interface (CLI) Inserting a line into the profile The command "cli.insert <LineNumber> <parameter>" inserts a line with the specified parameter at the respective line number into the currently opened profile. > cli.print 1 webinterface.http_port=80 2 webinterface.location= Location > cli.insert 2 webinterface.https_port=8888 > cli.print 1 webinterface.http_port=80 2 webinterface.https_port= webinterface.location= Location Deleting a profile The command "cli.clear [ProfileName] deletes all lines from a profile. If no profile name is specified, the currently opened profile will be deleted Listing all saved profiles The command "cli.list" lists the names of all permanently saved profiles. The name of the opened profile is displayed in square brackets. The profile "/active" is the current configuration of the router. > cli.list /active [Profile3] Profile2 Profile Loading a saved profile The command "cli.open [ProfileName]" opens a permanently saved profile. If no profile name is specified, the temporary profile will be opened. If the profile "/active" is opened, the current configuration of the router will be written into the temporary profile Saving a profile The command "cli.save [ProfileName]" saves the temporary profile under the specified name. If an opened profile is to be saved under its previous name, it is not necessary to enter a profile name. The profile name must have a length between one and 20 characters. Up to 100 profiles can be saved. 9

10 Command Line Interface (CLI) INSYS Router Displaying the system state The command "cli.system" displays the current state of the router (corresponds to "Show current system state" in the web interface) Displaying the system data The command "cli.info" displays the system data (corresponds to the "System data" page in the web interface) Displaying the status information The command "cli.status" displays the status information (corresponds to the main page in the web interface) Displaying the log files The command "cli.log [LogNumber]" displays the different log files of the router. If no log number is specified, an overview of the log files will be displayed (see below; available log files depend on the respective device). If a log number is specified, it is possible to specify a line number to determine how much of the last lines are to be displayed; if no line number is specified, the full log file will be displayed. > cli.log [1] System Messages [2] System Log [3] Wireless Network Log [14] Auto Update Log [15] Text Configuration Log [16] IPT log [24] Router advertiser log [26] OpenVPN WWAN Client [27] OpenVPN WWAN Server [28] IPsec WWAN [29] PPTP WWAN Client [30] PPTP WWAN Server [31] WWAN Displaying the ADSL status information (only MoRoS ADSL) The command "cli.adsl" displays the ADSL status information (corresponds to the ADSL Status page in the web interface) Terminating the CLI session The commands "cli.exit" or "exit" terminate the current CLI session. 10

11 INSYS Router Command Line Interface (CLI) Debugging commands The commands ping, ping6, nslookup, traceroute, traceroute6 and tcpdump serve for debugging and are always called with the syntax of the respective programs. The results are displayed immediately. The execution of the commands can be aborted immediately with Esc or Strg + C. 2.6 Syntax Some specialities must be considered in addition to the parameter entries explained in the previous sections. All sections and objects are case sensitive, i.e. capitalisation is considered Strings Strings that are used to enter passwords or user names for example must be placed between single quotes " " (the necessity of single quotes is mentioned for the individual objects in the reference of the add-on manual for the ASCII configuration file). The strings may also contain single quotes because only the first and last single quote is searched for. Basically, the characters 0x20 through 0x7E are permissible, i.e. 0 through 9, a through z, A through Z, and the special characters! " # $ % & ' ( ) * +, -. / ; < = [ ] \ ^ _ { } ~, as well as the blank. The colon is not permissible. The following example shows the entry of strings: > webinterface.location= Regensburg Endless lists Some objects can form endless lists (e.g. routes). If further objects are passed with an object (e.g. the source address, net mask, data direction, etc. in case of a firewall rule), these are written into the same line, but separated from each other using a semicolon " ; ". The object "list" defines, whether the endless list contained in this section that is already stored on the router is to be deleted "list = d" (d for delete) before the new objects are entered, or the new objects are appended to the list "list = a" (a for append). If the object "list" is missing, the objects are appended to the list. Generally, there is no more than one endless list per section. The following example shows the entry of such an endless list: > hostnames.list=d > hostnames.new_entry=ip= ;host=host1 > hostnames.new_entry=ip= ;host=host2 11

12 Command Line Interface (CLI) INSYS Router Double parameters If a profile contains a parameter more than once, the successive parameter overwrites the previous one, because the profile is processed sequential. In the following example, the second object overwrites the first, i.e. the object "dns" will be set to " ": 1 dns.dns= dns.dns= Parameters can intentionally occur repeatedly and are also configured repeatedly. This can be used for example to close a dial-up connection, configure the communication device, and set-up the dial-up connection again within one profile, as shown in the following example: 31 dialout.start_dialout=0 32 isdn.msn=25 33 dialout.start_dialout= Deleting object values If a parameter is configured, i.e. a certain value has been assigned to an object, this value will only be updated with a configuration again. If the object is missing in a profile or no object value is assigned to it, the original object value remains unchanged. If the object value is to be deleted explicitly, the object value "C_L_E_A_R" must be assigned to the object: 13 dns.dns=c_l_e_a_r Mutually exclusive settings If settings are made in a profile that are mutually exclusive, for example simultaneously activating an OpenVPN client and server, the parameter configured first is valid (i.e. the one that is earlier in the profile). However, the associated settings are taken over. A comparable behaviour is also on the web interface: a conflicting setting cannot be made after configuring a certain setting, because it will be faded out. 12

13 INSYS Router Command Line Interface (CLI) Restart at the end of the configuration The section "textconfig" contains the object "reboot" to define whether a restart of the router is to be made following the configuration (0 = no restart; 1 = restart). A restart can be used to ensure that all services are started with the new settings (VPN settings are only used following a new dial-out for example). A restart will be made at the end of the configuration in the following example: 1 textconfig.reboot=1 2 textconfig.abort_on_error= Reloading the old configuration after configuration aborts The section "textconfig" contains the object "abort_on_error" to define whether the old configuration is to be reloaded in case the configuration aborts due to an error (0 = no reload of the old configuration; 1 = reload of the old configuration). The configuration aborts in case of faulty configurations that would result a red warning message in the web interface. This function can be used for example to secure "critical" configurations (e.g. the dial-up connection that is currently used for remote configuration), by activating this function before the "critical" section and deactivating it again behind it, i.e. the old configuration will only be reloaded, if the abort happens in the "critical" section. The old configuration will be reloaded after an abort in the following example: 1 textconfig.reboot=0 2 textconfig.abort_on_error=1 13

14 Command Line Interface (CLI) INSYS Router Multiline entries / including files It is also possible to upload the content of other files to the router via CLI configuration. This is required to upload certificates, keys, lists, or texts for example. These files are entered in text form as object value with the respective object. Carriage returns may also be contained within the object between the tags "BEGIN" and "END". In order to store certificates or keys for example, these will be entered as object value following the object name. For this, the certificate or key is opened in a text editor, copied there, and completely pasted behind the " = " in the object. The following (shortened) example shows the entry of the CA certificate in the CLI configuration: > openvpn server dialin.ca_certificate = -----BEGIN CERTIFICATE----- > MIIC+jCCAmOgAwIBAgIBATANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCREUx... > cnamclsz3ydocbkijul7smqak8un8xi4uksbhz0bzug1o5dubek/gkl2bkymjw== > -----END CERTIFICATE----- The entry of lists, like the AT answer list, takes place in a similar way and is shown in the following example: > serial ethernet modem.at_answer_list = -----BEGIN AT ANSWER LIST----- > i="serial Ethernet Gateway Version 1.0" > -----END AT ANSWER LIST----- The configuration of messages takes place in form of endless lists (see Endless lists). The object value in form of further objects is entered here behind the object name "new_entry" that are separated by a semicolon " ; " from each other. This may also contain carriage returns in case for s and is enclosed by the strings "-----BEGIN MESSAGE-----" and "-----END MESSAGE-----". This may not contain carriage returns for SMS messages and is entered without any further formattings. This is shown in the following example for an message: > .start_ = 1 > .list = d > .new_entry = recipient = support@insys-tec.de ; cause = 0001 ; attach = 0001 ; status = 1 ; text = -----BEGIN MESSAGE----- > text > Will be sent upon system start-----end MESSAGE----- > .new_entry = recipient = support@insys-tec.de ; cause = 0002 ; attach = 0004 ; text = -----BEGIN MESSAGE----- > text > Will be sent upon establishment of an OpenVPN Tunnel-----END MESSAGE

15