IOLAN SDS/SCS/STS Command Line Interface Reference Guide Version 3.6 Part #5500210-13 September 2008...
Page 2
Perle reserves the right to make changes without further notice, to any products to improve reliability, function, or design. Perle, the Perle logo, and IOLAN are trademarks of Perle Systems Limited. Microsoft, Windows 98, Windows NT, Windows 2000, Windows Server 2003, Windows XP, Windows Vista, and Internet Explorer are trademarks of Microsoft Corporation.
Table of Contents Preface ...15 About This Book ... 15 Intended Audience... 15 Typeface Conventions... 15 Contacting Technical Support... 16 Making a Technical Support Query ... 16 Who To Contact ... 16 Have Your Product Information Ready ... 16 Making a support query via the Perle web page ... 16 Repair Procedure...
Page 4
Show Console ... 28 Show Custom-App... 28 Show Server ... 28 Show Port-Buffering ... 28 Show Modbus... 28 Hardware Commands...29 Set Ethernet... 29 Show Hardware ... 29 SSH Server Commands ...29 Set SSH-Server... 29 Show SSH-Server...30 SSL/TLS Commands ...30 Set SSL Server ... 30 Set SSL Server Cipher-suite ...
Page 5
TruePort Baud Commands ... 39 Set TruePort Remap-Baud... 39 Show TruePort ... 39 Email Commands... 40 Set Email-Alert Server... 40 Show Email-Alert Server... 40 Clustering Commands... 41 Add Clustering Slave-IP... 41 Delete Clustering Slave-IP ... 41 Set Clustering Slave-IP ... 41 Show Clustering Slave-IP ...
Page 6
Chapter 3 User Commands ...51 Commands for Users Logged Into the IOLAN ...51 Admin... 51 Help ... 51 Kill Line ... 51 Kill Session... 51 Logout... 51 Menu...52 Ping ... 52 Resume ... 52 Rlogin... 52 Screen ... 52 Set Termtype ...53 Set User ...
Page 7
Chapter 4 Line Commands...67 1-Port vs. 2-Port+ Line Commands ... 67 Line Commands ... 67 Set Line... 67 Set Line Interface... 71 Set Line Service... 73 Set Modem ... 75 Set Termtype... 76 Show Line... 76 Line Service Commands ... 76 Set Custom-App ...
Page 8
Show SSH-Client... 94 Show Telnet-Client... 94 Show Modbus... 94 Show UDP... 94 Show Vmodem ... 94 Show Vmodem-Phone ... 94 Modem Commands ...95 Add Modem ... 95 Delete Modem... 95 Set Modem... 95 Show Modems... 95 Email Commands ...96 Set Email-Alert Line ... 96 Show Email-Alert Line ...
Page 9
Hosts Commands ... 104 Add Host... 104 Delete Host... 104 Set Host ... 105 Show Hosts ... 105 DNS/WINS Commands ... 105 Add DNS ... 105 Add WINS ... 105 Delete DNS ... 106 Delete WINS ... 106 Show DNS ... 106 Show Server...
Page 10
IPv6 Tunnels ...115 Add IPv6tunnel... 115 Set IPv6tunnel ... 116 Show IPv6tunnel ... 116 Delete IPv6tunnel ...116 L2TP/IPsec ...117 Set L2TP... 117 Show LT2P... 119 VPN Exceptions ...119 Add VPN Exception ... 119 Set VPN Exception... 119 Delete VPN Exception...120 Show VPN Exception...
Page 11
Chapter 7 Administration Commands...127 Bootup Commands... 127 Reboot ... 127 Reset... 127 Reset Factory... 127 Save ... 127 Set Bootup ... 128 Show ARP ... 128 Show Bootup ... 128 TFTP File Transfer Commands... 128 Netload ... 128 Netsave... 129 Keys and Certificates Commands...
Page 12
Chapter 9 IOLAN+ User Commands ...135 IOLAN+ ...135 Chapter 10 I/O Commands ...137 Global I/O Commands ...137 Set IO UDP ... 137 Set IO Failsafe ... 138 Set IO Modbus... 138 Set IO Temperature-Scale ...138 Set Line...138 Set Line Service ... 138 Set IOChannel ...139 Set IOChannel Mode ...
Page 13
Chapter 11 Power Commands ...151 Power Commands... 151 Glossary ...153...
Page 14
IOLAN SDS/SCS/STS CLI Reference Guide, Version 3.6...
Preface About This Book This guide provides the information you need to: configure the IOLAN using the Command Line Interface (CLI) Intended Audience This guide is for administrators who will be configuring the IOLAN. Some prerequisite knowledge is needed to understand the concepts and examples in this guide: If you are using an external authentication application(s), working knowledge of the authentication application(s).
Contacting Technical Support Contacting Technical Support Making a Technical Support Query Who To Contact Note: Perle offers free technical support to Perle Authorised Distributors and Registered Perle Resellers. If you bought your product from a registered Perle supplier, you must contact their Technical Support department;...
Repair Procedure Before sending a IOLAN for repair, you must contact your Perle supplier. If, however, you bought your product directly from Perle you can contact directly. Customers who are in Europe, Africa or Middle East can submit repair details via a website form. This form is on the Perle website, www.perle.com, in the Click here to access our web site at the following URL: http://www.perle.com/support_services/rma_form.asp...
Page 18
Contacting Technical Support IOLAN SDS/SCS/STS CLI Reference Guide, Version 3.6...
Introduction This book provides the command line interface (CLI) options available for the IOLAN. The commands are grouped by function. CLI Conventions This section explains how to interpret the CLI syntax. If you are an existing IOLAN+ customer and would like to configure the IOLAN in the native IOLAN+ interface, you can type the command to display and use the native IOLAN+ interface (you must have iolan+ your IOLAN+ User Guide for information on using the IOLAN+ interface.
CLI Conventions Command Shortcuts When you type a command, you can specify the shortest unique version of that command or you can press the set telnet-client map-to-crlf off can be typed as: set tel map off or, you can use the set tel<ESC>net-client ma<ESC>p-to-crlf off where the key was pressed to complete the option as it was typed.
Server Commands This chapter defines all the CLI commands associated with configuring the IOLAN server parameters. Server Commands Set Console Description Sets the flow control and baud rate on IOLAN models that have a dedicated console port. User Level Admin Syntax set console [flow none|soft|hard] [speed 9600|19200|38400|57600|115200]...
Server Commands Set Port-Buffering Description Configures port buffering. User Level Admin Syntax set port-buffering [duplicate-nfs-to-syslog on|off] [keys-stroke-buffering on|off] [mode off|local|remote|both] [nfs-directory <text>] [nfs-encryption on|off] [nfs-host <config_host>] [time-stamp on|off] [view-port-buffer-string <text>] Options duplicate-nfs-to-syslog When enabled, buffered data is sent to the syslog host to be viewed on the host’s monitor.
Set Server Description Sets server parameters. User Level Admin Syntax set server [auto-obtain-dns on|off] [auto-obtain-gw on|off] [auto-obtain-wins on|off] [banner on|off] [break on|off] [bypass-password on|off] [dhcp-update-dns on|off] [domain <string>] [flush-on-close on|off] [line-menu-string <string>] [monitor-connection-every <1-32767>] [name <string>] [netmask <IPV4_address>] [oem-login on|off] [password-limit <0-10>] [prompt-with-name on|off] [ip-filter on|off] [session-escape-string <string>] [single-telnet on|off] [monitor-connection-every <seconds>]...
Page 24
Server Commands dhcp-update-dns The DHCP server will update the DNS server when the IOLAN requests a DHCP IP address (the communication between the DNS server and the DHCP server must already be set up in your network). dhcp/bootp Enables the DHCP/BOOTP client process in the IOLAN. By default, this is disabled/off.
Page 25
password-limit The number of attempts a user is allowed to enter a password for a serial port connection from the network, before the connection is terminated and the user has to attempt to login again. For users logging into the serial port, if this limit is exceeded, the serial port is disabled for 5 minutes.
Server Commands session-escape-string A configurable string that allows access to a port to view the multisession screen options, allowing the various options while accessing the particular port on the IOLAN. You can specify control (unprintable) codes by putting the decimal value in angle brackets <...
validation-criteria Any values that are entered in the validation criteria must match the peer certificate for an SSL connection; any fields left blank will not be validated against the peer certificate. country A two character country code; for example, US. This field is case sensitive in order to successfully match the information in the peer SSL/TLS certificate.
Server Commands httpd HTTP daemon process in the IOLAN on port 80. snmpd SNMP daemon process in the IOLAN on port 161. spcd SPC (TruePort) daemon process in the IOLAN that supports TruePort Full Mode on UDP port 668. You can still communicate with the IOLAN in Lite Mode when this service is disabled.
Show Modbus Description Shows the Modbus settings for the gateway. User Level Normal, Admin Syntax show modbus gateway Hardware Commands Set Ethernet Description Sets the hardware configuration for the Ethernet port(s). User Level Admin Syntax set ethernet [eth1|eth2] speed-and-duplex auto|10-half|10-full|100-half|100-full|1000-full Options eth1|eth2 You must specify the Ethernet interface if you have an SCS model with dual Ethernet.
SSH Server Commands authentication dsa An authentication method used by SSH version 2. Use DSA authentication for the SSH session. authentication password The user types in a password for authentication. authentication keyboard-interactive The user types in a password for authentication.Used for SSH2 only. compression Requests compression of all data.
SSL/TLS Commands Set SSL Server Description Sets the default SSL/TLS parameters for the server. User Level Admin Syntax set ssl server [version any|tslv1|sslv3] [type client|server] [verify-peer on|off] [validation-criteria Options version Specify whether you want to use: The default is Any. type Specify whether the IOLAN will act as an SSL/TLS client or server.
SSL/TLS Commands organisation-unit Up to a 64 character entry for the unit in the organisation; for example, Payroll. This field is case sensitive in order to successfully match the information in the peer SSL/TLS certificate. common-name Up to a 64 character entry for common name; for example, the host name or fully qualified domain name.
key-exchange The type of key to exchange for the encryption format: The default is Any. hmac Select the key-hashing for message authentication method for your encryption type: The default is Any. Show SSL Description Shows the SSL/TLS settings/information. User Level Normal, Admin Syntax show ssl Modbus Commands...
Modbus Commands req-next-delay A delay, in milliseconds, to allow serial slave(s) to re-enable receivers before issuing next Modbus Master request. The default is 50 ms. exceptions When enabled, an exception message is generated and sent to the initiating Modbus device when any of the following conditions are encountered: there is an invalid UID, the UID is not configured in the Gateway, there is no free network connection, there is an invalid message, or the target device is not answering the connection attempt.
Authentication Commands Set Authentication Description Sets the authentication method for the IOLAN. User Level Admin Syntax set authentication type primary|secondary none|local|radius|kerberos|ldap|tacacs+|securid|nis [secondary-as-backup on|off] [auth-admin-user-local on|off] Options primary The first authentication method that the IOLAN attempts. Some type of authentication must be done by the IOLAN, therefore, Authentication Method secondary If the...
Authentication Commands Set Authentication Kerberos Description Configures Kerberos authentication settings. User Level Admin Syntax set authentication kerberos [kdc-domain <string>] [port <TCP_port>] [realm <string>] Options kdc-domain The name of a host running the KDC (Key Distribution Center) for the specified realm. The host name that you specify must either be defined in the IOLAN’s (with an IP address) or be resolvable by a DNS server.
Set Authentication NIS Description Sets NIS authentication parameters. User Level Admin Syntax set authentication nis [domain <string>] [primary <config_host>] [secondary <config_host>] Options domain The NIS domain name. primary The primary NIS host that is used for authentication. secondary The secondary NIS host that is used for authentication, should the primary NIS host fail to respond.
Set Authentication TACACS+ Description Configures TACACS+ authentication settings. User Level Admin Syntax set authentication tacacs+ [port <TCP_port>] [primary <config_host>] [secondary <config_host>] [secret <string>] Options port The port number that TACACS+ listens to for authentication requests. The default port number is 49. primary The primary TACACS+ host that is used for authentication.
TruePort Baud Commands Show Authentication Description Shows the authentication settings. If you type just the command, the configured primary and secondary authentication methods are displayed. User Level Admin Syntax show authentication radius|ldap|tacacs+|nis|kerberos|securid Option radius Displays the authentication settings for the specified authentication method. TruePort Baud Commands Set TruePort Remap-Baud Description This command allows for the remapping of the baud rate being specified by the Serial...
Email Commands Set Email-Alert Server Description Configures email alert settings for the server. User Level Admin Syntax set email-alert server [from <email_addr>] [level emergency|alert|critical|error|warning|notice|info|debug] [mode on|off] [to <email_addr>] [reply-to <email_addr>] [smtp-host <string>] [subject <string>] Options from This will be the contents of the from field in the generated email. This field will be specified in the level Choose the event level that triggers an email notification:...
Clustering Commands Clustering Commands Add Clustering Slave-IP Description Adds a slave IOLAN to the clustering group. User Level Admin Syntax add clustering slave-ip <IPv4_address> number-of-ports 1|2|4|8|16|24|32|48 [protocol telnet|ssh] [starting-master-tcp-port <10001-65535>] [starting-slave-ds-port <10001-65535>] Options <IPv4_address> Specify the IP address of the clustering slave you wish to modify. This clustering slave must already exist in the clustering group.
Set Clustering Slave-IP Description Modify the parameter associated with a specific port in a clustering group. User Level Admin Syntax set clustering slave-ip <IPv4_address> port <number> [master-tcp-port <10001-65535>] [name <port_name>] [protocol telnet|ssh|not-used] [slave-ds-port <10001-65535>] Options <IPv4_address> Specify the IP address of the clustering slave you wish to modify. This clustering slave must already exist in the clustering group.
Dynamic DNS Commands Dynamic DNS Commands Set Dynamic-DNS Description Configures the dynamic DNS parameters. User Level Admin Syntax set dynamic-dns [on|off] [connection-method http|http-port-8245|https] [hostname <hostname>] [username <username>] [password <password>] [system-type dynamic|static|custom] [wildcard enable|disable|nochange] Options connection-method Specify how the IOLAN is going to connect to the DynDNS.org server, via HTTP, HTTP through Port 8245, or HTTPS.
Page 45
Dynamic DNS Commands country A two character country code; for example, US. This field is case sensitive in order to successfully match the information in the peer SSL/TLS certificate. state-province Up to a 128 character entry for the state/province; for example, IL. This field is case sensitive in order to successfully match the information in the peer SSL/TLS certificate.
Dynamic DNS Commands Set Dynamic-DNS SSL Cipher-Suite Description Sets the SSL/TLS cipher suite parameters for the connection between the IOLAN and the DNS server. User Level Admin Syntax set dynamic-dns ssl cipher-suite option1|option2|option3|option4|option5 encryption any|aes|3des|des|arcfour|arctwo|none min-key-size 40|56|64|128|168|256 max-key-size 40|56|64|128|168|256 key-exchange any|rsa|edh-rsa|edh-dss|adh hmac any|sha1|md5 Options option1|option2|option3|option4|option5...
hmac Select the key-hashing for message authentication method for your encryption type: The default is Any. Show Dynamic-DNS Description Shows the dynamic DNS settings. User Level Admin Syntax show dynamic-dns PCI Commands Set PCI Card Description Sets the type of card in the PCI slot. User Level Admin Syntax set pci card none|modem|wireless-wan...
PCI Commands Set PCI Wireless-WAN Description Configures the wireless WAN parameters. User Level Admin Syntax set pci wireless-wan [access-point-name <name>] [init-string <modem_init_string>] [model sierra-wireless-aircard-881|sony-ericsson-pc300|sierra| [password <password>][phone-number <phone_number>] [user <username>] Options access-point-name Specify the APN required by your internet provider to access their network. See the internet provider documentation for more information.
IPv6 Commands Set IPv6 Description Configures the basic IPv6 settings. User Level Admin Syntax set ipv6 [dhcpv6-settings ipv6-address on|off] [dhcp-settings network-prefix on|off] [auto-obtain-dns-ipv6 on|off] [eth1|eth2] [enable-ipv6-addressing on|off] [obtain-using auto-ipv6|dhcpv6] Options dhcpv6-settings Determines the types of information that the IOLAN will accept from the DHCPv6 server, IPv6 address(es) and/or network prefix(es).
IPv6 Router Advertisements IPv6 Router Advertisements Set IPv6-Router-Advertisement Description Configures IPv6 router advertisements. User Level Admin Syntax set ipv6-router-advertisement [eth1|eth2] on|off [dhcpv6 off|on] [dhcpv6-cfg-options off|on] Options ipv6-router-advertisement When enabled, the IOLAN will periodically send IPV6 Router Advertisement messages and respond to Router Solicitation messages. The Router Advertisement message can be configured to contain any of the following information: Default: Disabled eth1|eth2...
User Commands This chapter defines all the CLI commands available to users who are logged into the IOLAN. Commands for Users Logged Into the IOLAN Admin Description Changes a Normal-level user to the Admin user. When you press this command, you will be prompted for the Admin password. User Level Normal Syntax admin...
Commands for Users Logged Into the IOLAN Menu Description Switches from a command line based interface to Menu mode of operation. User Level Restricted, Normal, Admin Syntax menu Ping Description This command checks to see if a given host is reachable via an IP message. The specific message used is called a ping.
Set Termtype Description Sets the type of terminal being used for the current session. User Level Normal, Admin Syntax set termtype wyse60|vt100|ansi|dumb|tvi925|ibm3151te|vt320|hp700|term1|term2| term3 Option wyse60|vt100|ansi|dumb|tvi925|ibm3151te|vt320|hp700|term1|term2|term3 Specifies the type of terminal connected to the line: Set User Description Sets the current users settings. User Level Normal, Admin Syntax set user .
Commands for Users Logged Into the IOLAN routing Determines the routing mode used for RIP packets on the PPP and SLIP interfaces for this user. Values are: password The password the user will need to enter to login to the IOLAN. This case-sensitive field accepts a maximum of 16 characters.
Show Line Users Description Shows the users who are on the line. User Level Admin Syntax show line users Description Starts an SSH session to the specified host/IP address. User Level Normal, Admin Syntax ssh <hostname/IP_address> [<TCP_port>] [termtype <terminal_name>] [authentication rsa on|off] [authentication dsa on|off] [authentication keyboard-interactive on|off] [compression on|off] [protocol ssh-1|ssh-2|ssh-2,1]...
Commands for Users Logged Into the IOLAN ssh-2-cipher-list Select the order of negotiation for the encryption method (ciphers) that the IOLAN will use for the SSH version 2 connection: user The name of the user logging into the SSH session. verbose Displays debug messages on the terminal.
Configuring Users escape Defines the escape character. Returns you to the command line mode. This value is in hexadecimal with a default value of Version Description Displays firmware version and build. User Level Normal, Admin Syntax version Configuring Users Add User Description For units with 4 or less serial ports, you can configure up to 4 users.
Set Default User Description Configures the Default User. When adding a new user, the profile of the default user will be used to assign the values of the various parameters of the new user. For example if you set the their service parameter will be set to User Level Admin Syntax...
Page 62
Configuring Users framed-mtu Used for being transferred across the link. On noisy links it might be preferable to fragment large packets being transferred over the link, since there will be quicker recovery from errors. Depending on whether you have selected a follows: Line hotkey-prefix...
Page 63
level The access that a user is allowed: Admin—The admin level user has total access to the IOLAN. You can create more than one admin user account but we recommend that you only have one. They can monitor and configure the IOLAN. Normal—The Normal level user has limited access to the IOLAN.
Configuring Users sess-timer The amount of time, in seconds, that the forcibly close a user’s session (connection). When the IOLAN will end the connection. The default value is timer will not expire (the session is open permanently, or until the user logs out). The maximum value is 4294967 seconds.
Page 65
framed-compression Used for User Service PPP SLIP , determines whether Van Jacobsen Compression is used on the link. VJ compression is a means of reducing the standard TCP/IP header from 40 octets to approximately 5 octets. This gives a significant performance improvement, particularly when interactive applications are being used.
Page 66
Configuring Users hotkey-prefix The prefix that a user types to control the current session. The default value is which corresponds to Hotkey Prefix idle-timer The amount of time, in seconds, that the connection because of inactivity. When the no exchange of data within the specified time, the IOLAN will close the connection. The default value is connection is open permanently).
Page 67
netmask This is used for the PPP or SLIP Service types. Only used for IPv4. If the remote user is on a subnet, enter the network’s subnet mask. For example, a subnet mask of 255.255.0.0. password The password the user will need to enter to login to the IOLAN. This case-sensitive field accepts a maximum of 16 characters.
Line Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s line parameters. 1-Port vs. 2-Port+ Line Commands If you are using a 1-port IOLAN, the admin user does not have the option of using the number or all (*) options in the line commands, as there is only one line.
Page 70
Line Commands connection-method Determines how a modem will work on the line. Select from the following options: idle-timer Enter a time period, in seconds, for which the close a connection because of inactivity. When the end the connection. The maximum value is 4294967 seconds (about 49 days). The default value of permanently open.
Page 71
break Specifies how a break is interpreted: off—The IOLAN ignores the break key completely and it is not passed through to the host. This is the default setting. local—The IOLAN deals with the break locally. If the user is in a session, the break key has the same effect as a hot key.
Page 72
Line Commands keepalive Enables a per-connection TCP keepalive feature. After the configured number of seconds, the connection will send a gratuitous ACK to the network peer, thus either ensuring the connection stays active OR causing a dropped connection condition to be recognized.
Page 73
stop-bits Specifies the number of stop bits that follow a byte. The 1.5 option is only available on the 1-port and 2-port models, but not on the modem of the SDS1M or SDS3M models. term-type Specifies the type of terminal connected to the line: Dumb WYSE60 VT100...
Line Commands Set Line Interface The SCS and STS IOLAN models only support the EIA-232 interface and therefore does not require parameter, instead you can just set the parameters for the EIA-232 interface. interface Description Configures line interface (hardware) parameters. User Level Admin Syntax set line .|<number>|* interface eia-232 [monitor-dcd on|off]...
duplex Specify whether the line is Half Duplex echo-suppression This parameter applies only to echoed to the user and transmitted across the serial ports. Some EIA-485 applications require local echo to be enabled in order to monitor the loopback data to determine that line contention has occurred.
Page 76
Line Commands Options bidir This service allows the IOLAN listen for incoming TCP connection and if needed, initiate a TCP connection. <config_host> The name of the target host. The host must exist in the IOLAN host table. <server_port> The IOLAN port number. <host_port>...
Page 77
Sets the port to a dedicated PPP line. slip Sets the port in SLIP mode. Sets the line to listen for and/or send UDP data. vmodem The IOLAN port behaves as if it were a modem to the attached device. server-tunnel Sets the line for a server tunnel connection.
Line Commands Set Modem Description Sets the modem initialization strings for a defined modem. If you wish to add a new modem, use the User Level Admin Syntax set modem <modem_name> <init_string> Options <modem_name> Predefined modem name. <init_string> Specify the initialization string for the modem. This can be up to 60 characters long, but cannot include spaces.
Line Service Commands Set Custom-App Description You can create a custom application that can run on a specific serial line in IOLAN using the Perle SDK. User Level Admin Syntax set custom-app line .|<number>|* program-command-line <command> Options program-command-line The name of the SDK program executable that has been already been downloaded to the IOLAN, plus any parameters you want to pass to the program.
Line Service Commands echo Defines the echo character. When the text locally and sends only completed lines to the host. This value is in hexadecimal with a default value of Defines the end-of-file character. When as the first character on a line sends the character to the remote host. This value is in hexadecimal with a default value of erase Defines the erase character.
Page 81
auto-login Creates an automatic SSH login, using the name The user’s name when is enabled. Auto Login password The user’s password when Auto Login ssh-1-cipher Select the encryption method (cipher) that you want to use for your SSH version 1 connection: 3DES Blowfish...
Line Service Commands Set PPP Description Configures the Lines PPP settings. User Level Admin Syntax set ppp wireless-wan|line .|<number>|* [accm <8_hex_digits>] [address-comp on|off] [auth-tmout <integer>] [challenge-interval <integer>] [cr-retry <integer>] [cr-timeout <integer>] [ipaddr-neg on|off] [ipv6-global-network-address <IPv6_network_prefix>] [ipv6-local-interface <interface_id>] [ipv6-remote-interface <interface_id>] [lipaddr <IPV4_address>] [magic-neg on|off] [mru <64-1500>] [nak-retry <integer>] [netmask <IPV4_address>] [password <string>] [proto-comp on|off] [ripaddr <IPV4_address>] [roaming-callback on|off] [authentication none|pap|chap]...
Page 83
ipaddr-neg Specifies whether or not IP address negotiation will take place. IP address negotiation is where the IOLAN allows the remote end to specify its IP address. The default value is . When , the IP address specified by the remote end will be used in preference to Remote IP Address set for a Line...
Page 84
Line Service Commands netmask The network subnet mask. For example, 255.255.0.0. If your user is authenticated by RADIUS and the RADIUS parameter IOLAN will use the value in the RADIUS file in preference to the value configured here. password This field defines the password which is associated with the user defined by the parameter.
Page 85
ruser This field is used to authenticate a user connecting to this line. It is used in conjunction with the rpassword field. By specifying a name here, this line becomes dedicated to that user only. If left blank, the internal user database will be used to authenticate the connection and any user configured will be able to access this line.
Line Service Commands Set PPP Dynamic-DNS Description This option is only available when IP address negotiation ( enabled, the IOLAN will automatically update the DNS server with the specified host name and negotiated IP address for the PPP session. User Level Admin Syntax set ppp line .|<number>|* dynamic-dns [on|off] [hostname <hostname>] [username <username>]...
vj-comp This determines whether Van Jacobson compression is used on this link; that is, whether you are using SLIP or C-SLIP (compressed SLIP). The choices are (SLIP). The default is traffic, such as Telnet or Rlogin. If your user is authenticated by the IOLAN, this VJ compression value will be overridden if you have set a authenticated by RADIUS and the RADIUS parameter the RADIUS file, the IOLAN will use the value in the RADIUS file in preference to the...
Line Service Commands both|in|out|none The direction in which information is received or relayed: auto-learn The IOLAN will only listen to the first port that it receives a UDP packet from. Applicable when set to any-port The IOLAN will receive messages from any port sending UDP packets. Applicable when set to specific The port that the IOLAN will use to relay messages to servers/hosts or the port from...
Page 89
failure-string String that is sent to the serial device when a connection fails. If no string is entered, then the string will be sent. NO CARRIER host The target host name. init-string You can specify additional vmodem commands that will affect how vmodem starts. The following commands are supported: ATQn, ATVn, ATEn, ATS0, AT&Z1, AT&Sn, AT&Rn, AT&Cn, AT&F, ATS2, ATS12, and ATDS1.
Page 90
Line Service Commands style One of the following: success-string String that is sent to the serial device when a connection succeeds. If no string is entered, then the string CONNECT 9600 suppress When enabled, the connection success/failure indication strings are sent to the connected device, otherwise these indications are suppressed.
Set Vmodem-Phone Description This command associates a phone number with an IP address and TCP port. This enables the existing modem application to issue a dial command with a phone number. The phone number will be search in this table and if an exact match is found, the associated IP address and TCP port will be used to establish the connection.
Page 92
Line Service Commands type Specify whether the IOLAN will act as an SSL/TLS client or server. The default is Client. verify-peer Enable this option when you want the Validation Criteria to match the Peer Certificate for authentication to pass. If you enable this option, you need to download an SSL/TLS certificate authority (CA) list file to the IOLAN.
Set SSL Line Cipher-suite Description Sets the SSL/TLS cipher suite parameters for the line. User Level Admin Syntax set ssl line .|<number>|* cipher-suite option1|option2|option3|option4|option5 encryption any|aes|3des|des|arcfour|arctwo|none min-key-size 40|56|64|128|168|256 max-key-size 40|56|64|128|168|256 key-exchange any|rsa|edh-rsa|edh-dss|adh hmac any|sha1|md5 Options option1|option2|option3|option4|option5 Sets the priority of the cipher suite, with lowest priority.
Line Service Commands Set Modbus-Slave Line Description Sets the Modbus slave parameters for the line. User Level Admin Syntax set modbus-slave line .|<number>|* [crlf on|off] [protocol rtu|ascii] [uid-range <uid_range>] Options crlf When Modbus devices require this option. The default is protocol Specify the protocol that is used between the Modbus Master(s) and Modbus Slave(s), either RTU or ASCII.
slave-ip The IP address of the TCP/Ethernet Modbus Slave. uid-range When example, 10.10.10.1, 10.10.10.2, 10.10.10.3, etc.), you can specify a UID range and the IOLAN will automatically increment the last digit of the configured IP address. Therefore, you can specify a UID range of 1-100, and the IOLAN will route Master Modbus messages to all Modbus Slaves with IP addresses of 10.10.10.1 - 10.10.10.100.
Line Service Commands Set Multihost Line Description Configures multiple hosts or a primary/backup host schema for Silent Raw, Reverse Raw, or Client-Inititated TruePort service types (multihost must be enabled by the line service type for this to take effect, see enable multihost).
Show PPP Description Shows the PPP line settings. User Level Admin Syntax show ppp line <number>|wireless-wan Show Rlogin-Client Description Show the rlogin-client settings for the line. User Level Normal, Admin Syntax show rlogin-client line <number> Show SLIP Description Show the SLIP settings for the line. User Level Admin Syntax show slip line <number>...
Modem Commands Modem Commands Add Modem Description Adds a modem. User Level Admin Syntax add modem <modem_name> <initialization_string> Options <modem_name> The name of the modem. Do not use spaces. <initialization_string> The initialisation string of the modem; see your modem’s documentation. Delete Modem Description Deletes a modem.
Email Commands Set Email-Alert Line Description This command configures email alert parameters for the line. User Level Admin Syntax set email-alert line <number>|* [from <email_addr>] [level emergency|alert|critical|error|warning|notice|info|debug] [mode on|off] [to <email_addr>] [reply-to <email_addr>] [smtp-host <string>] [subject <string>] [use-server on|off] Options from This field will be specified in the level...
Packet Forwarding Commands Show Email-Alert Line Description Shows how the line email alert is configured. User Level Admin Syntax show email-alert line <number> Packet Forwarding Commands Set Packet-Forwarding Line Description The Packet Forwarding feature allows you to control how the data coming from a serial device is packetized before forwarding the packet onto the LAN network.
Page 101
Packet Forwarding Commands delay-between-messages The minimum time, in milliseconds, between messages that must pass before the data is forwarded by the IOLAN. The range is 0-65535. The default is 250 ms. custom-on-specific-events This section allows you to set a variety of packet definition options. The first criteria that is met causes the packet to be transmitted.
Page 102
Packet Forwarding Commands eof2 When enabled, creates a sequence of characters that must be received to define the end of the frame (if the EOF1 character is not immediately followed by the EOF2 character, the IOLAN waits for another EOF1 character to start the EOF1/EOF2 character sequence), which defines when the frame is ready to be transmitted.
Packet Forwarding Commands Show Packet-Forwarding Line Description Shows the packet-forwarding settings for the line. User Level Admin Syntax show packet-forwarding line <number> Line Commands 101...
Network Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s network parameters. SNMP Commands Add Community Description Adds an SNMP community (version 1 and version 2). User Level Admin Syntax add community <community_name> <config_host>|<IP_address> none|readonly|readwrite Options <community_name>...
SNMP Commands Delete Community Description Deletes an SNMP community (version 1 and version 2). User Level Admin Syntax delete community <config_community_number> Option <config_community_number> When you add an SNMP community, it gets assigned to a number. To delete the SNMP community, you need to specify the number of the community that you want to delete. To see which community is assigned to what number, type the Delete Trap Description Deletes an SNMP trap host.
Set SNMP V3-Security Description Configures SNMP settings for the Version 3 read-write and read-only user. User Level Admin Syntax set snmp v3-security readonly [auth-algorithm md5|sha1] [privacy-algorithm des|aes] [security-level none|auth/nopriv|auth/priv] set snmp v3-security readonly auth-password|privacy-password set snmp v3-security readwrite [auth-algorithm md5|sha1] [privacy-algorithm des|aes] [security-level none|auth/nopriv|auth/priv] set snmp v3-security readwrite auth-password|privacy-password...
TFTP Commands Show SNMP Description Shows SNMP settings, including communities and traps. User Level Admin Syntax show snmp TFTP Commands Set Server TFTP Description Configures the IOLANs TFTP client settings. User Level Admin Syntax set server tftp [retry <integer>] [timeout <integer>] Options retry The number of times the IOLAN will retry to transmit a TPFT packet to/from a host...
Set Host Description Configures a host in the IOLAN host table. User Level Admin Syntax set host <config_host> <IP_address> set host <config_host> fqdn <text> Options <config_host> The name of the host. <IP_address> The host IPv4 or IPv6 address. fqdn When you have DNS defined in the IOLAN, you can enter a DNS resolvable fully qualified domain name (note: FQDN’s are excluded as accessible hosts when Filtering Show Hosts...
DNS/WINS Commands Delete DNS Description Deletes a DNS entry. User Level Admin Syntax delete dns <config_dns_addr> Option < config_dns_addr You can view a list of configured DNS server IP addresses to choose from by typing delete dns ? Delete WINS Description Deletes a WINS entry.
Gateway Commands Delete Gateway Description Deletes a gateway. User Level Admin Syntax delete gateway <config_gateway_host> Option <config_gateway_host> You can view the configured gateways that can be deleted by typing delete gateway ? Set Gateway Description Configures the gateway. User Level Admin Syntax set gateway <config_gateway_host>...
Logging Commands Set Syslog Description Configures the system log. User Level Admin Syntax set syslog [level emergency|alert|critical|error|warning|notice|info|debug] [primary-host <config_host>] [secondary-host <config_host>] Options level Choose the event level that triggers a syslog entry: When you select a syslog entry. For example, if you select events will be logged.
RIP Commands RIP Commands Add RIP Description Adds a RIP MD5 key. After pressing value. User Level Admin Syntax add rip md5 <integer_md5_id> <start_date> <start_time> <end_date> <end_time> Options < integer_md5_id < start_date The start date that the MD5 key becomes valid. The date format is dependent on your system’s settings.
Set RIP Description Configures the RIP MD5 key. After pressing Enter, you will be prompted for the MD5 key value. User Level Admin Syntax set rip [authentication none|password|md5] [ethernet-mode none|send|listen|send-and-listen] set rip password set rip md5 <config_md5_id> [end <date> <time>] [start <date>...
IPsec Commands Show RIP Peers Description Shows current information about IPv4 or IPv6 RIP peers. User Level Normal, Admin Syntax show rip peers [ipv6] IPsec Commands Once there is an active VPN tunnel, the IOLAN expects all connections to be established through a VPN tunnel.
Page 117
Options authentication-method Specify the authentication method that will be used between VPN peers to authenticate the VPN tunnel. Data Options: Shared Secret—A text-based secret that is used to authenticate the IPsec tunnel (case sensitive). RSA Signature—RSA signatures are used to authenticate the IPsec tunnel. When using this authentication method, you must download the IPsec RSA public key to the IOLAN and upload the IPsec RSA public key from the IOLAN to the VPN gateway.
Page 118
IPsec Commands remote-external-ip-address When NAT Traversal (NAT_T) is enabled, the remote VPN’s public external IPv4 or IPv6 address or FQDN. If you want to accept a VPN connection from any host/network, you can enter in this field. %any remote-host-nextwork The IPv4 or IPv6 address of a specific host or the network address that the IOLAN will provide a VPN connection to.
email Up to a 64 character entry for an email address; for example, acct@anycompany.com. This field is case sensitive in order to successfully match the information in the remote X.509 certificate. An asterisk (*) works as a wildcard. secret When the secret word.
IPv6 Tunnels Set IPv6tunnel Description Configures the specified IPv6 tunnel. User Level Admin Syntax set ipv6tunnel <config_tunnel_name> [mode manual|teredo|6to4] [gateway <interface>] [remote-host <config_host>] Options mode The method or protocol that is used to create the IPv6 tunnel. Default: Manual gateway The interface that the IOLAN is going to use to access the Remote Host.
L2TP/IPsec Once L2TP/IPsec is enabled, the IOLAN expects all connections to be established through a VPN tunnel. To allows hosts to connect outside of the VPN tunnel, you must configure VPN exceptions, VPN Exceptions on page 119 Set L2TP Description User Level Admin Syntax set l2tp listen-for-l2tp on|off...
Page 122
L2TP/IPsec country A two character country code; for example, US. This field is case sensitive in order to successfully match the information in the remote X.509 certificate. An asterisk (*) works as a wildcard. state-province Up to a 128 character entry for the state/province; for example, IL. This field is case sensitive in order to successfully match the information in the remote X.509 certificate.
authentication-type Specify the authentication method that will be used for the L2TP tunnel. Data Options: CHAP, PAP, Both Default: Both Show LT2P Description Shows the L2TP settings. User Level Admin Syntax show l2tp VPN Exceptions VPN exceptions allows specific hosts or any host in a network to connect to the IOLAN outside of a VPN tunnel.
VPN Exceptions host-ip <ipv4/ipv6_address> The IP address of the host that will communicate with the IOLAN outside of the VPN tunnel. Field Format: IPv4 or IPv6 address Delete VPN Exception Description Deletes a VPN exception. To see a list of configured VPN exceptions, type delete vpn-exception ? User Level Admin Syntax...
Time Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s time parameters. Server Commands Set Time Description Sets the IOLAN’s system clock. User Level Admin Syntax set time <hh:mm[:ss]> Option <hh:mm[:ss]> Sets the IOLAN’s system time, using the 24-hour clock time format (00:00-23:59). Set Timezone Description Sets the IOLAN's time zone name and its offset from Greenwich Mean Time (UTC).
SNTP Commands SNTP Commands Add SNTP Description Adds an SNTP server. User Level Admin Syntax add sntp [server-1 <config_host>] [server-2 <config_host>] Options server-1 The name of the primary SNTP server from the IOLAN host table. Valid with broadcasts from the specified host SNTP server. server-2 The name of the secondary SNTP server from the IOLAN host table.
server-1 The name of the primary SNTP server from the IOLAN host table. Valid with broadcasts from the specified host SNTP server. server-2 The name of the secondary SNTP server from the IOLAN host table. Valid with Unicast broadcasts from the specified host SNTP server. version Version of SNTP.
Time/Date Setting Commands offset The offset from UTC for your local time zone. Specify in the format of hours hh (valid -12 to +14) and minutes mm (valid 0 to 59 minutes) for the offset from UTC. Set Summertime Fixed Description Sets the summertime clock to start on the same date each year, for example, April 15 at 1:00 pm.
end-time The time to end summer time and start standard time; uses the format hh:mm for a 24-hour clock (00:00-23:59). end-week The week to end summer time and start standard time. Show Date Description Shows the date, according to the IOLAN system clock. User Level Normal, Admin Syntax show date...
Administration Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s administration parameters. Bootup Commands Reboot Description Reboots the IOLAN. You will be prompted to save configuration to FLASH, if there have been unsaved configuration changes. User Level Admin Syntax reboot Reset...
TFTP File Transfer Commands Set Bootup Description Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot. User Level Admin Syntax set bootup firmware host <hostname> [file <path_filename>] set bootup configuration host <hostname> [file <path_filename>] Options firmware file The path and file name, relative to the default path of your TFTP server software, of the...
configuration Specifies that you are going to download a new configuration file to the IOLAN. customlang Specifies that you are going to download a custom language file to the IOLAN. term1|term2|term3 You can create and download up to three custom terminal definitions to the IOLAN. customapp-file You can download multiple SDK program executables and ancillary files using this command by running the command multiple times to download multiple files.
Custom Factory Default <filename> The complete path and file name for the file you are uploading from the IOLAN (this path should be relative to the default path of your TFTP server, which may or may not allow drive letters). Custom Factory Default Netload Description Transfers a file from a remote host to the IOLAN using the TFTP protocol.
Keys and Certificates Commands ipsec <tunnel_name> When you configure an IPsec tunnel with an Signature IOLAN for that specific tunnel. < hostname Enter the host or IP address that contains the certificate/key you are downloading to the IOLAN. If you are using a host name, If you are using a host name, it must be resolved in either the IOLAN’s <...
MOTD Commands Set MOTD Description Specifies the server/file that contains the message of the day (MOTD) that is displayed when users log into the IOLAN. You can also retrieve the MOTD from a local file (it must already be downloaded to the IOLAN using the command);...
Statistics Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s statistics parameters. Configuration Statistics Show Netstat Description Shows currently used TCP/UDP sockets/ports. User Level Admin Syntax show netstat [all] [listening] [tcp] [udp] [tcpv6] [updv6] Options Displays all ports, including server (listening) ports; by default, listening ports are not displayed.
Run-Time Statistics Show Modbus Statistics Description Shows the Modbus statistics. User Level Admin Syntax show modbus statistics master-tcp line *|<number> show modbus statistics master-udp line show modbus statistics slave-tcp line show modbus statistics slave-udp line *|<number> Show Routes Description Shows current information about IPv4 or IPv6 network routes. User Level Admin Syntax show routes [ipv6]...
IOLAN+ User Commands You can configure the IOLAN using the IOLAN+ menu. See the IOLAN+ User’s Guide for the command line interface and menu parameters. See IOLAN+ Interface in the IOLAN User’s Guide for a list of changes to the IOLAN+ menu. IOLAN+ Description Displays the IOLAN+ configuration menu.
Page 142
IOLAN+ IOLAN SDS/SCS/STS CLI Reference Guide, Version 3.6...
I/O Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s I/O parameters. Global I/O Commands Set IO UDP Description Sets the UDP settings for I/O unicast messages. User Level Admin Syntax set io udp [mode on|off] [broadcast-interval <broadcast_interval>] set io udp entry 1|2|3|4 disabled set io udp entry 1|2|3|4 <udp_port>...
Set Line Set IO Failsafe Description Sets the failsafe (watchdog) settings for I/O. User Level Admin Syntax set io failsafe [mode on|off] [timeout <seconds>] Options mode Enables/disables the Failsafe Timer. This is the global setting that must be enabled to set the Failsafe Action on the channel for digital outputs and relays.
Set IOChannel Set IOChannel Mode Description Sets general I/O channel settings for the specified channel, these settings are available to all channels and I/O serial pins. User Level Admin Syntax set iochannel <i/o_channel> [mode enabled|disabled] [description <string>] Options i/o_channel Specify the channel number, for example, d2 or a4. Temperature models use Analog input, so the channel numbers are a1-a4.
Set IOChannel Set IOChannel Digital Input Description Sets the Digital input settings for the channel. User Level Admin Syntax set iochannel <digital_channel> [alarm [trigger disabled|inactive-input|active-input] [description <string>] [invert-signal on|off] [latch disabled|inactive-to-active|active-to-inactive] Options digital_channel Specify the Digital channel number, for example, d2. alarm Configures alarm settings when the Digital input trigger is activated.
Set IOChannel Digital Input (Serial Pins) Description Sets the Digital input settings for serial pins CTS, DSR, and DCD. This option is only available when the User Level Admin Syntax set iochannel cts|dsr|dcd [alarm [trigger disabled|inactive-input|active-input] [description <string>] [invert-signal on|off] [latch disabled|inactive-to-active|active-to-inactive] Options digital_channel...
Set IOChannel latch Latches (remembers) the activity transition (active-to-inactive or inactive-to-active). The latched status is maintained until it is read. Once it is read, it will revert to the current status. The default is disabled. Set IOChannel Digital Output Description Sets the Digital output channel settings. User Level Admin Syntax set iochannel <digital_channel>...
output Specify how the channel output will be handled: The default is pulse When the pulse Continuous active-to-inactive-delay When the I/O is commanded to an inactive state, this is the length of the delay before the command is executed. Valid values are 1-9999 x 100 ms. The default is 100 ms. inactive-to-active-delay When the I/O is commanded to an active state, this is the length of the delay before the command is executed.
Set IOChannel Set IOChannel Relay Description Sets the Relay output channel settings. User Level Admin Syntax set iochannel <relay_number> output [pulse continuous|counted <pulse_count>] [active-to-inactive-delay <delay>] [inactive-to-active-delay <delay>] set iochannel <relay_number> [active-signal-width <width>] [inactive-signal-width <width>] [failsafe-action none|activate|deactivate] Options relay_number Specify the Relay channel number, for example, r2. output Specify how the channel output will be handled: The default is...
Set IOChannel trigger-level Specify the value that will trigger an alarm, the measurement is based on the Range clear an alarm. clear-mode Specifies whether an activated alarm must be the input drops below the specified value (when the specified value (when clear-level Specify that value that will clear an alarm, the measurement is based on the Range...
Page 153
range Specify the temperature range that you want to measure. For RTD, the range is: 1 (Pt100 a=385 -50 to 150C) This is the default. 2 (Pt100 a=385 0 to 100C) 3 (Pt100 a=385 0 to 200C) 4 (Pt100 a=385 0 to 400C) 5 (Pt100 a=385 -200 to 200C) 6 (Pt100 a=392 -50 to 150C) 7 (Pt100 a=392 0 to 100C)
Set IOChannel clear-mode Specifies whether an activated alarm must be the input drops below the specified value (when the specified value (when clear-level Specify that value that will clear an alarm, the measurement is based on the Range trigger an alarm. email Sends an email alert to an email account(s) set up in the Server settings (the Alert...
Page 155
enabled When enabled, the digital input channel or DSR/DCD/CTS input serial signal pins can be connected to: A Digital output or relay (if the I/O model supports relay) channel on the same IOLAN Output Serial Signal Pins (DTR/RTS) A Digital output channel on another IOLAN(s) or output serial signal pins (DTR/RTS) on another IOLAN(s) A TCP/IP application(s) running on a host on the network When enabled, the digital output/relay channel or DTR/RTS output serial signal pins...
Set IOChannel server-initiated tcp-port The TCP Port that the channel/serial signal pin will use to communicate to another IOLAN or a TCP/IP application. Default: 2000 for channel 1, then increments by one for each channel server-initiated multihost all|backup <config_backup_host> <tcp_port>|none Used for connections going from the Digital input channel or input serial signal pins, allows the input channel/serial signal pin to communicate to either all the hosts in the multihost list or a primary/backup host schema (see Configuring Multiple Hosts in the...
Set IOChannel IOExtension SSL Description Configures the secure SSL/TLS connection between the Digital/Relay I/O channel or serial signal pin and the host/IOLAN. For an explanation of the parameters, see Line on page User Level Admin Syntax set iochannel <channel> ioextension ssl [enabled on|off] [use-server on|off] [version any|tslv1|sslv3] [type client|server] [verify-peer on|off] [validation-criteria country <code>|state-province <text>|...
I/O Channel Control Commands Show IO Description Shows global I/O information (for example, UDP, TruePort, Modbus). Temperature I/O is Analog. User Level Admin Syntax show iochannel <i/o_channel> show iochannel rts|cts|dtr|dsr|dcd Options i/o_channel Specify the channel number, for example, d2 or a4. Temperature models use Analog input, so the channel numbers are a1-a4.
Power Commands This chapter defines all the CLI commands associated with configuring the IOLAN’s power parameters. Power Commands Description Actively controls the RPS plug power. User Level Admin, Normal Syntax power cycle line <number> [plug <number|range|*>] power on line <number> [plug <number|range|*>] power off line <number>...
Page 162
Power Commands IOLAN SDS/SCS/STS CLI Reference Guide, Version 3.6...
Page 163
Glossary This chapter provides definitions for IOLAN terms. BOOTP (BOOTstrap An Internet protocol that enables a diskless workstation to discover its own IP address, the IP Protocol) address of a BOOTP server on the network, and a file to be loaded into memory to boot the machine.
Page 164
PAP (Password Standard authentication protocol for PPP connections. see CHAP Authentication Protocol) RADIUS (Remote An open standard network security server that communicates with the PAP protocol. Authentication Dial In Users Services) Reverse Connection Connections that originate from a host that go directly to a serial device through the IOLAN. RIP (Routing A protocol that allows gateways and hosts to exchange information about various routes to Information Protocol)
Need help?
Do you have a question about the IOLAN CSS and is the answer not in the manual?
Questions and answers