Home

Perle Systems 5500208-41 User's Manual

1. 83 S t IDCRAannel Relay UI kk rar gees 83 Set IOChannel Analog True Analog 84 Set IOChannel Analog Temperature 1 1 86 8 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel IOExtension 88 Set IOChannel Multihost 90 Show IOChannel Status 90 EIERE 90 Show lO u ss umu eee 91 Show lOChannel u 91 UO Channel Control Commands 92 Alte uge EE 92 Digital NOUN E ti U III des delo TY ss sasssssssasssssaiassaqs 92 leet 92 Analog OO UN LLULLU a eee ee eae aa 92 10 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 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 e Ifyou are using an external authentication application s working knowledge of the authentication application s e Knowledge of TFTP the transfer protocol the IOLAN u
2. initial cli menu keepalive on off lock on off mode enabled disabled motd on off reset on off dial timeout number dial retries number single character on off user name nouser internet address IPv4 address hotkey prefix user lt config user IOLAN DS1 TS2 CLI Reference Guide Version 4 1 39 Line Commands 40 Options break Specifies how a break is interpreted e off The IOLAN ignores the break key completely and it is not passed through to the host This is the default setting e 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 e remote When the break key is pressed the IOLAN translates this into a telnet break signal which it sends to the host machine e break interrupt On some systems such as SunOS XENIX and AIX a break received from the peripheral is not passed to the client properly If the client wishes to make the break act like an interrupt key for example when the stty options ignbrk and brkintr are set break length The length of time in milliseconds for which the break signal will be asserted on the se rial port Valid values are 0 65535 Default is 1000 ms A value of 0 will cause the request to send a break signal to be ignored break delay The length of time in milliseconds to delay after a break signal is sent before the IOLAN sends data Valid values are 0 65
3. break Enables disables the existing Reverse Telnet break signal and the out of band break signals for TruePort The default value is Off bypass password When set authorised users who do not have a password set with the exception of the Admin user WILL NOT be prompted for a password at login with Local Authentication dhcp bootp Enables the DHCP BOOTP client process in the IOLAN By default this is disabled off If this is enabled the server IP address parameter is disabled domain_name Unique name for your domain your location in the global network Like Hostname it is a symbolic rather than a numerical identifier flush on close When enabled deletes any pending outbound data when a port is closed as opposed to maintaining the port to send pending data The default value is Off internet The IOLAN s unique IPv4 network IP address If you are using the IOLAN in an IPv6 network this field can be left blank monitor connection every Specify how often in seconds the IOLAN will send a TCP keepalive This only applies to line service types that support the keepalive feature The default interval is every 30 seconds name You must supply a name for the IOLAN netmask The network subnet mask For example 255 255 0 0 oem login When set and a custom language file is in use the login prompt will use the string defined in the language file as the login prompt instead of the default prompt login pa
4. Description Shows the Modbus statistics User Level Admin Syntax show modbus statistics master tcp line lt number gt show modbus statistics master udp line lt number gt show modbus statistics slave tcp line lt number gt show modbus statistics slave udp line lt number gt IOLAN DS1 TS2 CLI Reference Guide Version 4 1 75 Run Time Statistics Show Netstat Statistics Description Shows protocol IP ICMP TCP UDP counters User Level Admin Syntax show netstat statistics ip ipv6 icmp icmpv6 tcp udp udp6 Show Routes Description Shows current information about IPv4 or IPv6 network routes User Level Admin Syntax show routes ipv6 Run Time Statistics Delete Arp Description Delete entries from the IOLAN s ARP cache Takes effect immediately not related to configuration User Level Admin Syntax delete arp Show Arp Description Shows the current contents of the ARP cache User Level Admin Syntax show arp Show Serial Description Shows statistics on the serial port User Level Admin Syntax show serial Uptime Description Displays the elapsed time in days hours minutes and seconds since the last reboot power cycle User Level Admin Syntax uptime 76 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 UO 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 U
5. This value is in hexadecimal with a default value of 8 ASCII value AH intr Defines the interrupt character Typing the interrupt character interrupts the current process This value is in hexadecimal with a default value of 3 ASCII value AC quit Defines the quit character Typing the quit character closes and exits the current telnet session This value is in hexadecimal with a default value of 1c ASCII value FS escape Defines the escape character Returns you to the command line mode This value is in hexadecimal with a default value of 1d ASCII value GS 49 Line Service Commands Set UDP 50 Description Configures the UDP settings for the serial line User Level Normal Admin Syntax Options set udp line lt number gt entry 1 2 3 4 both auto learn specific lt UDP port gt lt start IP address gt lt end IP address gt set udp line lt number gt entry 1 2 3 4 in any port auto learn specific lt UDP port gt lt start IP address gt lt end IP address gt set udp line lt number gt entry 1 2 3 4 out lt UDP port gt lt start IP address gt lt end IP address gt set udp line lt number gt entry 1 2 3 4 none 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 different IP address range UDP port and direction of data flow both injout none The direction in which information is received or relaye
6. he Normal level user has limited access to the IOLAN Limited CLI commands and Menu access are available with the ability to configure the user s own configuration settings e Restricted The Restricted level user can only access predefined sessions or access the Easy Port Access menu e Menu The menu level user will only be able to access predefined session or access the Easy Port Access menu The Easy Port Access allows the user to connect to the accessible line without disconnecting their initial connection to the IOLAN Does not have any access to CLI commands 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 access Specifies the user access rights to each IOLAN device line Options are e Read Write Users are given read and write access to the line e Read In Users are given access to read only outbound data data that is going from the IOLAN to the device The on off option is only for 1 port models You can disable line access in 2 port models by specifying 0 zero service The type of service that the user will use sess timer The amount of time in seconds that the Session Timer will run Use this timer to forcibly close a user s session connection When the Session Timer expires the IOLAN will end the connection The default value is 0 zero meaning that the session timer will not expire the session is open perm
7. lt config user lt config_user gt You can see a list of users that can be deleted by typing delete user You can not delete the admin user 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 CLI and menu only Admin set default user host ip None lt ip address config host gt hotkey prefix lt 00 7f gt idle timer lt 0 4294967 gt language english customlang level admin normal restricted menu line access readin readwrite on off lt line s gt 0 port tcp clear telnet tcp port service dsprompt telnet tcp clear sess timer lt 0 4294967 gt host ip For outbound User Services such as Telnet this is the target host name or IP address If no IP address is specified the Host IP value in the Default User configuration will be used The default is 0 0 0 0 or None IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Configuring Users hotkey prefix The prefix that a user types to control the current session The default value is hex 01 which corresponds to Ctrl a Aa hex value 02 would be Ctrl b b etc e anumber To switch from one session to another press a and then the required session number For example a 2 would switch you to session 2 Pressing a 0 will return you to the IOLAN Menu e an Display the next session The current session will remain ac
8. lt server_port gt host port set line lt number gt service direct raw config host host port set line lt number gt service silent raw config host host port multihost all backup config backup host host port none set line lt number gt service direct silent telnet lt config host lt host_port gt set line lt number gt service reverse raw multihost on off telnet lt server port gt set line lt number gt service client tunnel config host lt host_port gt set line lt number gt service server tunnel lt server port gt set line lt number gt service dslogin udp vmodem modbus master modbus slave custom app set line lt number gt service trueport client initiated off config host host port signal active on off multihost all backup config backup host host port none set line lt number gt service trueport client initiated on server port signal active on off multihost on off bidir This service allows the IOLAN to listen for Incoming TCP connection and if needed initiate a TCP connection lt config_host gt The name of the target host The host must exist in the IOLAN host table lt server_port gt The IOLAN port number 45 Line Commands 46 lt host_port gt The port number the target host is listening on for incoming connections direct Direct connections bypass the IOLAN enabling the user
9. s network parameters SNMP Commands The IOLAN supports SNMP traps for restart and SNMP community authentication error 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 lt community_name gt A name that will be sent to the IOLAN from an SNMP manager This name will define the permissions of the manager config host sip address The host name of the SNMP community that will send requests to the IOLAN The IPv4 or IPv6 address of the SNMP manager that will send requests to the IOLAN If the address is 0 0 0 0 any SNMP manager with the Community Name can access the IOLAN If you specify a network address for example 172 16 0 0 any SNMP manager within the local network with the Community Name can access the IOLAN none readonly readwrite Permits the IOLAN to respond to SNMP requests by e None There is no response to requests from SNMP e Readonly Responds only to Read requests from SNMP e Readwrite Responds to both Read and Write requests from SNMP Add Trap Description Adds an SNMP host to which trap messages will be sent User Level Admin Syntax add trap trap name config host gt lt ip address Options trap name An arbitrary trap community name config host sip address Defines the hosts by IPv4 or IPv6 address that will receive tr
10. Set Vmodem Phone in the IOLAN User 5 Guide for the command parameters to set the AT command or phone number port The amount of time in milliseconds before an AT response is sent to the requesting device The default is 250 ms response delay The port number the target host is listening on for messages signals ded Controls the state of the DCD signal always high DCD signal will always stay high follow connection DCD signal will be high when an end to end connection is established and low when it is not Since the IOLAN does not have a physical DCD pin you need to re map the DTR or RTS signal to DCD to have the signal present see next option 51 Line Service Commands Set Vmodem Phone 52 signals dtr You can specify how the DTR signal pin acts during your modem application connection as itself DTR as DCD or as RI signals rts You can specify how the RTS signal pin acts during your modem application connection as itself RTS as DCD or as RI style One of the following e Verbose Return codes strings are sent to the connected device e Numeric The following characters can be sent to the connected device 0 OK 1 CONNECTED 2 RING 3 NO CARRIER 4 ERROR 6 ITERFACE DOWN 7 CONNECTION REFUSED 8 NO LISTNER success string String that is sent to the serial device when a connection succeeds If no string is entered then the string CONNECT will be sent with the connecting speed f
11. Set TEMETCN ON ne een UU u 49 Set Hee EI e INN EE 51 Set Vmodem Phones U 52 Set Modbus Slave Line u u 53 Set Modbus Master Line U 53 Set Multihost A E u u 54 Set Line Initiate Connection 54 Show C stom sAppDp EE 55 Show Interface kw bk don U U eee ea at beeen 55 ele 55 Show Telnet Client 55 Show Dn 55 Show Vmoden kib den penn ia oo ke 55 Show Vmodem Phones U 55 Modem Commands 56 Add WIG CGD EE 56 Delete Modem eeng 56 Show ee 56 Packet Forwarding Commands 57 Set Packet Forwarding Line 57 Show Packet Forwarding Line 59 Chapter 5 Network Commands 61 SNMP e e TE 61 Add EGRET 61 ao lo TW A o EE 61 Delete ComMUNity uuu ae fe oak
12. Specify the network prefix bits for the IPv6 address Range 0 64 Default 64 method manual Specify this option when you want to enter a specific IPv6 address ipv6 address Specify the complete IPv6 address Field Format IPv6 address prefix bits manual Specify the network prefix bits for the IPv6 address Range 0 128 Default 64 Configures custom IPv6 network and IP addresses Admin set custom ipv6 config ipv6 address gt method auto network prefix network prefix gt prefix bits lt 0 64 gt set custom ipv6 config ipv6 address gt method manual ipv6 address ipv6 address gt prefix bits lt 0 128 gt method auto When this option is specified the IOLAN will derive an IPv6 address from the entered network prefix and the IOLAN s MAC address This is the default option network prefix Specify the IPv6 network prefix The IOLAN will derive the complete IPv6 address from the entered network prefix and the IOLAN s MAC address IOLAN DS1 TS2 CLI Reference Guide Version 4 1 IPv6 Commands 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 enter a specific IPv6 address ipv6 address Specify the complete IPv6 address Field Format IPv6 address prefix bits manual Specify the network prefix bits for the IPv6 address Range 0 128 Default 64 Delete Custom IPv6 Description Deletes the spe
13. back to a listening for an incoming connection state Applications using Single Telnet need to be aware that there can be some considerable delay between a network disconnection and the port being available for the next connection attempt this is to allow any data sent on prior connections to be transmitted out of the serial port Application network retry logic needs to accommodate this feature The default value is Off retry The number of times the IOLAN will attempt to transfer using TFTP a file to from a host Enter a value between 0 and 5 The default is 5 A value of 0 zero means that the IOLAN will not attempt a retry should TFTP fail timeout The time in seconds that the IOLAN will wait for a successful transmit or receipt of TFTP packets before retrying a TFTP transfer Enter a value between 3 and 10 The default is 3 seconds Sets server service parameters Admin set service telnetd on off httpd on off snmpd on off sped on off syslog on off dmgrd on off modbusd on off telnetd Telnet daemon process in the IOLAN on port 23 httpd HTTP daemon process in the IOLAN on port 80 snmpd SNMP daemon process in the IOLAN on pott 161 spcd SPC Trueport daemon process in the IOLAN on port 668 syslog Syslog client process in the IOLAN Hardware Commands Show Custom App Description User Level Syntax Show Modbus Description User Level Syntax Show Server Description User L
14. be configured if you configure both the packet options and the frame definition options the frame definition options will take precedence If any of the packet options that are configured are met the packet transmission is triggered Admin set packet forwarding line lt number gt mode minimize latency set packet forwarding line lt number gt mode optimize network throughput set packet forwarding line lt number gt mode prevent message fragmentation delay between messages lt 0 65535 gt set packet forwarding line lt number gt mode custom on specific events enable end triggerl on off enable end trigger2 on off end triggerl lt 0x0 FF gt end trigger2 lt 0x0 FF gt force transmit timer lt number gt forwarding rule triggerl trigger l trigger 2 strip trigger idle timer lt number gt packet size lt number gt set packet forwarding line lt number gt mode custom on frame definition enable eofl on off enable eof2 on off enable sofl on off enable sof2 on off eofl lt 0x0 FF gt eof2 lt 0x0 FF gt forwarding rule trigger trigger 1 trigger 2 strip trigger sofl lt 0x0 FF gt sof2 lt 0x0 FF gt start frame transmit on off minimize latency This option ensures that any data received on the serial port will immediately be forwarded to the LAN Select this option for timing sensitive applications optimize network throughput This option provides optimal network usage while ensuring
15. been downloaded to the IOLAN plus any parameters you want to pass to the program Maximum of 80 characters Use the she11 CLI command as described in the SDK Programmer s Guide to manage the files that you have downloaded to the IOLAN For example using sample outraw program you would type outraw s 0 192 168 2 1 10001 Acct 10001 if you were starting the application on the Server notice the s 0 parameter specifies Line 1 Description Sets server parameters User Level Syntax Options Admin set server auto obtain gw on off banner on off break on off bypass password on off domain lt string gt flush on close on off internet lt IPV4 address gt internet dhcp bootp on off monitor connection every lt seconds gt name lt string gt netmask lt IPV4 address gt oem login on off password limit lt 0 10 gt prompt with name on off single telnet on off set server tftp retry lt integer gt timeout lt integer gt auto obtain gw When DHCP BOOTP is enabled you can enable this option to have the IOLAN receive the Default Gateway IP address from the DHCP BOOTP server IOLAN DS1 TS2 CLI Reference Guide Version 4 1 17 Server Commands 18 banner This parameter concerns the banner information product name software version This banner information is presented to a user with a login prompt For security reasons you can turn off the display of this Information The default is Off
16. e uC a a a ak a a aa a Taal aua 73 Show MOTD DE 73 Chapter 8 Statistic Commands 75 Configuration Statistics u kk w kn kk e a a lk kk kak aa ka ek 75 Show Netst t eki u u ik kk ka n a n ss e e l n kk l n P ii a n 75 Show Modbus Statistics EE 75 Show Netstat Statistics 1 11 U 76 Show ROUTES ouian idasi eka aa ki ti kin a ko ik n a n pak ke kk kuqa apu 76 Run Trime SIAUSUES deep kk kk ik n bonn aeeai 76 Delet ANN E 76 Show ATP k kika kikonk n n do e ki n ki e ai a kk A A n 76 Show Serial uu a EE 76 Dt EE 76 Chapter 9 UO Commande 77 Global VO Commands 77 Set UDP u u u u EE EEN 77 Set IO Fee EE 78 SSES EE eebe 78 Set IO Temperature Scale 78 EE 78 Set LINE SerVic uu Eeer k e aSa 78 Set E rte EEGEN 79 Set IOChannel Mode 1 ee 79 Set ee Een de CRT ki kk ke a e kb k n 79 Set IOChannel Digital Input 79 Set IOChannel Digital Input Serial Pins 80 Set IOChannel Digital Output 81 Set IOChannel Digital Output Serial Pins
17. enable end trigger2 Enable or disable the end trigger2 hex character enable end eofl Enable or disable the eofl end of frame hex character enable end eof2 Enable or disable the eof2 end of frame hex character enable end sofl Enable or disable the sofl start of frame hex character enable end sof2 Enable or disable the sof2 start of frame hex character end trigger1 When enabled specifies the character that when received will define when the packet is ready for transmission The transmission of the packet is based on the Trigger Forwarding Rule Valid values are in hex 0 FF The default is 0 end trigger2 When enabled creates a sequence of characters that must be received to specify when the packet is ready for transmission if the End Trigger1 character is not immediately followed by the End Trigger2 character the IOLAN waits for another End Trigger character to start the End Trigger1 End Trigger2 character sequence The transmission of the packet is based on the Trigger Forwarding Rule Valid values are in hex 0 FF The default is 0 eofl Specifies the End of Frame character which defines when the frame is ready to be transmitted The transmission of the frame is based on the Trigger Forwarding Rule Valid values are in hex 0 FF The default is 0 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
18. issue 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 establish the connection Admin set vmodem line lt number gt echo on off failure string lt string gt host config host init string lt string gt mode auto manual port TCP port gt 0 respons delay time ms signals dcd always high follow connection signals dtr always high represent dcd represent ri signals rts always high represent dcd represent ri style numeric verbose success string lt string gt suppress on off echo When enabled echoes back characters that are typed in equivalent to ATEO ATE1 commands Disabled by default failure string String that is sent to the serial device when a connection fails If no string is entered then the string NO CARRIER will be sent 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 ATSO AT amp Z1 AT amp Sn AT amp Rn AT amp Cn AT amp F ATS2 ATS12 and ATDSI See VModem Initialisation Commands in the IOLAN User s Guide for a more detailed explanation of the support initialization commands mode Auto mode establishes the connection when the line becomes active You must supply the AT command or phone number that will start the connection see
19. kk anka ege 62 Delerke Trap s ke in n a n a n e n an ia je A ka n 62 Set SE 62 Gre 62 TFTP Commands u u u u L LULU u 63 Set Serv r TFTP uuu uuu ege ege 63 Hosts Comimna ds don u u uuu LL kap tanp iisen esse 63 Add HIOst kk da G uu kk a l wk akawa n ka ik A A n saq and 63 Delete FOSE ee ucu u uu ka pi a kt a a e po ko n eee 63 Se Hostia u E ee ee e 63 SHO POSCE L I a Lu es 64 Gateway ee Le TE 64 RE 64 Delete EE 64 6 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 EEN 65 Show EE 65 Logging Commands 66 UO E 66 SHOW DYE OU J u u ie Si quis kuah cate 66 Chapter 6 Time Commands 67 Time e E TEE 67 SeUTIIY8 ee 67 Show TE 67 Time Date Setting Commands 67 LR 67 Set TIME kk u ee eee eee eee ene ee eee 67 Show Date EE 68 Show Times U u u u 68 Chapter 7 Administration Commands 69 Bootup Commands 69 EES 69 E EE 69 Reset Factory E 69 See 69 Set BOol D E 70 le 70 Show BOOUU PO E 70 TFTP File Transfer Commands 71 Netload RE 71 eebe EE 72 Custom Factory Default JLI Isis 72 Netload usu uy u ee ee eee ak ta 72 EE 73 Set MOTD uuu uui a aka n ai a
20. met triggers the specified alarm action Triggers can be e Disabled No alarm settings This is the default e Inactive When the expected Digital input is active going inactive will trigger an alarm e Active When the expected Digital input is inactive going active will trigger an alarm clear Specify Manual to manually clear an alarm Specify Auto to automatically clear the alarm when the trigger condition changes for example if the Trigger is Inactive and the alarm is triggered once the input becomes active again the alarm will be cleared when Auto is set The default is Auto syslog Sends a message to syslog when an alarm is triggered or cleared The syslog entry includes the severity level and the value that caused the alarm to trigger or clear The syslog message is associated with Level Critical snmp Sends an SNMP trap when an alarm is triggered or cleared The trap consists of the severity level and whether the alarm was triggered or cleared description Provide a description of the channel making it easier to identify The channel description can be up to 20 characters invert signal Inverts the actual condition of the I O signal in the status therefore an inactive status will be displayed as active 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 T
21. number The phone number the IOLAN will dial to callback the user you must have set Callback to On Enter the number without spaces port When the User Service is Telnet this is the target port number The default value will change based on the type of Service selected the most common known port numbers are used as the default values service The type of service that the user will use sess timer The amount of time in seconds that the Session Timer will run Use this timer to forcibly close a user s session connection When the Session Timer expires the IOLAN will end the connection The default value is 0 zero meaning that the session timer will not expire the session is open permanently or until the user logs out The maximum value is 4294967 seconds The User Session Timer will override the Line Session Timer with the exception of reverse Telnet sessions IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Configuring Users Set User Description Sets users settings Normal level users can configure only their own settings User Level Syntax Admin Options Admin level users can configure any users settings including their own with the exception of their User Level which must stay at Admin Normal Admin set user hotkey prefix lt 00 7f gt language english customlang password set user lt username gt host ip None lt ip address gt lt config host gt hotkey prefix lt 00 7f
22. that the application performance is not compromised Select this option when you want to minimize overall packet count such as when the connection is over a WAN prevent message fragmentation This option detects the message packet or data blocking characteristics of the serial data and preserves it throughout the communication Select this option for message based applications or serial devices that are sensitive to inter character delays within these messages 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 57 Packet Forwarding Commands 58 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 Transmit Timer of 1000 ms and a Packet Size of 100 bytes whichever criteria is met first is what will cause the packet to be transmitted custom on frame definition This section allows you to control the frame that is transmitted by defining the start and end of frame character s If the internal buffer 1024 bytes is full before the EOF character s are received the packet will be transmitted and the EOF character s search will continue The default frame definition is SOF 00 and EOF 00 enable end trigger1 Enable or disable the end trigger hex character
23. typed as set tel map off or you can use the ESC key to complete the lines as you go along set tel lt ESC gt net client ma lt ESC gt p to crlf off where the lt ESC gt key was pressed to complete the option as it was typed Command Options When you are typing commands on the command line while connected to the IOLAN you can view the options by typing a question mark after any part of the command to see what options are available valid For example DSS set vmodem failure string host port style success string suppress DSS set vmodem failure string lt text gt 30 characters maximum DS set vmodem failure string Vmodem failed failure string host port style success string suppress Or press Enter to confirm command DSS set vmodem failure string Vmodem failed DS show vmodem Host Host Port Success String Failure String Vmodem failed Suppress Off Style Numeric DS 16 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Server Commands This chapter defines all the CLI commands associated with configuring the IOLAN s server parameters Server Commands Set Custom App Set Server Description You can create a custom application that can run on the IOLAN using the Perle SDK User Level Syntax Options Admin set custom app server program command line lt command gt program command line The name of the SDK program executable that has been already
24. 4 rts cts dtr dsr ded Specify the Digital output pins RTS or DTR or Digital input pins CTS DSR or DCD IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel Show IO Description User Level Syntax Options Show IOChannel Description User Level Syntax Options Shows global I O information for example UDP TruePort Modbus Temperature input is Analog Admin show iochannel lt i o channel gt show iochannel rts cts dtr dsr dcd i o channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al a4 rts cts dtr dsr ded Specify the Digital output pins RTS or DTR or Digital input pins CTS DSR or DCD Shows I O channel information Temperature input is Analog Admin show iochannel i o channel show iochannel line number rts cts dtr dsr dcd i o channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al a4 rts ets dtr dsr dcd Specify the Digital output pins RTS or DTR or Digital input pins CTS DSR or DCD 91 UO Channel Control Commands UO Channel Control Commands The I O commands in this section are used to manually manage the I O channels Digital Output Description User Level Syntax Options Digital Input Description User Level Syntax Option Relay Description User Level Syntax Option Analo
25. 535 Default 0 ms no delay connection method Determines how a modem will work on the line Select from the following options e Direct Connect Indicates that there is not a modem on the line This is the default e Dial In Specify this option when a user is remote and will be dialing in via modem or ISDN TA e Dial Out Specify this option when a modem is attached to the serial port and is being used to dial out e Dial In Out Specify this option when the IOLAN is being used as a router depending on which end of the link your IOLAN is situated and how you want to initiate the communication data bits Specifies the number of bits in a byte The default is 8 dial timeout The number of seconds the IOLAN will wait to establish a connection to a remote modem The default value is 45 seconds dial retries The number of times the IOLAN will attempt to establish a connection with a remote modem The default value is 2 flowin Determines if input flow control is to be used Default is On This is active only when Line Flow Control is set to Soft Hard or Both flowout Determines if output flow control is to be used Default is On This is active only when Line Flow Control is set to Soft Hard or Both IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Commands hotkey prefix The prefix that a user types to lock a line or redraw the Menu The default value is hex 01 which corresponds to Ctrl a A
26. 65 Logging Commands Logging Commands Set Syslog Description User Level Syntax Options Show Syslog 66 Description User Level Syntax Configures the system log Admin set syslog level emergency alert critical error warning notice info debug primary host config host gt secondary host lt config host gt level Choose the event level that triggers a syslog entry Emergency Alert Critical Error Warning Notice Info Debug When you select a Level all the levels that appear above it in the list also trigger a syslog entry For example if you select Error all Error Critical Alert and Emergency events will be logged primary host The first preconfigured host that the IOLAN will attempt to send system log messages to messages will be displayed on the host s monitor secondary host If the IOLAN cannot communicate with the primary host then the IOLAN will attempt to send system log messages to this preconfigured host messages will be displayed on the host s monitor Shows the syslog settings Admin show syslog IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Time Commands This chapter defines all the CLI commands associated with configuring the IOLAN s time parameters Time Commands Set Time Description Sets the IOLAN s system clock User Level Admin Syntax set time lt hh mm ss gt Option hh mm ss Sets the IOLAN s system time using military time form
27. 9200 38400 57600 115200 230400 28800 custom baud rate gt 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 The configured baud rate of the TruePort client 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 57600 115200 230400 28800 custom lt baud_rate gt The actual baud rate that runs between the IOLAN and the connected serial device You can also specify a custom baud rate valid values are 50 230400 Shows the IOLAN TruePort remapping table Normal Admin show trueport IOLAN DS1 TS2 CLI Reference Guide Version 4 1 IPv6 Commands IPv6 Commands Set IPv6 Show IPv6 Description User Level Syntax Options Description User Level Syntax Configures the basic IPv6 settings Admin set ipv6 dhcpv6 settings ipv6 address on off dhcp settings network prefix on off Set ipv6 enable ipv6 addressing on off obtain using auto ipv6 dhcpv6 dhcpv6 settings Determines the types of information that the IOLAN will accept from the DHCPv6 server IPv6 address es and or network prefix es ivp6 address When enabled the IOLAN will accept IPv6 address es from the DHCPv6 server This is off by default network prefix When enabled the IOLAN will accept the network prefix from the DHCPV6 server This is off by default enable ipv6 addressing When enabled you can configure the IOLAN to obtain the IPv6 address es using IPv6 Autoconfiguration or a DHCPv6 server Def
28. DP settings for I O unicast messages User Level Admin Syntax Options set io udp mode on off broadcast interval lt broadcast_interval gt set io udp entry 1 2 3 4 disabled set io udp entry 1 2 3 4 udp port start ip lt end_ip gt mode Enables disables UDP broadcast of I O channel status data broadcast interval Enter the interval in seconds for UDP broadcasts of I O channel status data Valid values are 1 9999 Default value is 30 seconds entry You can specify up to four sets of UDP IP address that will receive the I O unicast udp_port The UDP port that the IOLAN will use to relay messages to servers hosts start_ip The first host IP address in the range of IP addresses for IPV4 or IPV6 that the IOLAN will listen for messages from and or send messages to end_ip The last host IP address in the range of IP addresses for IPV4 not required for IPV6 that the IOLAN will listen for messages from and or send messages to IOLAN DS1 TS2 CLI Reference Guide Version 4 1 77 Set Line Set IO Failsafe Description User Level Syntax Options Set IO Modbus Description User Level Syntax Options Sets the failsafe watchdog settings for I O Admin set io failsafe mode on off timeout lt seconds gt 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 When this timer exp
29. IOLAN DS1 TS2 Command Line Interface Reference Guide Version 4 1 Part 5500208 41 October 2009 Copyright Statement This document must not be reproduced in any way whatsoever either printed or electronically without the consent of Perle Systems Limited 60 Renfrew Drive Markham ON Canada L3R 0E1 Perle reserves the right to make changes without further notice to any products to improve reliability function or design Perle the Perle logo and IOL AN are trademarks of Perle Systems Limited Microsoft Windows 98 Windows NT Windows 2000 Windows Server 2003 Windows XP and Intemet Explorer are trademarks of Microsoft Corporation Perle Systems Limited 2004 2009 FCC Note The IOLAN Device Server has been found to comply with the limits for a Class A digital device pursuant to Part 15 of the FCC rules These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instructions in this Guide may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his her own expense EN 55022 1998 Class A Note WARNING This is a Class A product In a domestic environ
30. LI initiate connection Initiates a Telnet connection to the specified host when any data is received by the serial port or when the specified character is received by the serial port direct Telnet only internet address Used with reverse sessions users can access serial devices connected to the IOLAN by the specified Internet Address or host name that can be resolved by a DNS You must reboot the IOLAN for the Internet Address to take affect the kill line option does not apply to this parameter 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 This parameter needs to be used in conjunction with server parameter monitor connection every The interval determines how long the IOLAN will wait during inactivity before testing the connection It should be noted that if a network connection is accidentally dropped it can take as long as the specified interval before anyone can reconnect to the serial port line name Provide a name for the line so it can be easily identified 41 Line Commands 42 lock When enabled the user can lock his terminal with a password using the Hotkey Prefix default Ctrl a a I lowercase L The IOLAN prompts the user for a password and a confirmation mode Enables
31. P700 specifically supporting HP700 44 Term Term2 Term3 user defined terminals IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Commands for Users Logged Into the IOLAN Set User Description User Level Syntax Options Set User Session Description User Level Syntax Options Sets the current users settings Normal Admin set user hotkey prefix lt 00 7f gt language english customlang password hotkey prefix The prefix that a user types to control the current session The default value is hex 01 which corresponds to Ctrl a Aa hex value 02 would be Ctrl b b etc e 4anumber To switch from one session to another press a and then the required session number For example a 2 would switch you to session 2 Pressing a 0 will return you to the IOLAN Menu e an Display the next session The current session will remain active The lowest numbered active session will be displayed e a p Display the previous session The current session will remain active The highest numbered active session will be displayed e a m To exit a session and return to the IOLAN You will be returned to where you left off The session will be left running e Aal Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password excluding spaces and locks the line Next the user must retype the password to unlock the line e Ar When you switch from a se
32. Syntax Options Configures up to 49 hosts IOLANS that the Digital input channel or input serial signal pins DSR DCD or CTS when the line is configured for signal io will connect to To see a list of configured hosts TOLANS enter the show iochannel channel command Admin set iochannel lt channel gt multihost entry lt number gt delete set iochannel channel multihost entry number host host name tcp port channel Specify the Digital input channel or input serial signal pin that will be connecting to all the hosts 1OLANS in the multihost list entry Specify the multihost table entry number Valid values are 1 100 delete Deletes the entry number in the multihost table host Specify the preconfigured host that will be in the multihost list Default None tcp port Specify the TCP port that the I O channel or serial signal pin will use to communicate to the Host Default 0 Show IOChannel Status Description User Level Syntax Kill IOChannel 90 Description User Level Syntax Options Shows the I O channel status for all channels and the serial signal pins when the line is configured for signal io Admin show iochannel status Kills the I O channel Admin kill iochannel i o channel kill iochannel line number rts cts dtr dsr dcd i o channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al a
33. 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 This parameter needs to be used in conjunction with server parameter monitor connection every The interval determines how long the IOLAN will wait during inactivity before testing the connection It should be noted that if a network connection is accidentally dropped it can take as long as the specified interval before anyone can reconnect to the serial port IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel connection method The connection method is one of the following e Client Initiated When specified the channel serial signal pin will wait for connections to be initiated by another I O channel or a TCP IP application e Server Initiated When specified the channel serial signal pin initiates communication to another I O channel or a TCP IP application e Local Connection When specified the input or output depending on how the channel or serial signal pin is configured will be associated with another local IOLAN I O channel or serial signal pin When the channel is configured as digital input or when configuring an input serial signal pin the Output Channels parameter displays all the local digital output signals or relays that it is associated with When the channel i
34. a hex value 02 would be Ctrl b b etc e Aal Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password excluding spaces and locks the line Next the user must retype the password to unlock the line e 4r When you switch from a session back to the Menu the screen may not be redrawn correctly If this happens use this command to redraw it properly You can use the Hotkey Prefix key to lock a line only when the Line Lock parameter is On data loggin When enabled serial data will be buffered if the TCP connection is lost When the TCP connection is re established the buffered serial data will be sent to its destination this option is not available when Monitor DSR Monitor DCD or Multihost is enabled The data buffer is 4K for desktop models and 32K for rack mount models If the data buffer is filled incoming serial data will overwrite the oldest data The default is off idle timer Enter a time period in seconds for which the Idle Timer will run Use this timer to close a connection because of inactivity When the Idle Timer expires the IOLAN will end the connection The maximum value is 4294967 seconds about 49 days The default value of 0 zero means the Idle Timer will not expire so the connection is permanently open initial Specifies the initial interface a user navigates when logging into the line either the Menu or a prompt for the CLI The default is C
35. acter When Line Mode is Off typing the erase character erases one character This value is in hexadecimal with a default value of 8 ASCII value H intr Defines the interrupt character Typing the interrupt character interrupts the current process This value is in hexadecimal with a default value of 3 ASCII value AC quit Defines the quit character Typing the quit character closes and exits the current telnet session This value is in hexadecimal with a default value of 1 ASCII value FS 31 Configuring Users Version Description User Level Syntax escape Defines the escape character Returns you to the command line mode This value is in hexadecimal with a default value of 1d ASCII value GS Displays firmware version and build Normal Admin version Configuring Users Add User Delete User Description User Level Syntax Option Description User Level Syntax Option Set Default User 32 Description User Level Syntax Options Adds a user For units with 4 or less serial ports you can configure up to 4 users For units with 8 or more serial ports the maximum number of users which can be added is 48 This is in addition to the admin user Admin add user lt username gt lt username gt The name of the user without spaces When you finish the command and press Enter you will be prompted to enter and re enter a password for the user Deletes a user Admin delete user
36. al Relay output remains the same no change e Activate Output Activates the output e Deactivate Output Deactivates the output Set IOChannel Analog True Analog 84 Description Sets the Analog input channel settings User Level Admin Syntax Options set iochannel analog channel type current voltage range range specifier gt set iochannel analog channel alarm level 1 2 3 4 5 mode on off trigger type disabled low high trigger level decimal value clear mode auto manual clear level decimal value snmp on off syslog on off analog channel Specify the Analog channel number for example a2 or a4 this also applies to Temperature models type Select the type of input being measured either Current or Voltage The default is Current range Select the range for the measurement type For current the range is e 0 20 0 20mA This is the default e 4 20 04 20mA For voltage the range is e 1 G 1V e 5 G 5V e 10 4 10V This is the default e 150 150mV 500 500mV IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel alarm Configures alarm settings when the Analog input trigger is activated level You can specify up to five alarm trigger clear severity levels If the Trigger Type is Low an alarm is triggered when the input drops below the specified Trigger value other severity level trigger values must decrease in value with each subsequ
37. al io on the same IOLAN remote IOLAN s and or TCP IP applications running on local hosts Admin set iochannel channel ioextension enabled on off keepalive on off set iochannel lt channel gt ioextension connection method client initiated tcp port tcp port gt multihost on off set iochannel lt channel gt ioextension connection method server initiated host name gt tcp port tcp port multihost all backup config backup host host port none set iochannel channel ioextension connection method local connection input channel channel Specify the Digital Relay channel or serial signal pin that you are configuring the I O extension for The channel can be d1 d2 d3 d4 rl r2 depending on the model The serial signal pins are dsr dcd or cts for input and dtr or rts for output enabled When enabled the digital input channel or DSR DCD CTS input serial signal pins can be connected to e A Digital output or relay if the I O model supports relay channel on the same IOLAN e Output Serial Signal Pins DTR RTS e A Digital output channel on another IOLAN s or output serial signal pins DTR RTS on another IOLAN s e 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 can be associated with a digital input channel or input serial signal pins Default Disabled keepalive Enables a per connection
38. anently or until the user logs out The maximum value is 4294967 seconds The User Session Timer will override the Line Session Timer with the exception of reverse Telnet sessions port When the User Service is Telnet this is the target port number The default value will change based on the type of Service selected the most common known port numbers are used as the default values IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Configuring Users Set User Session Description Configures a users session settings See Set User Session on page 29 for the options descriptions User Level Admin Syntax set user lt username gt session 1 2 3 4 auto on off type off telnet set user lt username gt session 1 2 3 4 telnet options host lt config host gt port TCP port termtype lt terminal name gt line mode on off map cr crlf on off local echo on off echo lt 00 7f gt eof lt 00 7 gt erase lt 00 7f gt intr lt 00 7 gt quit lt 00 7f gt Show Default User Show User Description Shows the Default Users settings When adding a new user the profile of the default user will be used to assign the values of the parameters to the new user User Level Admin Syntax show default user Description Shows user configuration settings User Level Admin Syntax show user lt configured _user gt Options lt configured_user gt Show the settings for the specified user Show th
39. ap messages generated by the IOLAN UP to four trap hosts can be defined IOLAN DS1 TS2 CLI Reference Guide Version 4 1 61 SNMP Commands Delete Community Description Deletes an SNMP community version 1 and version 2 User Level Admin Syntax delete community lt 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 show snmp command Delete Trap Description Deletes an SNMP trap host User Level Admin Syntax delete trap config trap number Option config trap number When you add an SNMP trap host it gets assigned to a number To delete the SNMP trap host you need to specify the number of the trap that you want to delete To see which trap host is assigned to what number type the show snmp command Set SNMP Description Configures SNMP settings User Level Admin Syntax set snmp contact lt string gt location lt string gt readonly user lt username gt readwrite user lt username gt Options contact The name and contract information of the person who manages this SMNP node location The physical location of the SNMP node readonly user Specified user can only view SNMP variables readwrite user Specified user can view and edit SNMP variables Show SNMP Descript
40. at Show Time Description Shows the s system clock User Level Normal Admin Syntax show time Time Date Setting Commands Set Date Description Sets the IOLAN s system clock User Level Admin Syntax set date lt dd mm yyyy gt Set Time Description Sets the IOLAN s system clock User Level Admin Syntax set time lt hh mm ss gt Option hh mm ss Sets the IOLAN s system time using military time format IOLAN DS1 TS2 CLI Reference Guide Version 4 1 67 Time Date Setting Commands Show Date Description Shows the date according to the IOLAN system clock User Level Normal Admin Syntax show date Show Time Description Shows the IOLAN s system clock User Level Normal Admin Syntax show time 68 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 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 Description Resets the user profile or serial line to the default factory configuration User Level Admin Syntax reset user lt username gt reset line Reset Factory Description Resets the IOLAN to the factory configuration User Level Admin Syntax reset factory Save Description Saves the configuratio
41. ateway_host gt You can view the configured gateways that can be deleted by typing delete gateway IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Gateway Commands Set Gateway Description User Level Syntax Options Show Gateways Description User Level Syntax Configures the gateway Admin set gateway config gateway host default set gateway config gateway host host destination ip set gateway lt config gateway host gt network lt dest IPv4 addr gt lt dest_IPv6 address gt lt prefixbits mask gt lt config_gateway_host gt You can view the configured gateways that can be deleted by typing delete gateway default host network Specify the type of gateway e Default A gateway which provides general access beyond your local network e Host A gateway reserved for accessing a specific host external to your local network e Network A gateway reserved for accessing a specific network external to your local network lt destination_ip gt When the gateway is a Host or Network gateway you must specify the IPv4 or IPv6 address of the target host machine network lt prefixbits_mask gt When the gateway is a Network gateway you must specify the network s subnet mask for an IPv4 destination IP address the address is in the form of 123 123 123 123 or prefix bits for an IPv6 destination IP address valid values are 0 128 Shows configured gateways Normal Admin show gateways
42. ault Enabled obtain using auto ipv6 dhcpv6 e auto ipv6 When enabled the IOLAN will send out a Router Solicitation message If a Router Advertisement message is received the IOLAN will configure the IPv6 address es and configuration parameters based on the information contained in the advertisement If no Router Advertisement message is received the IOLAN will attempt to connect to a DHCPv6 server to obtain IPv6 addresses and other configuration parameters This is the default e dhcpv6 When enabled requests IPv6 address es and configuration information from the DHCPv6 server Shows the IPv6 settings Admin show ipv6 23 IPv6 Commands Add Custom IPv6 Description User Level Syntax Options Set Custom IPv6 24 Description User Level Syntax Options Adds a custom IPv6 address to the IOLAN You can specify either a complete IPv6 address or an IPv6 network address Admin add custom ipv6 method auto network prefix network prefix gt prefix bits lt 0 64 gt add custom ipv6 method manual ipv6 address ipv6 address gt prefix bits lt 0 128 gt method auto When this option is specified the IOLAN will derive an IPv6 address from the entered network prefix and the IOLAN s MAC address This is the default option network prefix Specify the IPv6 network prefix The IOLAN will derive the complete IPv6 address from the entered network prefix and the IOLAN s MAC address prefix bits auto
43. 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 The transmission of the frame is based on the Trigger Forwarding Rule Valid values are in hex 0 FF The default is 0 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Packet Forwarding Commands force transmit timer When the specified amount of time in milliseconds elapses after the first character is received from the serial port the packet is transmitted After a packet is transmitted the next character received starts the timer again A value of zero 0 ignores this parameter Valid values are 0 65535 ms The default is 0 forwarding rule Determines what is included in the Frame based on the EOFI or EOF1 EOF2 or Packet based on Trigger or Triggerl Trigger2 Choose one of the following options e Strip Trigger Strips out the EOF1 EOF1 EOF2 Triggerl or Triggerl Trigger2 depending on your settings e Trigger Includes the EOF1 EOF1 EOF2 Trigger or Triggerl Trigger2 depending on your settings e Trigger 1 Includes the EOF1 EOF1 EOF2 Triggerl or Trigger1 Trigger2 depending on your settings plus the first byte that follows the trigger e Trigger 2 Includes the EOF1 EOF1 EOF2 Triggerl or Trigger1 Trigger2 depending on your settings plus the next two bytes received after the trigger idle timer The amount of time in milliseconds that must elapse be
44. cified custom IPv6 address To see a list of configured IPv6 addresses type the command delete custom ipv6 User Level Admin Syntax delete custom ipv6 config ipv6 address gt 25 IPv6 Commands 26 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 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 Enter after you type this command you will be prompted for the Admin password User Level Normal Syntax admin Help Description Displays help on using the command line interface CLI User Level Restricted Normal Admin Syntax help Kill Line Description Restarts a line On IOLANS with more than 1 port you can specify a port number and then a range of ports for example kill line 4 10 13 15 On single port models use the command kill line User Level Normal Admin Syntax kill line lt number gt lt number range Kill Session Description Kills an active session User Level Restricted Normal Admin Syntax kill session 1 2 3 4 Options 1234 The number of the session s you want to kill Logout Description Logs the user out from the IOLAN User Level Restricted Normal Admin Syntax logout IOLAN DS1 TS2 CLI Reference Guide Version 4 1 27 Commands for Users Logged Into the IOLAN Menu Ping Resume Scree
45. d e None UDP service not enabled e In LAN to serial e Out Serial to LAN e Both Messages are relayed both directions auto learn The IOLAN will only listen to the first port that it receives a UDP packet from Applicable when set to In or Both any port The IOLAN will receive messages from any port sending UDP packets Applicable when set to In specific The port that the IOLAN will use to relay messages to servers hosts or the port from which the IOLANN will receive messages to be forwarded to the serial port This option works with any setting except None The IOLAN will listen for UDP packets on the port configured by the DS Port parameter lt outbound_port gt The port that the IOLAN will use to relay messages to servers hosts The IOLAN will listen for UDP packets on the port configured by the DS Port parameter lt start_ip_address gt The first host IP address in the range of IP addresses for IPV4 or IPV6 that the IOLAN will listen for messages from and or send messages to lt end_ip_address gt The last host IP address in the range of IP addresses for IPV4 not required for IPV6 that the IOLAN will listen for messages from and or send messages to IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Service Commands Set Vmodem Description This command associates a phone number with an IP address and TCP port This User Level Syntax Options enables an existing modem application to
46. d Registered Perle Resellers If you bought your product from a registered Perle supplier you must contact their Technical Support department they are qualified to deal with your problem Have Your Product Information Ready When you make a technical support enquiry please have the following information ready Item Write Details Here Product Name Problem Description Your Name Company Name and Address Country Phone Number Fax Number Email Address Making a support query via the Perle web page If you have an internet connection please send details of your problem to Technical Support using the email links provided on the Perle web site in the Support area Click here to access our website at the following URL http www perle com 12 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Contacting Technical Support 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 Support area Click here to access our web site at the following URL http www perle com support_services rma_form asp Feedback on this Manual If you have any comments or suggestions for improving this manual please email Perle u
47. disables the line available only on the TS2 model The default is enabled modem name The name of the predefined modem that is used on this line motd Enables disables the message of the day on the line nouser Blanks out the User parameter in case you want to change a dedicated user line to an undedicated line pages For DSLogin line service this is the number of video pages the terminal supports Valid values are 1 7 The default is 5 pages parity Specifies if you are using Even Odd or No parity on the line If you want to force a parity type you can specify Mark for lor Space for 0 phone number The phone number to use when Connection Method is set to Dial Out reset Resets the terminal type connected to the line when a user logs out rev sess security Enables disables login password authentication locally or externally on reverse Telnet connections The default is Off send name When enabled the port name will be sent to the host upon session initiation Default Disabled session strings Controls the sending of ASCII strings to serial devices at session start and session termination as follows e Send at Start If configured this string will be sent to the serial device when the serial device is detected i e signals come up The maximum size of this field is 128 bytes characters e Send at End If configured this string will be sent to the serial device when the TCP session on the LAN is terminat
48. e lt number gt termtype terminal name gt line mode on off map cr crlf on off local echo on off echo O0O 7f eof 00 7f erase 0O0 7f intr lt 00 7f gt quit lt 00 7f gt escape lt 00 7f termtype Type of terminal attached to this line for example ANSI or WYSE60 line mode When On keyboard input is not sent to the remote host until Enter is pressed otherwise input is sent every time a key is pressed Default is Off map cr crlf Maps carriage returns CR to carriage return line feed CRLF The default value is Off local echo Toggles between local echo of entered characters and suppressing local echo Local echo is used for normal processing while suppressing the echo is convenient for entering text that should not be displayed on the screen such as passwords This parameter can only be used when Line Mode is On Default is Off echo Defines the echo character When Line Mode is On typing the echo character echoes the text locally and sends only completed lines to the host This value is in hexadecimal with a default value of 5 ASCII value AE eof Defines the end of file character When Line Mode is On entering the eof character as the first character on a line sends the character to the remote host This value is in hexadecimal with a default value of 4 ASCII value 4D erase Defines the erase character When Line Mode is Off typing the erase character erases one character
49. e resolved in either the IOLAN s Host Table or a DNS server lt filename gt The complete path and file name cannot use a drive letter of the file you are downloading to the IOLAN 71 Custom Factory Default Netsave Description Transfers a file from the IOLAN to a remote host using the TFTP protocol User Level Admin Syntax Options netsave configuration crash serialt buf text config lt hostname ip address gt lt filename gt configuration Specifies that you are going to upload a configuration file from the IOLAN to the specified host or IP address crash Specifies that you are going to upload a crash file from the IOLAN to the specified host or IP address serialt buf Specifies that you are going to upload the contents of the serial trace buffer text config Saves the current configuration to a text file on a TFTP server lt hostname ip_address gt The IP address or host name for where the file you are uploading from the IOLAN is going If you are using a host name it must be resolved in either the IOLAN s Host Table or a DNS server lt filename gt The complete path and file name cannot use a drive letter for the file you are uploading from the IOLAN Custom Factory Default Netload 72 Description Transfers a file from a remote host to the IOLAN using the TFTP protocol User Level Admin Syntax Options netload factory default config hostname IP address filename factor
50. e settings for the current user 37 Configuring Users 38 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 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 DS1 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 In an TS2 IOLAN the admin user must specify current line lt number gt line number or sets value for all lines when configuring lines Line Commands Set Line Description Configures line parameters User Level Admin Syntax Admin set line lt number gt data bits 5 6 7 8 break on off break delay lt 0 65535 gt break length lt 0 65535 gt connection method dial in dial out dial in out direct connect idle timer lt 0 4294967 gt line name lt name gt modem name lt config modem pages 1 2 3 4 5 6 7 parity none even odd mark space phone number phone number rev sess security on off send name on off session strings delay lt 0 65535 gt initiate text terminate lt text gt sess timer lt 0 4294967 gt stop bits 1 2 1 5 termtype wyse60 vt100 ansi dumb tvi925 ibm3151te vt320 hp700 term1 term2 term3 set line flowin on off flowout on off lt 00 7f gt data logging on off initiate connection any char specific char hex value gt
51. ed The maximum size of this field is 128 bytes characters e Delay after Send JC configured will inset a delay in milliseconds after the string is sent to the device This delay can be used to provide the serial device with time to process the string before the session is initiated or terminated Default 10 ms IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Commands sess timer Enter a time in seconds for which the Session Timer will run Use this timer to forcibly close the session connection When the Session Timer 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 about 49 days stop bits Specifies the number of stop bits that follow a byte term type Specifies the type of terminal connected to the line e Dumb e WYSE60 e VT100 e ANSI e TVI925 e IBM3151TE e VT320 specifically supporting VT320 7 e HP700 specifically supporting HP700 44 e Termi Term2 Term3 user defined terminals user For DSLogin line service makes this a line that is dedicated to the specified user Only this user will be able to log in on this line and they won t need to enter their login name just their password 43 Line Commands Set Line Interface Description Configures line interface hardware parameters User Level Admin Syntax Options 44 set line lt number gt interface eia 232 monitor dcd on of
52. ent level If the Trigger Type is High an alarm is triggered when the input is higher than the specified Trigger value other severity level trigger values must increase in value with each subsequent level To clear an alarm the input must drop below the specified value when Trigger Type is High or go above the specified value when Trigger Type is Low mode Enables disables an alarm level The default is off trigger type If the Trigger Type is Low an alarm is triggered when the input drops below the specified Trigger value other severity level trigger values must decrease in value with each subsequent level If the Trigger Type is High an alarm is triggered when the input is higher than the specified Trigger value other severity level trigger values must increase in value with each subsequent level trigger level Specify the value that will trigger an alarm the measurement is based on the Type and Range that you specify This value must not fall within the scope of the value used to clear an alarm clear mode Specifies whether an activated alarm must be Manually cleared or can be cleared when the input drops below the specified value when Trigger Type is High or goes above the specified value when Trigger Type is Low clear level Specify that value that will clear an alarm the measurement is based on the Type and Range that you specify This value must not fall within the scope of the value used to trigger an alarm snm
53. entry from the phone number table Set Modbus Slave Line Description Sets the Modbus slave parameters for the line User Level Admin Syntax Options set modbus slave line lt number gt crlf on off protocol rtu ascii uid range uid range crif When Modbus ASCIl is selected adds a CR LF to the end of the transmission most Modbus devices require this option The default is On protocol Specify the protocol that is used between the Modbus Master s and Modbus Slave s either RTU or ASCII uid range You can specify a range of UIDs 1 247 in addition to individual UIDs The format is comma delimited for example 2 35 50 100 103 Set Modbus Master Line Description Sets the Modbus master parameters for the line User Level Admin Syntax Options set modbus master line lt number gt crlf on off protocol rtu ascii entry number port lt port gt protocol udp tcp range mode gateway host slave ip lt IP address gt uid range lt start_uid gt lt end_uid gt crif When Modbus ASCII is selected adds a CR LF to the end of the transmission most Modbus devices require this option The default is On protocol Specify the protocol that is used between the Modbus Master s and Modbus Slave s either RTU or ASCII entry You can specify up to 16 Modbus Slave Remote IP Mapping entries the UIDs must not overlap port The destination port of the remote Modbus TCP Slave tha
54. evel Syntax dmgrd DeviceManager daemon process in the IOLAN If you disable this service you will not be able to connect to the IOLAN with the Device Manager application DeviceManagerD listens on port 33812 and sends on port 33813 modbusd Modbus daemon process in the IOLAN on port 502 Shows the custom application server settings Admin show custom app server Shows the Modbus settings for the gateway Normal Admin show modbus gateway Shows the parameters set for the server Admin Normal show server Hardware Commands Set Ethernet Description Sets the hardware configuration for the Ethemet port s User Level Syntax Options Show Hardware 20 Description Admin set ethernet speed and duplex auto 10 half 10 full 100 half 100 full auto 10 half 10 full 100 half 100 full Define the ethernet connection speed at one of the following e auto automatically detects the ethernet interface speed and duplex 10 Mbps Half Duplex 10 Mbps Full Duplex 100 Mbps Half Duplex 100 Mbps Full Duplex Shows the hardware resources Ethernet link status date and time User Level Normal Admin Syntax show hardware IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Modbus Commands Modbus Commands Set Modbus Gateway Description Sets the Modbus parameters for the IOLAN when it is operating as a Modbus Gateway User Level Admin Syntax Options set modbus gateway addr mode embedded re mapped br
55. f monitor dsr on off flow none soft hard both speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 57600 115200 230400 28800 custom baud rate set line interface eia 422 flow none soft hard both speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 57600 1I1I5200 230400 28800 custom baud rate set line interface eia 485 tx driver control auto rts flow none soft duplex full duplex half echo suppression on off speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 57600 115200 230400 28800 custom lt baud _ rate gt eia 232 eia422 485 Specifies the type of line that is being used with the IOLAN Select either EIA 232 ETA 422 or EIA 485 TS2 supports only EIA 232 monitor dcd Specifies whether the RS 232 signal DCD Data Carrier Detect should be monitored This is used with modems or any other device that sends a DCD signal When it is monitored and the IOLAN detects a DCD signal the line service is started Default is Off If both Monitor DCD and Monitor DSR are enabled both signals must be detected before the line service is started monitor dsr Specifies whether the RS 232 signal DSR data set ready should be monitored This is used with modems or any device that sends a DSR signal When it is monitored and the IOLAN detects a DSR signal the line service is started Default is Off If both Monitor DCD and Monitor DSR are enabled bo
56. ference Guide Version 4 1 Show eet ege entree SEENEN 20 Hardware Commands 20 Set EE AME ki iii kk kk da a e ka a Oe oka ia ki in ene 20 Show Hardweare J J e kk ea ki ia 20 Modb s e a TE Le TE EN Set Modbus Gateway 1 11 n f b koka ka kn eege 21 Show Modbus U Eege 22 TruePort Baud Commands 22 Set TruePort erugeet ege EE deeg 22 Show TruePort u 22 IPv6 Commands u 23 SEENEN 23 Show IPVO uuu k u ua aaa kk s uka aaa qa kusa us sas kip ak n baba 23 Add SUC a a a a u 24 Set Custom IPv6 u 24 Delete Custom IPv6 25 Chapter 3 User Commands 27 Commands for Users Logged Into the IOLAN 27 Te EE 27 Help a S a n SSS S SSS us 27 Kill LANNE ei ek kan aus n ke aspas n esac a cence e e da eee 27 Kill S S EE 27 Te a kk a kk ko eae one kaban 27 VYE FOUA in u S s scares ec E a a ae an qusa 28 Ping antou aa ee kn pie A d kipa pipe
57. from a remote host to the IOLAN using the TFTP protocol User Level Admin Syntax Options netload text config factory default configfirmware configuration customlang tLerm1 term2 term3 customapp file hostname ip address filename text config Specify this option if you are uploading a text based configuration file to the IOLAN from a TFTP server factory default config Specifies the configuration file that you are going to load from a TFTP server to the IOLAN that will act as the factory default configuration See the User Guide for directions on how to revert back to the original factory default configuration if required firmware Specifies that you are going to download a new firmware file to the IOLAN 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 Use the shell CLI command as described in the SDK Programmer s Guide to manage the files that you download lt hostname ip_address gt The IP address or host name where the file you are downloading to the IOLAN resides If you are using a host name it must b
58. fter the TruePort connection and the TruePort client will control the state of the signals during the established TruePort connection Default Enabled multihost Used for connections coming from the network to the serial port for TruePort or Raw services allows multiple hosts to connect to the serial device multihost all backup lt config_backup_host gt lt tcp_port gt none Used for connections going from the serial port to the network for TruePort or Silent Raw services allows the serial device to communicate to either all the hosts in the multihost list or a primary backup host schema see Configuring Multiple Hosts in the IOLAN User s Guide for a more detailed explanation Sets the modem initialization string for a modem defined in the modem table If you wish to add a new modem use the add modem command Admin set modem lt modem name gt lt init_string gt lt modem_name gt Predefined modem name lt init_string gt Specify the initialization string for the modem This can be up to 60 characters long but cannot include spaces 47 Line Service Commands Set Termtype Description User Level Syntax Option Show Line Description User Level Syntax Sets the terminal type for the current terminal session term1 term2 and term3 refer to the user uploadable custom terminal definitions If these are not present the default is wyse60 Restricted Normal Admin set termtype wyse60 vt100 ansi du
59. g Input Description User Level Syntax Options 92 Manages the Digital output channel status Not all models have four digital channels most have just two Admin iochannel d1 d2 d3 d4 cts dsr dcd clear alarm input latch alarm Clears the alarm Note that if the condition that tripped the alarm still exists the alarm will not look like it s cleared but will reflect the appropriate alarm level severity Alarm Level 0 means that the alarm has not been triggered latch input Clears the latch value Manages the Digital input channel status Admin iochannel dl1 d2 d3 d4 rts dtr output activate deactivate output Manually activates deactivates the I O channel Manages the Relay output channel status Admin iochannel rl r2 output activate deactivate output Manually activates deactivates the I O channel Manages the Analog input channel status Admin iochannel al a2 a3 a4 clear alarm min max alarm Clears the alarm Note that if the condition that tripped the alarm still exists the alarm will not look like it s cleared but will reflect the appropriate alarm level severity Alarm Level 0 means that the alarm has not been triggered min Clears the minimum value max Clears the maximum value IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Glossary This chapter provides definitions for IOLAN terms BOOTP BOOTstrap Protocol Community SNMP DHCP Dynamic Host Configuration Protocol Di
60. gger or clear The syslog message is associated with Level Critical snmp Sends an SNMP trap when an alarm is triggered or cleared The trap consists of the severity level and whether the alarm was triggered or cleared description Provide a description of the channel making it easier to identify The channel description can be up to 20 characters invert signal Inverts the actual condition of the I O signal in the status therefore an inactive status will be displayed as active 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 Input Serial Pins Description Sets the Digital input settings for serial pins CTS DSR and DCD This option is only 80 User Level Syntax Options available when the Line Service is set to Signal I O Admin set iochannel cts dsr dcd alarm trigger disabled inactive input active input clear auto manual syslog on off snmp on off description lt string gt invert signal on off latch disabled inactive to active active to inactive digital_channel Specify the Digital channel number for example d2 alarm Configures alarm settings when the Digital input trigger is activated IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel trigger When the trigger condition is
61. gt idle timer lt 0 4294967 gt language english customlang level admin normal restricted menu password line access readin readwrite on off lt line s gt 0 service dsprompt telnet tcp clear sess timer lt 0 4294967 gt port tcp clear telnet lt tcp port gt host ip For outbound User Services such as Telnet this is the target host name or IP address If no IP address is specified the Host IP value in the Default User configuration will be used The default is 0 0 0 0 or None hotkey prefix The prefix that a user types to control the current session The default value is hex 01 which corresponds to Ctrl a Aa hex value 02 would be Ctrl b b etc e anumber To switch from one session to another press a and then the required session number For example a 2 would switch you to session 2 Pressing a 0 will return you to the IOLAN Menu e an Display the next session The current session will remain active The lowest numbered active session will be displayed e a p Display the previous session The current session will remain active The highest numbered active session will be displayed e 4am To exit a session and return to the IOLAN You will be returned to where you left off The session will be left running e al Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password excluding spaces and locks the line Next the use
62. he default is disabled Set IOChannel Digital Output Description Sets the Digital output channel settings User Level Admin Syntax Options set iochannel digital channel type sink source sink and source active signal width width inactive signal width width failsafe action none activate output deactivate output set iochannel digital channel output pulse continuous counted pulse count active to inactive delay delay inactive to active delay delay digital channel Specify the Digital channel number for example d2 81 Set IOChannel 82 type Specify the type of digital output e Sink Specifies that the channel will be grounded when active e Source Specifies that the channel will provide voltage when active e Sink and Source Specifies that channel will be grounded when it is inactive and will provide voltage when it is active The default is Sink active signal width How long the channel output will be active during the pulse mode Valid values are 1 9999 x 100 ms The default is 100 ms inactive signal width How long the channel output will remain inactive during pulse mode Valid values are 1 9999 x 100 ms The default is 100 ms failsafe action When there has been no I O activity within the specified time set in the Global Settings and the Failsafe Timer is triggered you can set the Failsafe Action to e None The state of the Digital Relay output remai
63. hether a user will use English or Customlang as the language that appears in the Menu or CLI The IOLAN supports one custom language that must be downloaded to the IOLAN otherwise Customlang defaults to English level The access that a user is allowed e 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 e Normal The Normal level user has limited access to the IOLAN Limited CLI commands and Menu access are available with the ability to configure the user s own configuration settings e Restricted The Restricted level user can only access predefined sessions or access the Easy Port Access menu e Menu The menu level user will only be able to access predefined session or access the Easy Port Access menu The Easy Port Access allows the user to connect to the accessible line without disconnecting their initial connection to the IOLAN Does not have any access to CLI commands 33 Configuring Users 34 line access Specifies the user access rights to each IOLAN device line Options are e Read Write Users are given read and write access to the line e Read In Users are given access to read only outbound data data that is going from the IOLAN to the device The on off option is only for 1 port models You can disable line access in 2 port models by specifying 0 zero phone
64. host lt host gt lt TCP_port gt set multihost line lt number gt entry lt number gt delete entry You can specify up to 100 hosts in the multihost table host lt host gt Specify the preconfigured host that will be in the multihost list TCP port Specify the TCP port that the IOLAN will use to communicate to the Host delete Deletes the specified entry from the multihost table Set Line Initiate Connection 54 Description User Level Syntax Options Determines how the connection is initiated for Direct Telnet Admin set line lt number gt initiate connection any char specific char lt hex gt any char Initiates a connection to the specified host when any data is received by the serial port specific char lt hex gt Initiates a connection to the specified host only when the specified character is received by the serial port IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Service Commands Show Custom App Description Shows the custom application line settings User Level Admin Syntax show custom app line lt number gt Show Interface Description Shows the network interface information User Level Admin Syntax show interface brief ethernet Show Modbus Description Shows the Modbus settings for a line User Level Admin Syntax show modbus master slave lt number gt Show Telnet Client Description Shows the telnet client settings for a line User Level Admin Syntax show te
65. ilename set motd file local file gt display When enabled displays the Message of the Day to users who are logging into WebManager or EasyPort Web The default is off host The host that the IOLAN will be getting the Message of the Day file from path filename The path and file name do not use a drive letter relative to the default path of your TFTP server software of the file that contains a string that is displayed when a user connects to the IOLAN local file This is the name of a file already downloaded to the IOLAN The contents of this file will be used for the MOTD Show the Message of the Day MOTD settings Admin show motd 73 MOTD Commands 74 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Statistic Commands This chapter defines all the CLI commands associated with configuring the IOLAN s statistic 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 all Displays all ports including server listening ports by default listening ports are not displayed listening Displays server listening ports by default listening ports are not displayed tep Displays TCP port statistics udp Displays UDP port statistics tcpv6 Displays TCPv6 pott statistics udpv6 Displays UDPVv6 port statistics Show Modbus Statistics
66. ion Shows SNMP settings including communities and traps User Level Admin Syntax show snmp 62 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 TFTP Commands TFTP Commands Set Server TFTP Description Configures the IOLANs TFTP client settings User Level Syntax Options Admin set server tftp retry lt integer gt timeout lt integer gt retry The number of times the IOLAN will attempt to transfer using TFTP a file to from a host Enter a value between 0 and 5 The default is 5 A value of 0 zero means that the IOLAN will not attempt a retry should TFTP fail timeout The time in seconds that the IOLAN will wait for a successful transmit or receipt of TFTP packets before retrying a TFTP transfer Enter a value between 3 and 10 The default is 3 seconds Hosts Commands Add Host Description User Level Syntax Options Delete Host Description User Level Syntax Option Set Host Description User Level Syntax Options Adds a host to the IOLAN host table Admin add host lt hostname gt lt ip_address gt lt hostname gt The name of the host lt ip_address gt The host IPv4 or IPv6 address Deletes a host from the IOLAN host table Admin delete host config host lt config_host gt You can see a list of hosts that can be deleted by typing delete host Configures a host in the IOLAN host table Admin set host config host ip address lt config_host gt The
67. ires because of no I O activity within the specified time interval the Failsafe Action set for the channel determines the action on the output timeout The number of seconds that must elapse with no I O activity before the channel Failsafe Action is triggered Valid values are 1 9999 The default is 30 seconds Enabling the Modbus option makes the IOLAN act as a Modbus Slave allowing Modbus Masters to communicate with the IOLAN to control and or retrieve I O data Admin set io modbus mode on off uid lt 1 255 gt mode Enables disables the ability to control monitor I O channels using the Modbus protocol uid This is the UID you are assigning to the IOLAN which is acting as a Modbus slave Set IO Temperature Scale Description User Level Syntax Option Set Line Set Line Service Description User Level Syntax Option 78 Sets the temperature scale that will be used for all Temperature input readings Admin set io temperature scale celsius fahrenheit temperature scale Select the temperature scale that will be used to display temperature data either Fahrenheit or Celsius The default is Celsius Sets the Line Service settings to signal I O When the line service is set to signal io you also have the option of enabling the I O extension for the serial singal pins See Set TOChannel IOExtension on page 88 for more information Admin set line lt number gt service signal io signal io Sets the line
68. koke ces ken kok ET 28 Resume u as ets Abel a tip ka do n a n on ka ak e pan kaka ea 28 CC co Tum ua hik Sanu saka eee eee qusha a ee 28 Set Jentges 28 EE 29 Set E e sezi oke ab kan kk io lak ik kl lik io bo n inn kapa okin iii Red 29 Show Lin E uuu io bobo ek nati aba io koko ki a ka kaban 30 Syslog CGONSONO iii bebe bain ai kk bk ko bb ik ka aka ii pi bon eee 30 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Show Termtype uU Pe oe ee eee 30 Start A io e e anan eto EE 30 LEI E PO NO A NE A FA un m eres eres 31 NEES eegen 32 Configuring HE asss bak kn en antanke KAYE Aks bain 32 Add USET eege 32 Delete L S T viisiin uuu ee on a ak eee 32 Set Default User cance u u 32 EEN 35 Set User SESSION oho u uuu suu pk ko tk ka S pon a n kk e pl n ma e ae 37 Show Default US r_ u u au Uu pe a ko kt a n ka n a di ae 37 SO ON VI SOU aa kk kk kk a n n a eae e a aw e aa a s 37 Chapter 4 Line Commands 39 1 Port vs 2 Port Line Commands 39 Line Commands 39 Set AEN 39 SEELEN ee ee a ener een daqa 44 Set BT U ko kk a kk l kk ko ak kk 45 Set MON MN eer 47 Set EE e E 48 Show RTE 48 Line Service Commands 48 Set GASTON E RE 48
69. level trigger values must increase in value with each subsequent level trigger level Specify the value that will trigger an alarm the measurement is based on the Type and Range that you specify This value must not fall within the scope of the value used to clear an alarm clear mode Specifies whether an activated alarm must be Manually cleared or can be cleared when the input drops below the specified value when Trigger Type is High or goes above the specified value when Trigger Type is Low clear level Specify that value that will clear an alarm the measurement is based on the Type and Range that you specify This value must not fall within the scope of the value used to trigger an alarm snmp Sends an SNMP trap when an alarm is triggered or cleared The trap consists of the severity level and whether the alarm was triggered or cleared syslog Sends a message to syslog when an alarm is triggered or cleared The syslog entry includes the severity level and the value that caused the alarm to trigger or clear The syslog message is associated with Level Critical 87 Set IOChannel Set IOChannel IOExtension Description Configures the I O extension options that allow you to connect the Digital Input User Level Syntax Options 88 channel or input serial signal pin when the line is configured for signal io to Digital Output Relay channels or output serial signal pins when the line is configured for sign
70. lnet client Show UDP Description Shows the UDP settings for the line User Level Admin Syntax show udp Show Vmodem Description Show the vmodem settings for the line User Level Admin Syntax show vmodem Show Vmodem Phone Description Show the vmodem phone entries User Level Admin Syntax show vmodem phone 55 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 User Level Admin Syntax delete modem lt config modem name Option config modem name You can see a the list ofmodems that can be deleted by typing delete modem Show Modems Description Shows the IOLAN modem table User Level Normal Admin Syntax show modems 56 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 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 User Level Syntax Options device is packetized before forwarding the packet onto the LAN network This command configures packet forwarding options for serial devices attached to the serial line The command is broken up into logical flows that can
71. lowing command to break down the command syntax set service dhcp bootp on off telnetd on off httpd on off snmpd on off spcd on off syslog on off dmgrd on off Square brackets show the options that are available for the command You can type a command with each option individually or string options together in any order you want For example set service dhcp bootp on telnetd off Angle brackets lt gt show that the text inside the brackets is a description for a variable value that you must fill in according to your requirements In the set server command you must determine the values for domain internet name password limit and subnet bit length if you wish to specify them and not use their defaults default values provided in the Options description The angle brackets can also contain a range that can be used The pipe shows an or condition For example valid values for telnetd are either on or off IOLAN DS1 TS2 CLI Reference Guide Version 4 1 15 CLI Conventions e Options Provides an explanation of each of the options for a command and the default value if there is one Some commands do not have any options so this category is absent Command Shortcuts When you type a command you can specify the shortest unique version of that command or you can press the ESC or TAB key to complete the command For example the following command set telnet client map to crlf off can be
72. mb tvi925 ibm315lte vt320 hp700 Lterml term2 term3 eg EE 51te vt320 hp700 term1 term2 term3 Specifies the type of terminal connected to the line Dumb WYSE60 VT100 ANSI TVI925 IBM3151TE VT320 specifically supporting VT320 7 HP700 specifically supporting HP700 44 Term Term2 Term3 user defined terminals Shows the line settings information Admin show line Line Service Commands Set Custom App Description User Level Syntax Options 48 You can create a custom application that can run on a specific serial line in IOLAN using the Perle SDK Admin set custom app line lt number gt program command line lt command gt 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 Maximum of 80 characters Use the she11 CLI command as described in the SDK Programmer 5 Guide to manage the files that you have downloaded to the IOLAN For example using sample outraw program you would type outraw 192 168 2 1 10001 Acct 10001 if you were starting the application on a line IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Service Commands Set Telnet Client Description Configures the Telnet parameters for the specified line When the IOLAN initiates a User Level Syntax Options Telnet connection to a host it is acting as a Telnet client Normal Admin set telnet client lin
73. ment this product may cause radio interference in which case the user may be required to take adequate measures Caution The IOLAN Device Server is approved for commercial use only CE Table of Contents P IFORRC6 uuv susu Egeter 11 About This BOOK usus eee eee 11 Intended Audience 11 Typeface Csenge 11 Contacting Technical Support 12 Making a Technical Support Query 12 Who TO in Reema z uuu au n Mere e Ru te sete teen eater 12 Have Your Product Information Ready 12 Making a support query via the Perle web page 12 Repair Eelere 13 Feedback on this Manual 13 Chapter 1 Introduction 15 ee E EE 15 CH e 15 Command EE E 15 Command Shortcuts 16 Command Options u u 16 Chapter 2 Server Commands 17 Server Commands UU ke en reece 17 Set Custom App E 17 Ee 17 Set UG eeneg 19 SHOW Custom App u 20 Show Modhhbus al ik 20 IOLAN DS1 TS2 CLI Re
74. n Description User Level Syntax Description User Level Syntax Options Description User Level Syntax Options Description User Level Syntax Set Termtype 28 Description User Level Syntax Option Switches from a command line based interface to Menu mode of operation Restricted Normal Admin menu This command checks to see if a given host is reachable via an IP message The specific message used is called a ping Normal Admin ping lt hostname IP address gt lt packet size gt lt of packets gt lt hostname IP_address gt The DNS resolvable host name or IP address of the machine you are trying to ping lt packet_size gt Enter the number of data bytes to be sent The default is 100 bytes of packets Enter the number of the packets you want to send The default is 10 Resumes a started session Restricted Normal Admin resume 1 2 3 4 1 2 3 4 The number of the session you want to resume Switches from a command line based interface to Menu mode of operation Restricted Normal Admin screen Sets the type of terminal being used for the current session Normal Admin set termtype wyse60 vt100 ansi dumb tvi925 ibm3151te vt320 hp700 term term2 term3 wyse60 vt100 ansij dumb tvi925 ibm3151te vt320 hp700 term1 term2 term3 Specifies the type of terminal connected to the line Dumb WYSE60 VT100 ANSI TVI925 IBM3151TE VT320 specifically supporting VT320 7 H
75. n so if you change this setting to Output you will have to also change the internal hardware jumpers Set IOChannel Digital Input Description Sets the Digital input settings for the channel User Level Admin Syntax Options set iochannel digital channel alarm trigger disabled inactive input active input clear auto manual syslog on off snmp on off description lt string gt invert signal on off latch disabled inactive to active active to inactive digital_channel Specify the Digital channel number for example d2 alarm Configures alarm settings when the Digital input trigger is activated 79 Set IOChannel trigger When the trigger condition is met triggers the specified alarm action Triggers can be e Disabled No alarm settings This is the default e Inactive When the expected Digital input is active going inactive will trigger an alarm e Active When the expected Digital input is inactive going active will trigger an alarm clear Specify Manual to manually clear an alarm Specify Auto to automatically clear the alarm when the trigger condition changes for example if the Trigger is Inactive and the alarm is triggered once the input becomes active again the alarm will be cleared when Auto is set The default is Auto syslog Sends a message to syslog when an alarm is triggered or cleared The syslog entry includes the severity level and the value that caused the alarm to tri
76. n to FLASH User Level Admin Syntax save IOLAN DS1 TS2 CLI Reference Guide Version 4 1 69 Bootup Commands Set Bootup Description User Level Syntax Options Show ARP Description User Level Syntax Show Bootup Description User Level Syntax 70 Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot Admin set bootup firmware host lt hostname gt file lt path filename gt set bootup configuration host lt hostname gt file lt path filename gt firmware file The path and file name do not use a drive letter relative to the default path of your TFTP server software of the update software for the IOLAN that will be loaded when the IOLAN is rebooted configuration file The path and file name do not use a drive letter relative to the default path of your TFTP server software of the configuration software for the IOLAN that will be loaded when the IOLAN is rebooted host The host name or IPv4 IPv6 address of the server that contains the configuration or firmware file If you use a host name it must exist in the IOLAN s host table or be resolved by DNS Shows the current contents of the ARP cache Admin show arp Shows the Firmware and Configuration files specified for IOLAN bootup Admin show bootup IOLAN DS1 TS2 CLI Reference Guide Version 4 1 TFTP File Transfer Commands TFTP File Transfer Commands Netload Description Transfers a file
77. name of the host lt ip_address gt The host IPv4 or IPv6 address 63 Gateway Commands Show Hosts Description User Level Syntax Shows the IOLAN host table Normal Admin show hosts Gateway Commands Add Gateway Description User Level Syntax Options Delete Gateway Description User Level Syntax Option 64 Adds a gateway You can configure up to twenty gateways Admin add gateway lt config host gt default add gateway lt config host gt host lt dest IP addr gt add gateway lt config host gt network lt dest_IPv4_addr gt lt dest_IPv6_addr gt subnet bits 0 32 subnet bits 0 128 gt lt config_host gt You can specify up to twenty hosts to act as gateways in your network Each gateway host must be defined in the IOLAN host table default host network Specify the type of gateway e Default A gateway which provides general access beyond your local network e Host A gateway reserved for accessing a specific host external to your local network e Network A gateway reserved for accessing a specific network external to your local network lt dest_IP_addr gt When the gateway is a Host or Network gateway you must specify the IPv4 or IPv6 address of the target host machine network lt subnet_bits gt When the gateway is a Network gateway you must specify the network s subnet mask Deletes a gateway Admin delete gateway lt config gateway host lt config_g
78. ne for a client tunnel connection server tunnel Sets the line for a server tunnel connection modbus master Sets the line to act as a Modbus master custom app Sets the line to use the custom application created with the SDK trueport Sets the line to communicate with the TruePort utility You must install the TruePort utility on the host machine IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Commands Set Modem Description User Level Syntax Options client initiated When this option is turned on the IOLAN will wait for a connection from the TruePort host see the TruePort documentation for information on how to set up this feature on the TruePort host When this option is turned off the IOLAN will initiate the connection to the TruePort host The default is off signal active This option has the following impact based on the state of the TruePort connection e TruePort Lite Mode When enabled the EIA 232 signals remain active before during and after the TruePort connection is established When disabled the EIA 232 signals remain inactive when there is no TruePort connection and active when there is a TruePort connection e TruePort Full Mode When enabled the EIA 232 signals remain active before and after the TruePort connection and the TruePort client will control the state of the signals during the established TruePort connection When disabled the EJA 232 signals remain inactive before and a
79. ns the same no change e Activate Output Activates the output e Deactivate Output Deactivates the output output Specify how the channel Digital output will be handled e Manual You must manually activate and deactivate the output e Pulse When the output is activated this configuration will cause the output to pulse go active and inactive at a configured rate e Inactive to Active Delay The channel output will remain inactive for the specified time interval after it is manually started e Active to Inactive Delay The channel output will go inactive after the specified time interval after it is manually started The default is Manual pulse When the Output is Pulse you can have it pulse in a Continuous manner or specify a pulse Count each count consists of an active inactive sequence The default is 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 Valid values are 1 9999 x 100 ms The default is 100 ms IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel Set IOChannel Digital Output Serial Pins Description Sets the Digital output for serial pins RTS and DTR This option is only available when Use
80. ntax Syslog Console Description User Level Syntax Options Show Sessions Description User Level Syntax Show Termtype Description User Level Syntax Start Description User Level Syntax Options 30 Shows the users who are on the line Admin show line users Starts stops or displays the status of the syslog console Admin syslog console start stop syslog console status start stop Start or stop console logging When console logging is enabled syslog messages will be echoed to the current console These messages are filtered based on the level set in the remote syslog options status Displays the current console logging status enabled or disabled Shows available sessions Restricted Normal Admin show sessions Shows the terminal type for the current session Admin show termtype Starts a predefined session Only inactive sessions are displayed Restricted Normal Admin start 1 2 3 4 1 2 3 4 The number of the session that you want to start IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Commands for Users Logged Into the IOLAN Telnet Description Starts a telnet session to the specified host IP address User Level Normal Admin Syntax Options telnet hostname IP address tcp port termtype terminal name gt line mode on off map cr crlf on off local echo on off echo lt 00 7f gt eof lt 00 7 gt erase 00 7f intr lt 00 7f gt qui
81. oadcast on off char timeout lt number gt req next delay lt number gt exceptions on off idle timer lt number gt mess timeout lt number gt port lt TCP UDP port gt req queuing on off remapped id lt 1 247 gt addr mode Determines if the original UID address will be embedded in the transmission header or if a specified remapped UID will be embedded in the transmission header broadcast When enabled a UID of 0 zero indicates that the message will be broadcast to all Modbus Slaves The default is Off char timeout Used in conjunction with the Modbus RTU protocol specifies how long to wait in milliseconds after a character to determine the end of frame The default is 30 ms 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 The default is On idle timer Specifies the number of seconds that must elapse without any network or serial traffic before a connection is dropped If this parameter is set to 0 zero a connection will not be dropped with the follo
82. or example CONNECT 9600 suppress If set to No connection success failure indication strings are sent to the connected device otherwise these indications are suppressed Description This command associates a phone number with an IP address and TCP port This User Level Syntax Options enables the existing modem application to issue 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 establish the connection This is a universal command meaning that all VModem lines will have access to the entries defined here 1 port models support up to 4 entries all other desktop models support up to 8 entries and rack mount models support up to 48 entries Admin set vmodem phone entry lt number gt phone number lt string gt IP address TCP port set vmodem phone entry number delete entry Specify the entry number in the vmodem phone number table phone number Specify the phone number that your application uses to connect to remote location Enter the number exactly as it is issued by your application IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Service Commands lt IP_address gt Specify the IP address of the remote host that is receiving the vmodem connection TCP port Specify the TCP port that the remote host is lisening on for the vmodem connection delete Deletes the specified
83. p Sends an SNMP trap when an alarm is triggered or cleared The trap consists of the severity level and whether the alarm was triggered or cleared syslog Sends a message to syslog when an alarm is triggered or cleared The syslog entry includes the severity level and the value that caused the alarm to trigger or clear The syslog message is associated with Level Critical 85 Set IOChannel Set IOChannel Analog Temperature Description Sets the Analog input channel settings for Temperature models User Level Admin Syntax Options 86 set iochannel lt analog channel gt type rtd thermocouple range range specifier set iochannel analog channel alarm level 1 2 3 4 5 mode on off trigger type disabled low high trigger level decimal value clear mode auto manual clear level decimal value snmp on off syslog on off analog channel Specify the Analog channel number for example a2 or a4 this also applies to Temperature models type Specify the type of sensor you are using to measure temperature either RTD or thermocouple The default is RTD 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 8 Pt100 a 392 0 to 200C 9 Pt100 a 392 0
84. r must retype the password to unlock the line e Ar When you switch from a session back to the Menu the screen may not be redrawn correctly If this happens use this command to redraw it properly This is always Ctrl R regardless of the Hotkey Prefix The User Hotkey Prefix value overrides the Line Hotkey Prefix value You can use the Hotkey Prefix keys to lock a line only when the line Lock parameter is On idle timer The amount of time in seconds that the Idle Timer will run Use this timer to close a connection because of inactivity When the Idle Timer expires because there has been no exchange of data within the specified time the IOLAN will close the connection The default value is 0 zero meaning that the Idle Timer will not expire the connection is open permanently The maximum value is 4294967 seconds The User Idle Timer will override the Line Idle Timer with the exception of reverse Telnet sessions language You can specify whether a user will use English or Customlang as the language that appears in the Menu or CLI The IOLAN supports one custom language that must be downloaded to the IOLAN otherwise Customlang defaults to English 35 Configuring Users 36 level The access that a user is allowed e 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 e Normal
85. r Level Syntax Options the Line Service is set to Signal I O Admin set iochannel rts dtr description lt string gt failsafe action none activate outut deactivate output mode enabled disabled description Provide a description of the channel making it easier to identify The channel description can be up to 20 characters failsafe action When there has been no UO activity within the specified time set in the Global Settings and the Failsafe Timer is triggered you can set the Failsafe Action to e None The state of the Digital Relay output remains the same no change e Activate Output Activates the output e Deactivate Output Deactivates the output mode Enables the channel allowing the settings to become active Set IOChannel Relay Description Sets the Relay output channel settings User Level Syntax Options Admin set iochannel lt relay number gt output pulse continuous counted lt pulse_count gt active to inactive delay lt delay gt inactive to active delay lt delay gt set iochannel lt relay number gt active signal width lt width gt inactive signal width lt width gt failsafe action none activate deactivate relay_number Specify the Relay channel number for example r2 output Specify how the channel Digital output will be handled e Manual You must manually activate and deactivate the output e Pulse When the output is activated this configuration will ca
86. rect Connection Ethernet Local Authentication Modem Initialization String MOTD Multicast NAK Negative Acknowledgment Reverse Connection Silent Connection SNMP Simple Network Management Protocol Subnet Prefix Bits 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 the workstation to boot without requiring a hard or floppy disk drive An SNMP community is the group that devices and management stations running SNMP belong to It helps define where information is sent A TCP IP protocol that provides static and dynamic address allocation and management Connections that bypass the IOLAN enabling the user to log straight into a specific host A direct connection is recommended where a user logging in to the IOLAN is not required A high speed 10Mbps 100Mbps cable technology that connects devices to a LAN using one or more sets of communication protocols Uses the user ID and password stored within the IOLAN User database A series of commands sent to the modem by a communications program at start up These commands tell a modem how to set itself up in order to communicate easily with another modem Message of the day This is defined by a file whose contents display when users log into the IOLAN The broadcasting of messages to a specified group of works
87. s configured as digital output you must select a local digital input channel or input serial signal pin on the IOLAN Note that the Failsafe Action is not compatible with the local connection option Default Client Initiated client initiated tcp port The TCP port that the channel serial signal pin will use to listen for incoming connections Default 2000 for channel 1 then increments by one for each channel client initiated multihost When this option is enabled multiple I O channels and or TCP IP applications can connect to this channel serial signal pin The default is off server initiated tep 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 lt config_backup_host gt 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 IOLAN User 5 Guide for a more detailed explanation local connection lt input_channel gt Specify the Digital input channel or input serial signal pin that will control the Digital Relay output channel or output serial signal pin 89 Set IOChannel Set IOChannel Multihost Description User Level
88. ses Typeface Conventions Most text is presented in the typeface used in this paragraph Other typefaces are used to help you identify certain types of information The other typefaces are Typeface Example Usage At the C prompt type add host This typeface is used for code examples and system generated output It can represent a line you type in or a piece of your code or an example of output Set the value to TRUE The typeface used for TRUE is also used when referring to an actual value or identifier that you should use or that is used in a code example subscribe project subject run yourcode exec The italicized portion of these examples shows the typeface used for variables that are placeholders for values you specify This is found in regular text and in code examples as shown Instead of entering project you enter your own value such as stock trader and for yourcode enter the name of your program IOLAN DS Family User 5 Guide This typeface indicates a book or document title See About This Book on page 11 for more information This indicates a cross reference to another chapter or section that you can click on to jump to that section IOLAN DS1 TS2 CLI Reference Guide Version 4 1 11 Contacting Technical Support Contacting Technical Support Making a Technical Support Query Who To Contact Note Perle offers free technical support to Perle Authorised Distributors an
89. sing the following address Email ptac perle com Please include the title part number and date of the manual you can find these on the title page at the front of this manual Contacting Technical Support 14 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Introduction Introduction This chapter 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 Terminal Server customer and would like to configure the IOLAN in the native Terminal Server interface you can type the command ts config to display and use the native Terminal Server interface you must have User Level Admin See your Terminal Server User Guide for information on using the Terminal Server interface Command Syntax Each command is broken down into several categories Description Provides a brief explanation of how the command is used User Level Shows which user level s Restricted Normal and or Admin can issue the command Some commands have options that are available for one user level and not for another level this usually occurs when a command is valid for both Normal and Admin user levels where the Admin user level command will have extended options Syntax Shows the actual command line options The options can be typed in any order on the command line The syntax explanation will use the fol
90. ssion back to the Menu the screen may not be redrawn correctly If this happens use this command to redraw it properly This is always Ctrl R regardless of the Hotkey Prefix The User Hotkey Prefix value overrides the Line Hotkey Prefix value You can use the Hotkey Prefix keys to lock a line only when the line Lock parameter is On language You can specify whether a user will use English or Customlang as the language that appears in the Menu or CLI The IOLAN supports one custom language that must be downloaded to the IOLAN otherwise Customlang defaults to English password The password the user will need to enter to login to the IOLAN This case sensitive field accepts a maximum of 16 characters Sets the current users session settings Normal Admin set user session 1 2 3 4 auto on off type off telnet set user session 1 2 3 4 telnet options host config host port TCP port gt termtype terminal name gt line mode on off map cr crlf on off local echo on off echo 00 7f eof 00 7f erase lt 00 7f gt intr lt 00 7f gt quit lt 00 7f gt session Specifies the session number or all that you are configuring auto Specify whether or not the session s will start automatically when the user logs into the IOLAN telnet options See Set Telnet Client in the IOLAN User 5 Guide 29 Commands for Users Logged Into the IOLAN Show Line Users Description User Level Sy
91. ssword 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 A user with Admin level rights can restart the serial port bypassing the timeout by issuing a kill on the disabled serial port The default value is 3 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Server Commands Set Service Description User Level Syntax Options prompt with name Displays the Server Name field value instead of default product name When enabled the Server Name is displayed in the IOLAN login prompt CLI prompt WebManager login screen and the heading of the Menu The default value is Off single telnet In this mode of operation the IOLAN will only allow for a single TCP connection at a time to exist for each serial port configured for a reverse connection type Subsequent connection attempts will be refused until all of the following conditions are met e No active connection to serial port exists and at least 1 second has passed since last connection was terminated e Alldata from previous connection on the serial port has been transmitted The IOLAN has logic to automatically detect when a reverse connection is no longer active When this happens the connection is reset and the server can go
92. t lt 00 7f gt escape lt 00 7f gt lt hostname IP_address gt The name resolvable via DNS or IP address of the host you wish to connect to with Telnet lt tcp_port gt The port number the target host is listening on for incoming connections The default for Telnet is port number 23 termtype Type of terminal attached to this line for example ANSI or WYSE60 line mode When On keyboard input is not sent to the remote host until Enter is pressed otherwise input is sent every time a key is pressed Default is Off map cr crlf Maps carriage returns CR to carriage return line feed CRLF The default value is Off local echo Toggles between local echo of entered characters and suppressing local echo Local echo is used for normal processing while suppressing the echo is convenient for entering text that should not be displayed on the screen such as passwords This parameter can only be used when Line Mode is On Default is Off echo Defines the echo character When Line Mode is On typing the echo character echoes the text locally and sends only completed lines to the host This value is in hexadecimal with a default value of 5 ASCII value AE eof Defines the end of file character When Line Mode is On entering the eof character as the first character on a line sends the character to the remote host This value is in hexadecimal with a default value of 4 ASCII value 4D erase Defines the erase char
93. t the IOLAN will connect to 53 Line Service Commands Set Multihost Line Description User Level Syntax Options protocol Specify the protocol that is used between the Modbus Master and Modbus Slave s either TCP or UDP range mode If you specify Host the IP address is used for the first UID specified in the range The last octect in the IPv4 address is then incremented for subsequent UID s in that range The Host option is not applicable for IPv6 addresses If you specify Gateway the Modbus Master Gateway will use the same IP address when connecting to all the remote Modbus slaves in the specified UID range slave ip The IP address of the TCP Ethernet Modbus Slave uid range When Range Mode is Host and you have sequential Modbus Slave IP addresses for 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 Configures multiple hosts or a primary backup host schema for Silent Raw Reverse Raw or Client Initiated TruePort service types multihost must be enabled by the line service type for this to take effect see Set Line Service on page 45 for the command to enable multihost Admin set multihost line lt number gt entry lt number gt
94. tations on a LAN WAN or internet A communication control character sent by the receiving destination indicating that the last message was not received correctly Connections that originate from a host that go directly to a serial device through the IOLAN Silent connections are the same as direct connections except that they are permanently established The host login prompt is displayed on the screen Logging out redisplays this prompt Silent connections unlike direct connections however make permanent use of pseudo tty resources and therefore consume host resources even when not in use A protocol for managing network devices Identifies the devices IP address which portion constitutes the network address and which portion constitutes the host address IOLAN DS1 TS2 CLI Reference Guide Version 4 1 93
95. th signals must be detected before the line service is started flow Defines whether the data flow is handled by the software Soft hardware Hard Both or None tx driver control Used with a EIA 485 serial interface if your application supports RTS Request To Send select this option Otherwise select Auto Default is Auto duplex Specify whether the line is Full Duplex communication both ways at the same time or Half Duplex communication in one direction at a time IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Line Commands Set Line Service Description User Level Syntax Options 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 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 If your application cannot handle loopback data echo suppression should be On The default is echo suppression Off speed Specifies the baud rate of the line keep in mind that speed is affected by the length of the cable You can also specify a custom baud rate valid values are 50 1843200 Sets the service for the line For services that need further configuration see Line Service Commands on page 48 to find the Line Service that you want to configure Admin set line lt number gt service bidir lt config host gt
96. tive The lowest numbered active session will be displayed e a p Display the previous session The current session will remain active The highest numbered active session will be displayed e 4am To exit a session and return to the IOLAN You will be returned to where you left off The session will be left running e al Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password excluding spaces and locks the line Next the user must retype the password to unlock the line e Ar When you switch from a session back to the Menu the screen may not be redrawn correctly If this happens use this command to redraw it properly This is always Ctrl R regardless of the Hotkey Prefix The User Hotkey Prefix value overrides the Line Hotkey Prefix value You can use the Hotkey Prefix keys to lock a line only when the line Lock parameter is On idle timer The amount of time in seconds that the Idle Timer will run Use this timer to close a connection because of inactivity When the Idle Timer expires because there has been no exchange of data within the specified time the IOLAN will close the connection The default value is 0 zero meaning that the Idle Timer will not expire the connection is open permanently The maximum value is 4294967 seconds The User Idle Timer will override the Line Idle Timer with the exception of reverse Telnet sessions language You can specify w
97. to 400C 10 Pt100 a 392 200 to 200C 11 Pt1000 a 385 40 to 160C 12 NiFe604 a 518 80 to 100C 13 NiFe604 a 518 0 to 100C For thermocouple the range is b B 500 to 1800C e E 0 to 1000C j J Oto 760C This is the default k K Oto 1370C r R 500 to 1750C s S 500 to 1750C t T 100 to 400C alarm Configures alarm settings when the Analog input trigger is activated IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel level You can specify up to five alarm trigger clear severity levels If the Trigger Type is Low an alarm is triggered when the input drops below the specified Trigger value other severity level trigger values must decrease in value with each subsequent level If the Trigger Type is High an alarm is triggered when the input is higher than the specified Trigger value other severity level trigger values must increase in value with each subsequent level To clear an alarm the input must drop below the specified value when Trigger Type is High or go above the specified value when Trigger Type is Low mode Enables disables an alarm level The default is off trigger type If the Trigger Type is Low an alarm is triggered when the input drops below the specified Trigger value other severity level trigger values must decrease in value with each subsequent level If the Trigger Type is High an alarm is triggered when the input is higher than the specified Trigger value other severity
98. to log straight into a specific host A direct connection is recommended where a user logging in to the IOLAN is not required It is also recommended where multiple sessions are not a requirement The message Press return to continue is displayed on the users screen The user must press a key to display the host login prompt The message is redisplayed on logout silent Silent connections are the same as direct connections except they are permanently established The host login prompt is displayed on the screen Logging out redisplays this prompt Silent connections unlike direct connections however make permanent use of pseudo tty resources and therefore consume host resources even when not in use raw Creates a connection where no authentication takes place and data is passed unchanged telnet Sets the line for a telnet connection reverse Enables a TCP IP host to establish a login connection on an external machine attached to a port For example to access machines like protocol converters statistical multiplexors or machines like routers firewalls servers etc dslogin The default connection The IOLAN displays a login on that line For example DSLogin is used when a System Administrator configures the IOLAN or users starts a session s from the IOLAN to hosts udp 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 client tunnel Sets the li
99. to use signal I O You still need to define the serial pins for digital input CTS DSR or DCD or digital output RTS or DTR See Set JOChannel Digital Input Serial Pins on page 80 or Set IOChannel Digital Output Serial Pins on page 83 for configuration options IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Set IOChannel Set IOChannel Set IOChannel Mode Description Sets general I O channel settings for the specified channel these settings are available User Level Syntax Options to all channels and I O serial pins Admin set iochannel i o channel mode enabled disabled description lt string gt i o channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al a4 mode Enables the channel allowing the settings to become active description Provide a description of the channel making it easier to identify The channel description can be up to 20 characters Set IOChannel Digital I O Description Sets up the Digital I O channel to act as either an output or input channel User Level Admin Syntax Options set iochannel digital channel source type input output digital channel Specify the Digital channel number for example d2 source type Specify whether the channel will drive the line output or will be reading the status of the line input The default is Input The internal jumpers must match the software configuratio
100. tween characters before the packet is transmitted to the network A value of zero 0 ignores this parameter Valid values are 0 65535 ms The default is 0 packet size The number of byte that must be received from the serial port before the packet is transmitted to the network A value of zero 0 ignores this parameter Valid values are 0 1024 bytes The default is 0 sofi When enabled the Start of Frame character defines the first character of the frame any character s received before the Start of Frame character is ignored Valid values are in hex 0 FF The default is 0 sof2 When enabled creates a sequence of characters that must be received to create the start of the frame if the SOF 1 character is not immediately followed by the SOF2 character the IOLAN waits for another SOF 1 character to start the SOF1 SOF2 character sequence Valid values are in hex 0 FF The default is 0 start frame transmit When enabled the SOF1 or SOF1 SOF2 characters will be transmitted with the frame If not enabled the SOF1 or SOF1 SOF2 characters will be stripped from the transmission Show Packet Forwarding Line Description Shows the packet forwarding settings for the line User Level Admin Syntax show packet forwarding line lt number gt 59 Packet Forwarding Commands 60 IOLAN DS1 TS2 CLI Reference Guide Version 4 1 Network Commands This chapter defines all the CLI commands associated with configuring the IOLAN
101. use the output to pulse go active and inactive at a configured rate e Inactive to Active Delay The channel output will remain inactive for the specified time interval after it is manually started e Active to Inactive Delay The channel output will go inactive after the specified time interval after it is manually started The default is Manual pulse When the Output is Pulse you can have it pulse in a Continuous manner or specify a pulse Count each count consists of an active inactive sequence The default is Continuous 83 Set IOChannel 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 Valid values are 1 9999 x 100 ms The default is 100 ms active signal width How long the channel output will be active during the pulse mode Valid values are 1 9999 x 100 ms The default is 100 ms inactive signal width How long the channel output will remain inactive during pulse mode Valid values are 1 9999 x 100 ms The default is 100 ms failsafe action When there has been no I O activity within the specified time set in the Global Settings and the Failsafe Timer is triggered you can set the Failsafe Action to e None The state of the Digit
102. wing exceptions the TCP KeepAlive causes the connection to be dropped or the Modbus device drops the connection The default is 10 seconds mess timeout Time to wait in milliseconds for a response message from a Modbus TCP or serial slave depending if the Modbus Gateway is a Master Gateway or Slave Gateway respectively before sending a Modbus exception The default is 1000 ms port The network port number that the Slave Gateway will listen on for both TCP and UDP messages The default is 502 req queuing When enabled allows multiple simultaneous messages to be queued and processed in order of reception The default is On remapped id Specify the UID that will be inserted into the message header for the Slave Modbus serial device Valid values are 1 247 21 TruePort Baud Commands Show Modbus Description Displays the Modbus Gateway parameters User Level Admin Syntax show modbus gateway show modbus slave master lt line number gt TruePort Baud Commands Set TruePort Remap Baud Description User Level Syntax Options Show TruePort Description User Level Syntax 22 This command allows for the remapping of the baud rate being specified by the Serial application to a different value on the physical serial port on the IOLAN Admin set trueport remap baud 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 1
103. y default config Specifies the configuration file that you are going to load from a TFTP server to the IOLAN that will act as the factory default configuration See the User Guide for directions on how to revert back to the original factory default configuration if required hostname ip address The IP address or host name where the file you are downloading to the IOLAN resides If you are using a host name it must be resolved in either the IOLAN s Host Table or a DNS server filename The complete path and file name cannot use a drive letter of the file you are downloading to the IOLAN IOLAN DS1 TS2 CLI Reference Guide Version 4 1 MOTD Commands Set Description User Level Syntax Sets the current configuration on IOLAN to act as the factory default configuration See the User Guide for directions on how to revert back to the original factory default configuration if required Admin set config to factory default MOTD Commands Set MOTD Description User Level Syntax Options Show MOTD Description User Level Syntax 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 netload customapp file command to do this do not specify the host parameter Normal Admin set motd display on off host hostname file path f

Perle Systems 5500208-41 User's Manual

Contents

Download Pdf Manuals

Related Search

Related Contents