Go to page of
A good user manual
The rules should oblige the seller to give the purchaser an operating instrucion of Perle Systems 5500208-41, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.
What is an instruction?
The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Perle Systems 5500208-41 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.
Unfortunately, only a few customers devote their time to read an instruction of Perle Systems 5500208-41. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.
What should a perfect user manual contain?
First and foremost, an user manual of Perle Systems 5500208-41 should contain:
- informations concerning technical data of Perle Systems 5500208-41
- name of the manufacturer and a year of construction of the Perle Systems 5500208-41 item
- rules of operation, control and maintenance of the Perle Systems 5500208-41 item
- safety signs and mark certificates which confirm compatibility with appropriate standards
Why don't we read the manuals?
Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Perle Systems 5500208-41 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Perle Systems 5500208-41, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Perle Systems service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Perle Systems 5500208-41.
Why one should read the manuals?
It is mostly in the manuals where we will find the details concerning construction and possibility of the Perle Systems 5500208-41 item, and its use of respective accessory, as well as information concerning all the functions and facilities.
After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.
Table of contents for the manual
-
Page 1
IOLAN DS1/TS2 Command Line Interface Reference Guide Version 4.1 Part #5500208-41 October 2009[...]
-
Page 2
Copyright S tatement This document must not be repro duced in any way whatsoever , either printed or electronicall y , without the consent of: Perle Systems Limi ted, 60 Renfrew Drive Markham, ON Canada L3R 0E1 Perle reserves the right to make change s without further notice, to any products to improve reliability , function, or design. Perle, the [...]
-
Page 3
IOLAN DS1/TS2 CLI Refere nce Guide, V ersion 4.1 3 Preface ........................ ....................................................... 11 About This Book .............. .................................... ...................... 11 Intended Audience .......... .................................... ...................... 11 Typeface Conventions [...]
-
Page 4
4 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Server ............. ................................................. ................ .............. 20 Hardware Commands ........... .............................. ........................ 20 Set Ethernet ......... ........................................................... .............. ..[...]
-
Page 5
5 Show Sessions ................... ............................ .............. ............... ........... 30 Show Termtype .......... ................ .................................................. ........... 30 Start ................ ................................. .............................. ............... ........... 30 Telnet .....[...]
-
Page 6
6 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Interface ......... ................ ................................................. .............. 55 Show Modbus............. ................................................. ................. ........... 55 Show Telnet-Client..... ................................. ........................[...]
-
Page 7
7 Set Gateway .......... ............................ ............................ ............... ........... 65 Show Gateways ........... ................................. ................ ............... ........... 65 Logging Commands .............. .............................. ...................... 66 Set Syslog ........... ................[...]
-
Page 8
8 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Set MOTD ......... ................................................. ............................ ........... 73 Show MOTD ................ ................. ................................ ................. ........... 73 Chapter 8 Statistic Commands ........................................ 75 Con[...]
-
Page 9
9 Set IOChannel IOExtension ..... ............... ................................. .............. 88 Set IOChannel Multihost ......... ................................. ................ .............. 90 Show IOChannel Status ........ .......................................... .............. ......... 90 Kill IOChannel ............ ...............[...]
-
Page 10
10 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1[...]
-
Page 11
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 1 1 Preface About This Book This guide provides the information you need to configure the IOLAN using the Comm and Line Interface (CLI). Intended Audience This guide is for adm inistrators who w ill be configuring th e IOLAN. Some prerequisite knowledge is needed to understand the concep ts and examp[...]
-
Page 12
Contacting T echnical Support 12 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Cont acting T echnical Support Making a T echnical Support Query Who T o Cont act Note: Perle offers free technical suppo rt to Perle Authori sed Distributors and Registered Perle Resellers. If you bought your produ ct from a registered Perle supplier , you must contac[...]
-
Page 13
13 Contacting T echnical Support Rep air 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 direct ly . Customers who are in Europe, Afri ca or Middle East can submit repair d etails via a websit e form. This form is on the Perle website, www [...]
-
Page 14
Contacting T ech nical Support 14 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1[...]
-
Page 15
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 15 Introduction Chapter 1 1 Introduction This chapter provides the command line interface (CLI) options availabl e for the IOLAN. The commands are grouped by function. CLI Conventions This section explains how to interp ret the CLI synt ax.If you are an existing T erminal Server customer and would li[...]
-
Page 16
CLI Conventions 16 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 z Options —Provides an explanation of each of the op tions for a command and the default value if there is one. Some commands do not have any option s, so this category is absent. Command Shortcut s When you type a command, you can specify the shortest unique ve rsion of that comm[...]
-
Page 17
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 17 Server Commands Chapter 2 2 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s server parameters. Server Commands Set Custom-App Description Y ou can create a custom application that can run on the IOLAN using the Perle SDK. User Level Admin Syntax Options pr og[...]
-
Page 18
Server Commands 18 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 banner This parameter concerns the b anner informa tion (product name/so ftware version). This banner information is presente d to a user with a login prompt. For security reasons, you can turn off the display of this information. The default is Off . break Enables/disables the exis[...]
-
Page 19
19 Server Commands Set Service promp t-with-name Displays the Server Name field value instead of defau lt product name. When enabled, the Server Name is displaye d in the IOLAN login prompt, CLI prompt, W ebManager login screen, and the heading of the Menu. The default valu e is Off . single-telnet In this mode of operation, the IOLAN will only all[...]
-
Page 20
Hardware Commands 20 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Custom-App Description Shows the custom appli cation server settings. User Level Admin Syntax Show Modbus Description Shows the Modbus settings for the gateway . User Level Normal, Admin Syntax Show Server Description Shows the parameters set for the server . User Level Admin[...]
-
Page 21
21 Modbus Commands Modbus Commands Set Modbus Gateway Description Sets the Modbus parameters for the IOLA N wh en it is operating as a Modbus Gateway . User Level Admin Syntax Options addr -mode broadcast char -timeout req-next -delay exceptions idle-timer mess-timeout port req-qu euing rem ap p ed -i d set modbus gateway [addr-mode embedded|re-map[...]
-
Page 22
T ruePort Baud Commands 22 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Modbus Description Displays the Modbus Gateway parameters. User Level Admin Syntax T ruePort Baud Commands Set T ruePort Remap-Baud Description This command allows for the remapping of th e baud rate being specified by the Serial application to a different value on th e[...]
-
Page 23
23 IPv6 Commands IPv6 Commands Set IPv6 Description Configures the basic IPv6 settings. User Level Admin Syntax Options dhcpv6-settings ivp6-addr ess network-prefix enable-ipv 6-addr essing obtain-using auto-ipv6|dh cpv6 z auto-ipv6 —When enabled, the IOLAN will send out a Router Solicitation message. If a Router Advert isement message is receive[...]
-
Page 24
IPv6 Commands 24 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Add Custom-IPv6 Description Adds a custom IPv6 address to the IOLAN. Y ou can specify either a complete IPv6 address or an IPv6 network address. User Level Admin Syntax Options met hod auto network-prefix prefix-bits (auto) method manual ipv6-addr ess prefix-bits (manual) Set Custom-[...]
-
Page 25
25 IPv6 Commands Delete Custom-IPv6 Description Deletes the specified custom IPv6 address. T o see a list of configured IPv6 addresses, type the command delete custom-ipv6 ? . User Level Admin Syntax prefix-bits (auto) Specify the network prefix bits for the IPv6 address. Range: 0-64 Default: 64 method manual Specify this option when you want to en[...]
-
Page 26
IPv6 Commands 26 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1[...]
-
Page 27
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 27 User Commands Chapter 3 3 This chapter defines all the CLI commands avai lable 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 Enter after you type this command, you will be prompted f[...]
-
Page 28
Commands for Users Logged Into the IOLAN 28 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Menu Description Switches from a command line based interface to Menu mode of operation. User Level Restricted, Normal, Admin Syntax Ping Description This command checks to see if a given host is reachable via an IP me ssage. The specific message used is ca[...]
-
Page 29
29 Commands for Users Logged Into the IOLAN Set User Description Sets the current users settings. User Level Normal, Admin Syntax Options hotkey-p refix language password Set User Session Description Sets the current users session settings. User Level Normal, Admin Syntax Options sess ion Specifies the session number (or a ll, *) that you are confi[...]
-
Page 30
Commands for Users Logged Into the IOLAN 30 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Line Users Description Shows the users who are on the line. User Level Admin Syntax Syslog Console Description Starts/stops or displays the status of the syslog console. User Level Admin Syntax Options start|stop Star t or stop console lo gging. Whe n [...]
-
Page 31
31 Commands for Users Logged Into the IOLAN Te l n e t Description Starts a telnet session to the specified host/IP address. User Level Normal, Admin Syntax telnet < hostname/IP_address > [< tcp_por t >] [termtype < terminal_name >] [line-mode on|off] [map-cr-crlf on|off] [local-echo on|off] [echo <00-7f>] [eof <00-7f>[...]
-
Page 32
Configuring Users 32 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Ve r s i o n Description Displays firmware version and build . User Level Normal, Admin Syntax Configuring Users Add User Description Adds a user . For units with 4 or less serial ports, you can configure up to 4 users. For units with 8 or mor e serial por ts, the maxi mum number[...]
-
Page 33
33 Configu ring Users hotkey-pre fix The prefix that a user types to control the current session. The default value is hex 01 , which corresponds to Ctrl-a ( ^a ) (hex value 02 would be Ctrl-b (^b), etc. ): z ^a number —T o switch from one session to another , press ^a and then th e required session number . For example, ^a 2 would switch you to [...]
-
Page 34
Configuring Users 34 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 line-access Specifies the user access rights to each IOLAN device line. Options are: z Read/Write —Users are given read an d write access to the line. z Read In —Users are given access to read only outbound dat a, data that is going from the IOLAN to the device. The on|off op[...]
-
Page 35
35 Configu ring Users Set User Description Sets users settings. Normal-level users can configure only t heir own settings. Admin-level users can configure any users settin gs, including their own (with the exception of their User Level, which must st ay at Admin). User Level Normal, Admin Syntax set user . [hotkey-prefix <00 -7f>] [language e[...]
-
Page 36
Configuring Users 36 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 level The access that a user is allowed: z Admin —The admin level user has total access to the IOLAN. Y ou can create more than one admin user account but we recomm end that you only have one. They can monitor and configure t he IOLAN. z Normal —The Normal level user has limi[...]
-
Page 37
37 Configu ring Users Set User Session Description Configures a users session settings. See Set User Ses sion on page 29 for the options descriptions. User Level Admin Syntax Show Default User Description Shows the Default Users settings. When addi ng a new user , th e profile of the default user will be used to assign the values of the parame ters[...]
-
Page 38
Configuring Users 38 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1[...]
-
Page 39
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 39 Line Commands Chapter 4 4 This chapter defines all the CLI commands associat ed with configuring the IOLAN ’ s line parameters. 1-Port vs. 2-Port Line Commands If you are using a DS1 IOLAN, the admin user does not have the option of using the number or all (*) options in the line comman ds, as t[...]
-
Page 40
Line Commands 40 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Options br eak Specifies how a break is interpreted: z off —The IOLAN ignores the break key completely and it is not passed through to the host. This is the default setting. z local —The IOLAN deals with the break locally . If the user is in a session, the break key has the same [...]
-
Page 41
41 Line Commands hotkey-pre fix The prefix that a user types to lock a line or redraw the Menu. The default value is h ex 01 , which corresponds to Ctrl-a ( ^a ) (hex value 02 would be Ctrl-b (^b), etc.): z ^a l —(Lowercase L) Locks the line until the us er unlocks it. The user is prompted for a password (any password, excluding spaces) and locks[...]
-
Page 42
Line Commands 42 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 lock When enabled, the user can lock hi s terminal with a password using the Hotkey Prefix (default Ctrl-a) ^a l (lowercase L). The IOLAN prompts the user for a password and a confirmation. mode Enables/disables the line (ava ilable only on the TS2 model). The default is enabled. mod[...]
-
Page 43
43 Line Commands sess-timer Enter a time, in seconds, for w hich the Session Timer will run. Use th is timer to forcibly close the session (connection). When the Session T imer expires, the IOLAN will end the connection. The default value is 0 seconds so the port will never timeout. The maximum value is 4294967 seconds (ab out 49 days). stop-bits S[...]
-
Page 44
Line Commands 44 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Line Interface Description Configures line interface (hardware) parameters. User Level Admin Syntax set line .|< number >|* interfa ce eia-232 [monitor-dcd on|off] [monitor-dsr on|off] [flow none|soft|hard|both] [speed 50|75|110|134|150|200|300|600| 1200|1800|2400|4800|9600[...]
-
Page 45
45 Line Commands Set Line Service echo-suppression This parameter applies only to EIA-485 Half Duplex mode. All characters will be echoed to the user and transmitted across the serial port s. Some EIA-485 applications require local echo to be enabled in order to monitor the loopback data to determine that line contentio n has occurred. If your appl[...]
-
Page 46
Line Commands 46 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 < host_port > The port number the target host is listening on for incoming connections. direct Direct connections b ypass the IOLAN, enabling the user to log straight into a specific host. A direct connectio n is recommended where a user loggi ng in to the IOLAN is not required[...]
-
Page 47
47 Line Commands Set Modem Description Sets the modem initialization string fo r a modem defined in the modem table. If you wish to add a new modem, use the add modem command. User Level Admin Syntax Options < mod em_name > Predefined modem name. < init_string > Specify the initialization string for the m odem. Th is c an b e up to 60 c[...]
-
Page 48
Line Service Commands 48 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set T ermtype Description Sets the terminal type for th e current terminal session. term1, term2, and term3 refer to the user-uploadable custom terminal definitions . If these are not present, the default is wyse60. User Level Restricted, Normal, Admin Syntax Option wyse60|vt[...]
-
Page 49
49 Line Service Commands Set T elnet-Client Description Configures the T elnet parameters for the sp ecified line. When the IOLAN initiates a T elnet connection to a host, it is acting as a T elnet client. User Level Normal, Admin Syntax Options termtype line-mode map-cr -crlf local-echo echo eof erase intr quit escape set telnet-client line .|<[...]
-
Page 50
Line Service Commands 50 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set UDP Description Configures the UDP settings for the serial line. User Level Normal, Admin Syntax Options entry 1|2|3|4 Selects which of the 4 available entries we wish to define/modify . For each entry the user can specify a dif ferent IP address ra nge, UDP port and dire[...]
-
Page 51
51 Line Service Commands Set Vmodem Description This command associates a phone number w ith an IP address and TCP p ort. This enables an existing modem application to i ssue a dial command with a phone number . The phone number will be searched in this table and if an exact match is found, the associated IP address and TCP port will be used to est[...]
-
Page 52
Line Service Commands 52 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Vmodem-Phone signals dtr Y ou can specify how the DTR signal pin acts during your modem application connection, as itself (DTR), as DCD, or as RI. signals rts Y ou can specify how the R TS signal pin acts duri ng your modem application connection, as itself (R TS), as DCD[...]
-
Page 53
53 Line Service Commands Set Modbus-Slave Line Description Sets the Modbus slave pa rameters for the line. User Level Admin Syntax Options crlf protocol uid-range Set Modbus-Master Line < IP_address > Specify the IP address of the remote hos t that is receiving the vmodem connection. < TCP_port > Specify the TCP port that the remote hos[...]
-
Page 54
Line Service Commands 54 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Multihost Line Description Configures multiple hosts or a prim ary/back up host schema fo r Silent Raw , Reverse Raw , or Client-Initi ated T ruePort servi ce types (multihost must be enabled by the line service type for this to take effect, see Set Line Service on page 4[...]
-
Page 55
55 Line Service Commands Show Custom-App Description Shows the custom application line settings. User Level Admin Syntax Show Interface Description Shows the network interface information. User Level Admin Syntax Show Modbus Description Shows the Modbus settings for a line. User Level Admin Syntax Show T elnet-Client Description Shows the telnet cl[...]
-
Page 56
Modem Commands 56 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Modem Commands Add Modem Description Adds a modem. User Level Admin Syntax Options < mod em_name > < initialization_ string > Delete Modem Description Deletes a modem. User Level Admin Syntax Option < config_modem_name > Y ou can see a the list of modems that can b[...]
-
Page 57
57 Packet Forwarding Commands 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 LA N network. This command configures packet forw arding options for serial devi ces attached to the serial l[...]
-
Page 58
Packet Forwarding Commands 58 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 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. For example, if you set a Force Tr a n s m i t T i m e r of 1000 ms and a Packet Size of 100 bytes, whiche[...]
-
Page 59
59 Packet Forwarding Commands Show Packet-Forwarding Line Description Shows the packet-forwarding settings for the line. User Level Admin Syntax force-transmit-timer When the specified amount of time, in milliseconds, elapses after the first character is received from the serial port, th e packet is transmitted. After a packet is transmitted, the n[...]
-
Page 60
Packet Forwarding Commands 60 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1[...]
-
Page 61
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 61 Network Commands Chapter 5 5 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s network parameters. SNMP Commands The IOLAN supports SNMP traps for restar t and SNMP communi ty authentication error . Add Community Description Adds an SNMP community (version 1 an[...]
-
Page 62
SNMP Commands 62 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Delete Community Description Deletes an SNMP community (version 1 and version 2). User Level Admin Syntax Option < config_community_number > When you add an SNMP communi ty , it gets assigned to a number . T o delete the SNMP community , you need to specify the number of the co[...]
-
Page 63
63 TFTP Commands TFTP Commands Set Server TFTP Description Configures the IOLANs TFTP client settings. User Level Admin Syntax Options retr y timeout Host s Commands Add Host Description Adds a host to the IOLAN host table. User Level Admin Syntax Options < hostname > < ip_address > Delete Host Description Deletes a host from the IOLAN [...]
-
Page 64
Gateway Comma nds 64 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Host s Description Shows the IOLAN host table. User Level Normal, Admin Syntax Gateway Commands Add Gateway Description Adds a gateway . Y ou can configure up to twenty gateways. User Level Admin Syntax Options < config_host > default|host|network < dest_IP_addr >[...]
-
Page 65
65 Gateway Commands Set Gateway Description Configures the gateway . User Level Admin Syntax Options < config_gateway_host > Y ou can view the configured gateways that can be d eleted by typing delete gateway ? . default|host|network < destinati on_ip > < prefixbits_mask > When the gateway is a Network gateway , you must specify t[...]
-
Page 66
Logging Comma nds 66 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Logging Commands Set Syslog Description Configures the system log. User Level Admin Syntax Options level primary-host secondary-host Show Syslog Description Shows the syslog settings. User Level Admin Syntax set syslog [level emergency|alert|cr itical|error|warning|notice|info|de[...]
-
Page 67
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 67 T ime Commands Chapter 6 6 This chapter defines all the CLI commands a ssociated with configuring the IOLAN’ s time parameters. T ime Commands Set T ime Description Sets the IOLAN’ s system clock. User Level Admin Syntax Option < hh : mm [: ss ]> Sets the IOLAN’ s system time, using mi[...]
-
Page 68
T ime/Date Setting Command s 68 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Date Description Shows the date, according to the IOLAN system clock. User Level Normal, Admin Syntax Show Time Description Shows the IOLAN’ s system clock. User Level Normal, Admin Syntax show date show time[...]
-
Page 69
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 69 Administration Commands Chapter 7 7 This chapter defines all the CLI commands associ ated with configuring the IOLAN ’ s ad ministration parameters. Bootup Commands Reboot Description Reboots the IOLAN. Y ou wi ll be prompted to save configurat ion to FLASH, if there have been unsaved configu ra[...]
-
Page 70
Bootup Commands 70 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Bootup Description Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot. User Level Admin Syntax Options firmwar e file configuration file host The host name or IPv4/IPv6 address of the se rver that contains t he configurati on or firmware fil[...]
-
Page 71
71 TFTP File T ransfer Commands TFTP File T ransfer Commands Netload Description T ransfers a file from a remote host to the IOLAN using the TFTP protocol. User Level Admin Syntax Options text-config Specify this option i f you are uploading a text-based configuration file to the IOLAN from a TFTP server . factory-defa ult-config firmware Specifies[...]
-
Page 72
Custom Factory Default 72 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Net save Description T ransfers a file from the IOLA N to a remote host using the TFTP protocol. User Level Admin Syntax Options configurat ion Specifies that you are going to upload a co nfiguration file from the IOLAN to the specified host or IP address. crash Specifies th[...]
-
Page 73
73 MOTD Commands Set Description Sets the current configuration on IOLAN to act as the factory default configuration. See the User Guide for dir ections on ho w to rever t b ack to the original facto ry default configuration, if required. User Level Admin Syntax MOTD Commands Set MOTD Description Specifies the server/file that contains the mes sage[...]
-
Page 74
MOTD Commands 74 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1[...]
-
Page 75
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 75 S t atistic Commands Chapter 8 8 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s statistic parameters. Configuration S t atistics Show Net stat Description Shows currently used TCP/UDP sockets/ports. User Level Admin Syntax Options all Displays all ports, inc[...]
-
Page 76
Run-T i me S tatistics 76 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Net st at S tatistics Description Shows protocol (IP/IC MP/TCP/UDP) counters. User Level Admin Syntax Show Routes Description Shows current information about IPv4 or IPv6 network routes. User Level Admin Syntax Run-T ime St atistics Delete Arp Description Delete entries[...]
-
Page 77
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 77 I/O Commands Chapter 9 9 This chapter defines all the CLI commands associat ed with configuring the IOLAN’ s I/O parameters. Global I/O Commands Set IO UDP Description Sets the UDP settings fo r I/O unicast messages. User Level Admin Syntax Options mode broadcast-interval entry Y ou can specify [...]
-
Page 78
Set Line 78 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IO Failsafe Description Sets the failsafe (watchdog) settings for I/O. User Level Admin Syntax Options mode timeout Set IO Modbus Description Enabling the Modbus option makes the IOLAN act as a Modb us Slave, allowing Modbus Masters to communicat e with the IOLAN to control and/or ret[...]
-
Page 79
79 Set IOChannel Set IOChannel Set IOChannel Mode Description Sets general I/O channel set tings for the sp ecified channel, these settings are available to all channels and I/O serial pins. User Level Admin Syntax Options i/o_channel Specify the channel number , for example, d2 or a4. T emperature models use Analog input, so the channel numbers ar[...]
-
Page 80
Set IOChannel 80 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Digit al Input (Serial Pins) trigger When the trigger con dition is met, tr iggers the specified alarm action. T riggers can be: z Disabled —No alarm settings. This is the default. z Inactive —When the expected Digital input is active, going inactiv e will trigger a[...]
-
Page 81
81 Set IOChannel Set IOChannel Digit al Output trigger When the trigger con dition is met, tr iggers the specified alarm action. T riggers can be: z Disabled —No alarm settings. This is the default. z Inactive —When the expected Digital input is active, going inactiv e will trigger an alarm. z Active —When the expected Digital input is in act[...]
-
Page 82
Set IOChannel 82 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 type Specify the type of digital output: z Sink —Specifies that the channel will be grounded when active. z Sourc e —Specifies that the channel wi ll provide voltag e when active. z Sink and Sour ce —Specifies that channel will be grounded when it is inactive and will provide v[...]
-
Page 83
83 Set IOChannel Set IOChannel Digit al Output (Serial Pins) Description Sets the Digital output for serial pins R TS and DTR. This option is only availa ble when the Line Service is set to Signal I/O . User Level Admin Syntax Options des cription failsafe-action mode Set IOChannel Relay set iochannel rts|dtr [descri ption < string >] [failsa[...]
-
Page 84
Set IOChannel 84 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Analog (T rue Analog) active-to-inactive-delay When the I/O is commanded to an inactive state, this is the len gth of the delay b efore the command is executed. V alid values are 1-9999 x 10 0 ms. The default is 100 ms. inactive-to-active-delay When the I/O is commanded[...]
-
Page 85
85 Set IOChannel alarm Configures alarm settings when the Analog input trigger is activated. level Y ou can specify up to five alarm tr igger/clear severity levels. If the Tr i g g e r Ty p e is Low , an alarm is triggered when th e input drops below the specified T rigger value; other severity level trigger va lues must decrease in value with each[...]
-
Page 86
Set IOChannel 86 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Analog (T emperature) Description Sets the Analog input channel se ttin gs for T emperature models. User Level Admin Syntax set iochannel < analog_channel > type r td|thermocouple range < range_specifier > set iochannel < analog_channel > alarm [level [...]
-
Page 87
87 Set IOChannel level Y ou can specify up to five alarm tr igger/clear severity levels. If the Tr i g g e r Ty p e is Low , an alarm is triggered when th e input drops below the specified T rigger value; other severity level trigger va lues must decrease in value with each subsequent level. If the Tr i g g e r Typ e is High , an alarm is triggered[...]
-
Page 88
Set IOChannel 88 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel IOExtension Description Configures the I/O extension options that allo w you to connect the Digital Input channel or input serial signal pin (when the line is confi gured for signal-io) to Digital Output/Relay channels or outp ut serial signal pins (when the line is con[...]
-
Page 89
89 Set IOChannel connection-method The connection-metho d is one of the following: z Client-Initiated —When specified, the channel/seri al signal pin will wait for connections to be initiated by an othe r I/O channel or a TCP/IP application. z Server -Initiated —When specified, the channel/serial signal pin initiates communication to another I/[...]
-
Page 90
Set IOChannel 90 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Multihost Description Configures up to 49 hosts/IOLANs that the Di g ital input channel or input serial signal pins (DSR, DCD, or CTS-when the line is configured for signal -io) will connect to. T o see a list of configured hosts/IO LANs, enter the show iochannel < c[...]
-
Page 91
91 Set IOChannel Show IO Description Shows global I/O information (for example, UDP , TruePort, Modbus). T emperature input is Analog. User Level Admin Syntax Options i/o_channel Specify the channel number , for example, d2 or a4. T emperature models use Analog input, so the channel numbers are a1-a4. rts|cts|dtr|dsr|dcd Specify the Digital output [...]
-
Page 92
I/O Channel Control Commands 92 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 I/O Channel Control Commands The I/O commands in this section are used to manual ly manage the I/O channels. Digit al Output Description Manages the Digital output channel status. No t all models have four digital channels, most have just two. User Level Admin Syntax O[...]
-
Page 93
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 93 Glossary This chapter provides definitions for IOLAN terms. BOOTP (BOOT strap Protocol) An Internet protocol that enables a diskless workstation to discover its own IP address, the IP address of a BOOTP server on the network, and a file to be loaded into memory to boot the machine. This enables th[...]