Home

Perle Systems DS1 User's Manual

1. 76 Set IOChannel Digital Output 77 Set IOChannel Digital Output Serial Pins 79 Set IOChannel GE EE EE nnana 79 Set lOChannel Analog True Analog 80 Set lOChannel Analog Temperature 82 Set lOChaninel IOExtension 1 1 84 Set IOChannel Multihost u 86 Show IOChannel Status RR RR RR RR RARR RR RR EE RR RR RR RR Re 86 Kil sie Dl ER N EE RE EE 86 oie de EE N AE EE AE 87 Show Eege 87 VO Channel Control Commands 88 Digital Outpul issie EE EER EER RE EE RE ER ee ee SR eed ee ee EE 88 Digital eo EE EE NE RE RE OT HEN 88 EE EN EE EE N EN N 88 Analog UE 88 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
2. Configures a host in the IOLAN host table Admin set host config host lt ip_ address gt lt config_host gt The name of the host lt ip_address gt The host IPv4 or IPv6 address 60 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 Adds a gateway You can configure up to twenty gateways Admin add gateway lt config host gt default add gateway lt config host host lt dest IP addr gt add gateway lt config host gt network lt dest_IPv4_addr gt lt dest_IPv6_addr gt lt subnet_ bits 0 32 gt lt 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 yo
3. Description User Level Syntax Option Description User Level Syntax Option Description User Level Syntax Options lt config_host gt lt ip_address gt Defines the hosts by IPv4 or IPv6 address that will receive trap messages generated by the IOLAN Up to four trap hosts can be defined lt version gt Select the version of trap you want the IOLAN to send Valid options are v1 v2c or v3 lt type gt Select between trap or inform Inform requires the receiving host to acknowledge receipt of the trap Deletes an SNMP community version 1 and version 2 Admin delete community config community number sconfig 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 Deletes an SNMP trap host Admin delete trap config trap number sconfie tap 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 Configures SNMP settings Admin set snmp contact lt string gt location lt string gt readonly user lt username gt readwrite user lt username gt trap user lt username gt contact The
4. Range 0 65535 ms Default 10 ms 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 Dumb WYSE60 VT100 ANSI TVI925 IBM3151TE VT320 specifically supporting VT320 7 HP700 specifically supporting HP700 44 Term 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 40 Line Commands Set Line Interface Description User Level Syntax Options discard characters in error When enabled the IOLAN will discard characters received with a parity or framing error Default Disabled Configures line interface hardware parameters Admin set line lt number gt interface eia 232 monitor dcd on off monitor dsr on off flow none soft hard both speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 57600 115200 230400 28800 custom lt baud_rate gt set line interface eia 422 flow none sof
5. 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 mtu The Maximum Transmission Unit MTU size of an IP frame that will be sent over the network Only one MTU size can be set for both IPV4 and IPV6 frames MTU sizes 68 1500 bytes Default size 1500 bytes 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 T Default Interval 180 seconds monitor connection timeout Sets the maximum time to wait for a response after sending a T
6. 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 47 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 issue a dial command with a phone number The phone number will be searched in this ta
7. 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 5 14 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 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
8. 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 into 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 workstations on a LAN WAN or internet A communication control character sent by the receiving destination indicating that the last message was not received cor
9. 19 200 38 400 57 600 115 200 230 400 28 800 custom flowin on off flowout on off hotkey prefix lt 00 7f gt data logging on off initiate connection any char specific char lt hex value gt initial cli menu keepalive on off lock on off mode enabled disabled motd on off reset on off dial timeout lt number gt dial retries lt number gt single character on off user lt name gt nouser internet address lt IPv4 address gt user lt config user IOLAN DS1 TS2 CLI Reference Guide Version 4 5 36 Line Commands Elevated User Options set line lt number gt speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19 200 3 8 400 57 600 115 200 230 400 28 800 custom Note The save command must be executed by an admin user in order for this parameter to be permanently saved break Specifies how a break is interpreted e oft he 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 i
10. Displays TCP port statistics udp Displays UDP port statistics tepv6 Displays TCPv6 port statistics udpv6 Displays UDPv6 port statistics Show Modbus Statistics 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 5 71 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 72 VO Commands This chapter defines all the CLI co
11. IOLAN IOLAN DS1 TS2 CLI Reference Guide Version 4 5 26 Commands for Users Logged Into the IOLAN User Level Syntax Menu Description User Level Syntax Ping Description User Level Syntax Options Resume Description User Level Syntax Options Screen Description User Level Syntax Set Termtype Description User Level Syntax Restricted Normal Admin logout Switches from a command line based interface to Menu mode of operation Restricted Normal Admin menu This command checks to see ifa 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 lt of packets gt Enter the number of the packets you want to send The default is 10 Resumes a started session Restricted Normal Admin resume 1 2 31 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 termi term2 term3 27 Commands for Users Logge
12. 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 lt hostname gt file lt path_filename gt set motd file lt 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 lt path_filename gt 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 lt local_file gt 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 70 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
13. 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 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 following 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
14. 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 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 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 76 Set OChannel t
15. 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 81 Set OChannel Set IOChannel Analog Temperature Description Sets the Analog input channel settings for Temperature models User Level Admin Syntax Options set iochannel lt analog channel type rtd thermocouple range range specifier gt set iochannel lt analog channel alarm level 1 2 3 4 5 mode on off trigger type disabled low high trigger level lt decimal_ values clear mode auto manual clear level lt decimal value gt 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 to 400C 10 Pt100 a 3
16. 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 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 Configures a users session settings See Set User Session for the options descriptions Admin 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 lt TCP_port gt 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 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 Admin show default user Shows user configuration settings Admin show user lt configured_user gt lt configured_user gt Show the settings for the specified user Show the settings for the current
17. 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 password The password the user will need to enter to login to the IOLAN This case sensitive field accepts a maximum of 16 characters 34 Configuring Users Set User Session Description User Level Syntax Show Default User Show User Description User Level Syntax Description User Level Syntax Options 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 of 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
18. 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 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 hex value 02 would be Ctrl b b etc e 4al 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 You can use the Hotkey Prefix key to lock a line only when the Line Lock parameter is On 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 data logging 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 des
19. 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 39 Line Commands 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 Non printable ascii characters must be entered in this format lt 027 gt The decimal numbers within the brackets must be 3 digits long example 003 not 3 e Send at End If configured this string will be sent to the serial device when the TCP session on the LAN is terminated The maximum size of this field is 128 bytes characters Non printable ascii character must be entered in this format lt 027 gt escape The decimal numbers within the brackets must be 3 digits long example 003 not 3 e Delay after Send Jr configured a delay time 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
20. name and contract information of the person who manages this SMNP node location The physical location of the SNMP node readonly user Specifies the name of the read only user readwrite user Specifies the name of the read write user trap user Specify the name of the trap user 58 SNMP Commands Set SNMP engine id string Description Configures SNMP v3 Engine ID User Level Syntax Options Admin set snmp engine id string lt string gt string The string entered in this field will be combined with the defined string in hex of 800007AE04 to form the engine id Ensure each string is unique for each IOLAN The default engine id uses the MAC address of the Ethernet interface to ensure that the engine id is unique to this agent To set the engine id back to the default enter a null string lt gt Set SNMP inform timeout Description Configures SNMP inform traps timeout value User Level Syntax Options Admin set snmp inform timeout lt number gt number This is the length of time in seconds that the IOLAN will wait for the acknowledgement of the trap If no ACK is received within this timeframe the trap will be re sent The default is 1 second Set SNMP inform retries Description User Level Syntax Options Show SNMP Description User Level Syntax Configures SNMP inform traps number of retires Admin set snmp inform retires lt number gt number This is the number of times the
21. of the Digital Relay output remains the same no change e Activate Output Activates the output e Deactivate Output Deactivates the output Set lOChannel Analog True Analog Description Sets the Analog input channel settings User Level Admin Syntax Options set iochannel lt analog channel gt type current voltage range range specifier gt set iochannel lt analog channel gt alarm level 1 2 3 4 5 mode on off trigger type disabled low high trigger level lt decimal_ values clear mode auto manual clear level lt decimal value gt 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 1V e 5 G 5V e 10 4 10V This is the default e 150 H 150mV e 500 H 500mMV 80 Set OChannel 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 subsequent level If the Trigger T
22. 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 DS set vmodem failure string host port style success string suppress DSS set vmodem failure string lt text gt 30 characters maximum DSS 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 15 Server Commands This chapter defines all the CLI commands associated with configuring the IOLAN s server parameters Server Commands Set Custom App Description You can create a custom application that can run on the IOLAN using the Perle SDK User Level Admin Syntax set custom app server program command line lt command gt Options program command line The name of the SDK program executable that has been already been downloaded to the IOLAN plus any parameters you want to pass to the program Maximum of 80 characters Use the she11 CLI command as described in the SDK Programmer Guide to manage the files that you have down
23. protocol the IOLAN uses 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 Guide This typeface indicates a book or document title See About This Book 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 5 11 Contacting Technical Support Contacting Technical Support Making a Technical Support Query Who To Contact Note Perle offers free technical support to Perle Authorised Distr
24. s system time using military time format Show Time Description Shows the IOLAN 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 lt hh mm ss gt Sets the IOLAN s system time using military time format IOLAN DS1 TS2 CLI Reference Guide Version 4 5 64 Time Date Setting Commands Show Date Show Time Description Shows the date according to the IOLAN system clock User Level Normal Admin Syntax show date Description Shows the IOLAN s system clock User Level Normal Admin Syntax show time 65 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 configuration to F
25. 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 d1 d2 d3 d4 rts dtr output activate deactivate output Manually deactivates the I O channel Manages the Relay output channel status Admin iochannel rl r2 output activate deactivate output Manually 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 88 Glossary This chapter provides definitions for IOLAN terms BOOTP BOOTstrap Protocol Community SNMP DHCP Dynamic Host Configuration Protocol Direct Connection Ethernet Local Authentication Modem Initialization String MOTD Multicast NAK Negative Acknowledgment Reverse Connection
26. 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 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 78 Set OChannel Set IOChannel Digital Output Serial Pins Description Sets the Digital output for serial pins RTS and DTR This option is only availa
27. 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 55 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 EOF1 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 Triggerl or Trigger1 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 between characters before the packet is transmitted to the network A value of zero 0 ignores t
28. user 35 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 DS 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 Normal Admin Elevated User Syntax set line lt number gt speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19 200 3 8 400 57 600 115 200 230 400 28 800 custom 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 gt rev sess security on off send name on off session strings delay lt 0 65535 gt initiate lt text gt 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 discard characters with error on off Admin set line speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600
29. 92 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 E0 to 1000C j J 0 to 760C This is the default k K 0 to 13700 r OR 500 to 17500 s S 500 to 1750C t T 100 to 400C alarm Configures alarm settings when the Analog input trigger is activated 82 Set OChannel 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 level trigger values must increase in value with each subsequent l
30. 925 ibm3151te vt320 hp700 term1 term2 term3 Ee EE buat 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 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 s 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 45 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 line lt number gt termtype lt terminal name
31. CP keepalive message Values 1 32767 seconds Default 5 seconds monitor connection number The number of TCP keepalive retries before the connection is closed Values 1 32767 Default 5 hame You must supply a name for the IOLAN Server Commands 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 password limit The number of attempts a user is allowed to enter a password for a serial port connection from the network before the connection is terminated and the user has to attempt to login again For users logging into the serial port if this limit is exceeded the serial port is disabled for 5 minutes 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 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 t
32. E h UU N ETE EE 61 Deleis AE 61 Set UC N EE RE EE EE EE 62 Show AE ME OE N EE nne 62 LOGGING Commands uuu uu EKEN ENE es Ke Ee NAG SKAG EE dee ke Ee 63 Set Syslog AE EE PP eee ie eee eee ere 63 SNOW SV SOG E 63 Chapter 6 Time Commands 64 Time Command CG 64 Set TIMES uuu N ee ED DE ee DR DE De Ge ee 64 SHOW MEE EE ON EE EE EE OE EE 64 Time Date Setting Commands 64 Set Date EE EE u 64 at EE 64 Show Aa ER EE Eed ER EE 65 Show TE 65 Chapter 7 Administration Commands 66 Boot up CI TN 66 load o AE EE ee N EE A RR EE IE N 66 PR ss ee EE Sua Se ee De ee a da 66 Reset Factory EE EE 66 oe OE EE EO OO OE OE EE EEN 66 Set EREM 67 ShoW ARP u u k u Ne ee En e eg 67 de TO 67 Show FG OUI BE 67 TFTP File Transfer Commands 68 Netload EIE EE EE EE 68 Netsave GE nnna 69 Custom Factory Defaullt 69 NE or De EN EE EE IE EE EE N 69 of EE ED EE EE N EL NE N EE OE OE OE ice 70 MOTD CommandsS EER GEE SEE ER Gee EG SE Ee 70 Set MOTD AE EE DO N N NE N KO EO N 70 Show EK 70 Chapter 8 Statistic Commands 71 Tute UE NEE E EE d 71 SHOW Netstat
33. IOLAN DS1 TS2 Command Line Interface Reference Guide Version 4 5 Part 5500208 45 July 2013 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 OE1 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 Perle Systems Limited 2004 2013 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 environment this product may cause radio interference in which case the user may be required to take adequate measures Caution The IOLAN Device Server is
34. IOLAN will resend a trap which has not been acknowledged by the receiving end Once the retries count is exhausted no further attempts will be made to deliver the trap The default is 3 retries Shows SNMP settings including communities and traps Admin show snmp 59 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 Admin add host lt hostname gt ip address 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 lt config host lt config_host gt You can see a list of hosts that can be deleted by typing delete host
35. LAN Admin set trueport remap baud 501 75 1101134 150 12001300 600 1200180012400 14800 9600119200 38400 50175 1101134 150 12001300 600 1200180012400 14800 9600 19200 38400 57600 115200 1230400128800 custom lt baud_ rate 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 User Level Normal Admin Syntax show trueport 22 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 de
36. LAN with the DeviceManager 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 Hardware Commande User Level Admin Normal Syntax show server Hardware Commands Set Ethernet Description Sets the hardware configuration for the Ethernet port s User Level Admin Syntax set ethernet speed and duplex auto 10 half 10 full 100 half 100 full Options 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 Show Hardware Description Shows the hardware resources Ethernet link status date and time User Level Normal Admin Syntax show hardware 20 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 set modbus gateway broadcast on off set modbus gateway char timeout lt number gt set modbus gateway next req delay lt number gt set modbus gateway exce
37. LASH User Level Admin Syntax save IOLAN DS1 TS2 CLI Reference Guide Version 4 5 66 Bootup Commands Set Bootup Description User Level Syntax Options Show ARP Description User Level Syntax Set cli Description User Level Syntax Show Bootup Description User Level Syntax 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 Allows normal users to execute certain admin commands Admin set cli elevate privileges on off Shows the Firmware and Configuration files specified for IOLAN bootup Admin show bootup 67 TFTP File Tra
38. 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 52 Modem Commands Modem Commands Add Modem Description Adds a modem User Level Admin Syntax add modem modem name gt lt initialization_string gt Options lt modem_name gt The name of the modem Do not use spaces lt initialization_string gt The initialisation string of the modem see your modem s documentation Delete Modem Description Deletes a modem User Level Admin Syntax delete modem config modem name Option lt config_modem_name gt You can see a the list of modems that can be deleted by typing delete modem Show Modems Description Shows the IOLAN modem table User Level Normal Admin Syntax show modems 53 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 be configured if you configure both the packet
39. approved for commercial use only C Table of Contents PrETACE ER gege Ee RE 11 About This BOOM sesse SESSE WE ceed Ge ES EG EL ee EE 11 Intended A udi amp c6 ss es ESE EE ESE Ee NE EE EED EE EE 11 Typeface Conventions iss EE NKR GUNS NN EG UR iaaa 11 Contacting Technical Support 12 Making a Technical Support Ouer iese ee RR RE ER RR Ee 12 Who TO E in E EE 12 Have Your Product Information Ready 12 Making a support query via the Perle web page 12 Repair Eelere 13 Feedback on this Manual U u uu 13 Chapter 1 Introduction 14 Oe H EE 14 CLI Conventi rSu E 14 Command EE EE 14 Command Shortcuts ees RR RR RR RR RR AREA AREA REGEER u 15 Command Options u 15 Chapter 2 Server Commands 16 Ru ue TE 16 Set Custom App OE N OE 16 Ee 16 Set TUG eene 19 Show Custom App 1 U uu 19 Show ele e UE 19 IOLAN DS1 TS2 CLI Reference Guide Version 4 5 SNOW SGIver EE 19 Hardware Commands 20 Set Ethernet EE 20 Show Hardware issie Se N NEER NS SE Ee De ae aaa EG Re EE EE 20 Mod
40. ble 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 lt config host gt init string lt string gt mode auto manual port lt TCP port gt 0 respons delay lt time_ms gt 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 vymodem 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 ATDS1 See VModem Initialisation Commands in the IOLAN User 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 Set Vmodem Phone in the JOLAN User s Guide for the command parameters to se
41. ble when User 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 lOChannel 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 relay number 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 configu
42. bus Commands si ER RE ES ee ne Gee ERG EE ee 21 Set Modbus Gateway I ES WE ER Ee Dee EE 21 le e TE 22 TruePort Baud Commanids u uuu GENEES ESE GEGEE ER ED 22 Set TruePort Remap Baud 22 Show DS EE 22 IP VO COMMANDOS ER GE DEd N EG GR GE EE EG SG N Ee 23 OTS ed EE EE EE EE EE OE 23 Show WP EE EE EE EE OO EE EE NEE 23 Ada amp ustomdP VD esse RE ees does LEED EA ee usa wawan DERS 24 ode eie di AE OE EE 24 Delete Customtql PVG EE Ge ER ee En are 25 Chapter 3 User Commands 26 Commands for Users Logged Into the IOLAN 26 Adri EA EE RE EN EE OE ER 26 SE RE ER OE N ga sa 26 HERE EE ORS EO EN ON N EE 26 Kill Line 1 u N EO EE ORE HO N OE EE N 26 Kill SESSION ie RES ie RD EE N Ee ER ee EDE Ee Ge ee ee Ee EE 26 Logout EE EE N AE N EE EE OE 26 M n uuu u AE EE EE N 27 PINO u EE EE AL OE EE ER EE DEE 27 ReSUWI AO EE ER AE OE EE 27 er EE EE N E RE RO N 27 Set Term pe ed es Ee Eege 27 AA AE EE EE EE eer err ena 28 Set User Session GEE Ee EG Ee DE ER ER ER Me EE ig 28 Show Line Users 29 E ee E 29 Show Sessions SEE N EE EE OE EE EI 29 Show Termtype ese ee ER DE EG GE De EE Ve ORE EG we Oe GE 29 Stlarluuuu AE N EE EE EE AE decade 29 ECH EN A0 Version EE 31 Conf
43. d Into the IOLAN Option Set User Description User Level Syntax Options Set User Session wyse60 vt100 ansi dumb tvi925 ibm315 1te vt320 hp700 term 1 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 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 Aa 0 will return you to the IOLAN Menu e Aan Display the next session The current session will remain active The lowest numbered active session will be displayed e Aa p Display the previous session The current session will remain active The highest numbered active session will be displayed e Aam 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 4al Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password excluding spaces and l
44. dication 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 lt ip address lt number gt host lt string gt port TCP port set vmodem phone entry lt number gt 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 49 Line Service Commands lt ip_address gt Specify the IP address of the remote host that is receiving the vmodem connection lt host gt Select the hostname from the host table of the remote host that is receiving the vmodem connection lt port gt Specify the TCP port that the remote host is listening on for the vmodem connect
45. ding 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 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 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
46. ecify 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 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 lt config ipv address gt method auto network prefix lt network prefix gt prefix bits lt 0 64 gt set custom ipv6 lt config ipv address gt method manual ipv6 address lt 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 24 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 Sp
47. ecify the network prefix bits for the IPv6 address Range 0 128 Default 64 Delete Custom IPv6 Description Deletes the specified custom IPv6 address To see a list of configured IPv6 addresses type the command delete custom ipv User Level Admin Syntax delete custom ipv6 lt config ipv address gt 25 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 Help Line Kill Line Kill Session Logout Description Changes a Normal level user to the Admin user When you press Enter after you type User Level Syntax this command you will be prompted for the Admin password Normal admin Description Displays help on using the command line interface CLI User Level Syntax Restricted Normal Admin help Description Displays a menu of configured serial ports User Level Syntax Admin line Description Restarts a line On IOLANs with more than 1 port you can specify a port number and User Level Syntax then a range of ports for example kill line 4 10 13 15 On single port models use the command kill line Normal Admin kill line lt number gt lt number range gt Description Kills an active session User Level Syntax Options Restricted Normal Admin kill session 1 2 3 4 1 2 3 4 The number of the session s you want to kill Description Logs the user out from the
48. er2 hex character enable end eofl Enable or disable the eof1 end of frame hex character enable end eof2 Enable or disable the eof2 end of frame hex character enable end sof1 Enable or disable the sof1 start of frame hex character enable end sof2 Enable or disable the sof2 start of frame hex character end triggerl 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 Triggerl 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 character the IOLAN waits for another EOF1 character
49. ersion 1 and version 2 User Level Admin Syntax add community lt community name gt lt config host gt lt ip_ address gt 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 lt config_host gt lt ip_address gt 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 lt community gt lt config host gt lt ip address gt lt version gt lt type gt Options lt community gt This is the community name associated with this trap The host who will receive the traps must belong to the same SNMP community IOLAN DS1 TS2 CLI Reference Guide Version 4 5 57 SNMP Commands Delete Community Delete Trap Set SNMP
50. evel 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 83 Set OChannel Set OChannel IOExtension Description Configures the I O extension options that allow you to connect the Digital Input User Level Syntax Options 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 signal io on the same IOLAN remote IOLAN s and or TCP IP applications run
51. evice client tunnel Sets the line 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 43 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 EJA 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 after the T
52. fault enable ipv6 addressing When enabled you can configure the IOLAN to obtain the IPv6 address es using IPv6 Autoconfiguration or a DHCPvV6 server Default 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 IPv 6 Description User Level Syntax Options Set Custom IPv6 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 lt network prefix gt prefix bits lt 0 64 gt add custom ipv6 method manual ipv6 address lt 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 Sp
53. ff If both Monitor DCD and Monitor DSR are enabled both 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 41 Line Commands Set Line Service Description User Level Syntax Options 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 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 to find the Line Service that you want to configure Admin set line lt number gt service bidir config host l
54. from the IOLAN to the device The on of option is only for 1 port models You can disable line access in 2 port models by specifying 0 zero phone 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 Sets users settings Normal level users can configure only their own settings 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 hotke
55. gt line mode on off map cr crlf on off local echo on off echo lt 00 7 gt eof lt 00 7f gt erase lt 00 7f gt 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 This value is in hexadecimal wit
56. h 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 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 46 Line Service Commands Set UDP Description Configures the UDP settings for the serial line User Level Normal Admin Syntax Options set udp line lt number gt entry 1 2 314 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 lt start IP address gt lt end_IP_address gt set udp line lt number gt entry 121314 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 in out none The direction in which information is received or relayed e None UDP service not enabled e In
57. he 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 All data 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 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 data logging buffer size The minimum data buffer size for all models is 1 KB The maximum data buffer size is 2000 KB for TS1 all other models the maximum size is 4000 KB Ifthe data buffer is filled incoming serial da
58. his 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 56 Network Commande This chapter defines all the CLI commands associated with configuring the IOLAN s network parameters SNMP Commands The IOLAN supports SNMP traps for restart and SNMP community authentication error Add Community Description Adds an SNMP community v
59. ial 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 tcp port The TCP Port that the channel serial signal pin will use to communicate to another IOLAN or a TCP IP application Default 2000 for channel 1 then increments by one for each channel server initiated multihost all backup lt config_backup_host gt lt tcp_port gt 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 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 85 Set OChannel Set OChannel Multihost Description User Level Syntax Options Configures up to 49 hosts IOLANs that the Digital input channel or
60. ibutors and 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 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 using the following address Email ptac perle com
61. id values are 0 128 Shows configured gateways Normal Admin show gateways 62 Logging Commands Logging Commands Set Syslog Description User Level Syntax Options Show Syslog 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 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 63 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 lt hh mm ss gt Sets the IOLAN
62. iguring Users u 31 Add USEF ee 31 Delete Ee 31 dE 31 SE N EE EE EE EE EE EE OE NE 33 Set User Session EE 35 Show Default VET EE 35 SHOW USET EE NE EE EE EE EE 35 Chapter 4 Line Commands 36 1 Port vs 2 Port Line Commands 36 Bee ii ee EE OE EE EE sa 36 AA AT EE EE OE N ELE 36 Set Line Interface uu 41 Set Line EEN 42 Set Mod m E 44 Set Termtyp6 u u uu EE acces ec cca eana Eaa aiana aneda EES RE ARE EO 45 ShoW TE 45 Line Service Commands 45 od ie E AA OE AE OE N 45 Set TelnetsClHent uuu RE EN OR EE AE N 46 dd RE ER EE EE AE 47 Set 2 1 EE 48 Set Vmodem Phones 49 Set Modbus Slave Line U u 50 Set Modbus Master Line 50 Set Multihost Line 51 Set Line Initiate Connection 51 Show Custom App U R EE RR RR RR RR Re ee 52 Show STC ER EE EE N 52 Show E e 52 Show Telnet Clie
63. ine 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 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 tThe 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 32 Configuring Users Set User Description User Level Syntax Admin Options 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
64. inish 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 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 gt lt 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 lt tcp port gt 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 31 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 a hex value 02 would be Ctrl b b etc e Aanumber 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 y
65. 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 IOLANSs enter the show iochannel lt channel gt command Admin set iochannel lt channel gt multihost entry lt number gt delete set iochannel lt channel gt multihost entry lt number gt host lt host_name gt lt tcp_port gt lt channel gt Specify the Digital input channel or input serial signal pin that will be connecting to all the hosts IOLANs 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 lt tcp_port gt 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 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 lt i o_ channel kill iochannel line lt number gt rts cts dtr dsr dcd Lo channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al ad rts cts dtr dsr ded Specify the Digital output
66. ion delete Deletes the specified 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 gt crlf 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 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 rtul ascii entry lt number gt 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 ert 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 50 Line Ser
67. l 71 Show Modbus Statistics 71 Show Netstat Statistics 72 Show RoutesS iis EER EE SS u SE EEN SEENEN 72 Run Time Statistics 72 KI AO AE EE re fy a saya sus tree reer asas 72 SIIOW ii Eege 72 SHOW Serial 72 te u N N E EK EE 72 Chapter 9 UO Commands 73 Global VO Commands 73 sel lO UDP u cars ve ER eect ed Ee anne denied ee Ee Ee 73 KIT OE N 74 Set ICH MODUS sisi u u u uuu u enee EE OE OE EE N EE E 74 Set IO Temperature Scale 74 Sak TEE 74 Set Line Service 74 Set lOChannel EEN 75 Set IOChannel Mode 75 Set IOChannel Digital VO ee EE EE Ee u uu 75 Set IOChannel Digital Input 75 Set IOChannel Digital Input Serial Pins
68. live 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 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 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
69. loaded 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 Set Server Description Sets server parameters User Level Admin Syntax 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 internet mtu lt integer gt monitor connection every lt seconds gt monitor connection timeout lt seconds gt monitor connection number lt integer 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 data logging buffer size lt integer gt pre v4 3g data logging on off udp always arp on off set server tftp retry lt integer gt timeout lt integer gt Options 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 5 16 Server Commands 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
70. loading from the IOLAN Custom Factory Default Netload Description Transfers a file from a remote host to the IOLAN using the TFTP protocol User Level Admin Syntax Options netload factory default config lt hostname IP_ address gt lt filename gt 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 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 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 of the file you are downloading to the IOLAN 69 MOTD Commande 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
71. mber 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 84 Set OChannel 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 is configured as digital output you must select a local digital input channel or input ser
72. mised 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 54 Packet Forwarding Commands 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 enable end trigger2 Enable or disable the end trigg
73. mmands associated with configuring the IOLAN s I O parameters Global VO Commands Set IO UDP Description Sets the UDP settings for I O unicast messages User Level Admin Syntax set io udp mode on off broadcast interval lt broadcast_interval gt set io udp entry 1 2 3 4 disabled set io udp entry 1 2 3 4 lt udp_port gt lt start_ip gt lt end_ip gt Options 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 5 73 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 gl
74. ne sends the character to the remote host This value is in hexadecimal with a default value of 4 ASCII value AD erase Defines the erase character 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 30 Configuring Users Version Description User Level Syntax 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 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 Description User Level Syntax Option Delete User Description User Level Syntax Option Set Default User 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 f
75. ning on local hosts Admin set iochannel lt channel gt ioextension enabled on off keepalive on off set iochannel lt channel gt ioextension connection method client initiated tcp port lt tcp port gt multihost on off set iochannel lt channel gt ioextension connection method server initiated host name gt tcp port lt tcp port gt multihost all backup config backup host lt host_port gt none set iochannel lt channel gt ioextension connection method local connection lt input_channel gt lt channel gt 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 dd 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 TCP keepalive feature After the configured nu
76. nsfer Commands TFTP File Transfer Commands Netload Description Transfers a file from a remote host to the IOLAN using the TFTP protocol User Level Admin Syntax Options netload text config factory default config firmware configuration customlang term1 term2 term3 customapp file serialt buf lt hostname ip address gt lt filename gt 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 serialt buf Specifies that you are going to d
77. nt eee ene OS ESE ee DK RD ek GE ER 52 EE 52 Show WTOC UN EE 52 Show Vmodem Phones 52 Modem Commands 53 Add Modeni EE 53 Delete Model aca se att ee ese ee ee ads 53 le E TE 53 Packet Forwarding CommandsS sesse ee ee EER RR RR RR EE EE RR RR Rea 54 Set Packet Forwarding Line 1 uu 54 Show Packet Forwarding Line 56 Chapter 5 Network Commands 57 Sheet 57 Add COMMUNITY u u RE EE N 57 Add UE A E 57 Delete Community RR Deeg eg 58 Delete TESS N N N aaaea aa sasa 58 Set SNMP EE EE N EE EO EO EE NN 58 Set SNMP engine id string 1 1 59 Set SNMP inform timeout 59 Set SNMP inform retries 59 Show SNMP 59 TF TP COMMandS E 60 Set Server TF E 60 Hosts COmmandsa u u uuu u EED ERA uuu us EE EENDE GE ee EE 60 KEIER 60 Delete E 60 Set Te EE 60 SHOW se AE ees EE ENEE ENEE 61 Gateway e E TE 61 Add KCTS I KEAT
78. nterrupt 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 65535 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 37 Line Commands flowin Determines
79. obal setting that must be enabled to set the Failsafe Action on the channel for digital outputs and relays When this timer expires 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 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 IOE
80. ocks 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 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 Description Sets the current users session settings 28 Commands for Users Logged Into the IOLAN User Level Normal Admin Syntax Options Show Line Users Description User Level Syntax Syslog Console Description User Level Syntax Options Show Sessions Description User Level Syntax Show Termtype Description User Level Syntax Start Description User Level Syntax set user session 1 2 3 4 auto on off type off telnet set user session 1 2 3 4 telnet options host lt config host gt port lt TCP port gt termtype lt terminal name gt line mode on off map cr crlf on
81. ode on off map cr crlf on off local echo on off echo lt 00 7 gt eof lt 00 7f gt erase lt 00 7f gt intr lt 00 7f gt quit 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 li
82. off local echo on off echo lt 00 7 gt eof lt 00 7f gt 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 s Guide Shows the users who are on the line Admin show line lt number gt 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 29 Commands for Users Logged Into the IOLAN Telnet Options Description User Level Syntax Options 1234 The number of the session that you want to start Starts a telnet session to the specified host IP address Normal Admin telnet lt hostname IP_ address lt tcp_port gt termtype lt terminal name gt line m
83. 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 triggerl1 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 triggerlltriggerti triggert2 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 eof1 on off enable eof2 on off enable sof1 on off enable sof2 on off eof1 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 that the application performance is not compro
84. ou to the IOLAN Menu e 4an Display the next session The current session will remain active The lowest numbered active session will be displayed e Aa 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 4al 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 L
85. ownload the contents of a serial trace buffer to the IOLAN 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 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 of the file you are downloading to the IOLAN 68 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 configurationl crashlserialt buf text config lt hostname ip address 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 a serial trace buffer from the IOLAN to the specified host or IP address 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 up
86. pins RTS or DTR or Digital input pins CTS DSR or DCD 86 Set OChannel 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 V o_channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al ad 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 lt i o_channel gt show iochannel line lt number gt rts cts dtr dsr dcd V o_channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al ad rts cts dtr dsr ded Specify the Digital output pins RTS or DTR or Digital input pins CTS DSR or DCD 87 UO Channel Control Commands VO 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 Analog Input Description User Level Syntax Options Manages the Digital output channel
87. ptions on off set modbus gateway idle timer lt number gt set modbus gateway mess timeout lt number gt set modbus gateway port TCP UDP port set modbus gateway req queuing on off set modbus gateway remapped id lt 1 247 gt set modbus gateway ip aliasing on off 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 next req 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 ze
88. ration 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 79 Set OChannel 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 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
89. rectly 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 5 89
90. rigger 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 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 i
91. ro a connection will not be dropped with the following 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 21 TruePort Baud Commands Show Modbus Description User Level Syntax 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 ip aliasing When enabled allows for multiple requests to serial slaves from an Ethernet Master s to be processed simultaneously Default Off Displays the Modbus Gateway parameters Admin show modbus gateway show modbus slave master line number TruePort Baud Commands Set TruePort Remap Baud Description User Level Syntax Options Show TruePort Description 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 IO
92. ruePort 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 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 44 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 dumb tvi
93. t hard both 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 set line lt number gt interface eia 485 half duplex tx driver control auto rts flow none soft echo suppression on off speed 50 75 110 134 150 200 300 600 1200 1800 2400 4800 9600 19200 38400 576001 115200 230400128800 custom lt baud rate gt 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 EIA 422 or EIA 485 TS2 supports only EIA 232 monitor dcd Specifies whether the R 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 O
94. t number gt entry lt number gt 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 lt TCP_port gt 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 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 51 Line Service Commands Show Custom App Description User Level Syntax Show Interface specific char lt hex gt Initiates a connection to the specified host only when the specified character is received by the serial port Shows the custom application line settings Admin show custom app line lt number gt 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 telnet client
95. t server_port gt lt host_port gt set line lt number gt service direct raw config host lt host_port gt set line lt number gt service silent raw config host lt host_port gt multihost all backup lt config backup_host gt lt host_port gt 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 lt config host lt host_port gt signal active on off multihost all backup config backup host lt host_port gt none set line lt number gt service trueport client initiated on lt 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 42 Line Commands lt server_port gt The IOLAN port number lt host_port gt The port number the target host is listening on for incoming connections direct Direct connections b
96. t 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 48 Line Service Commands Set Vmodem Phone 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 for example CONNECT 9600 suppress If set to No connection success failure in
97. t will revert to the current status The default is disabled Set IOChannel Digital Output Description Sets the Digital output channel settings User Level Admin Syntax Options set iochannel lt digital channel type sink source sink and source active signal width lt width gt inactive signal width lt width gt failsafe action none activate output deactivate output set iochannel lt digital channel output pulse continuous counted lt pulse count gt active to inactive delay lt delay gt inactive to active delay lt delay gt digital_channel Specify the Digital channel number for example d2 77 Set OChannel 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 UO activity within the specified time set in the Global Settings and the Failsafe Timer is triggered you can set the Failsafe Action
98. ta will overwrite the oldest data Data logging is only valid for Trueport and TCP Sockets profiles Values 1 2000 KB TS1 Values 1 4000 KB all other models Default Buffer Size 4 KB TS1 Default Buffer Size 256 KB all other models Server Commands Set Service Description User Level Syntax Options Show Custom App Description User Level Syntax Show Modbus Description User Level Syntax Show Server Description pre 4 3g data logging Enable the data logging feature previous toV4 3 firmware Default Disabled udp always arp This controls whether the IOLAN will attempt an ARP each time there is data to be transmitted and the ARP table does not have a valid ARP entry for the destination When set to off anew ARP will only be attempted after a timeout period Any data to be sent before the timeout elapses will be silently discarded Default Off 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 port 161 sped SPC Trueport daemon process in the IOLAN on port 668 syslog Syslog client process in the IOLAN dmerd DeviceManager daemon process in the IOLAN If you disable this service you will not be able to connect to the IO
99. tination Note A kill line or a reboot of the IOLAN causes all buffered data to be lost The minimum data buffer size for all models is 1K The maximum data buffer size is 2000 KB for DS1 TS1 STS8D all other models the maximum size is 4000 KB If the data buffer is filled incoming serial data will overwrite the oldest data Some profile features are not compatible when using the Data Logging feature See Data Logging Appendix H in the IOLAN User s Guide for more information Data logging is only valid for Trueport and TCP Sockets profiles Values 1 2000 KB DS1 TS1 STS8D Values 1 4000 KB all other models Default Buffer Size 4 KB DS1 TS1 STS8D Default Buffer Size 256 KB all other models Default Disabled 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 CLI 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 38 Line Commands 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 keepa
100. u must specify the network s subnet mask Deletes a gateway Admin delete gateway lt config gateway host lt config_gateway_host gt You can view the configured gateways that can be deleted by typing delete gateway 61 Gateway Commands Set Gateway Description User Level Syntax Options Show Gateways Description User Level Syntax Configures the gateway Admin set gateway lt config gateway host default set gateway lt config gateway host host destination ip set gateway lt config gateway host network dest IPv4 addr gt lt dest_IPv6 address gt lt prefixbits mask 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 val
101. ut The default is Input The internal jumpers must match the software configuration 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 lt 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 75 Set OChannel 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
102. vice Commands Set Multihost Line Description User Level Syntax Options port The destination port of the remote Modbus TCP Slave that the IOLAN will connect to 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 for the command to enable multihost Admin set multihost line l
103. xtension on page 84 for more information Admin set line lt number gt service signal io signal io Sets the line 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 76 or Set OChannel Digital Output Serial Pins on page 79 for configuration options 74 Set OChannel Set OChannel 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 lt i o channel mode enabled disabled description lt string gt Lo channel Specify the channel number for example d2 or a4 Temperature models use Analog input so the channel numbers are al ad 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 lOChannel Digital VO Description Sets up the Digital I O channel to act as either an output or input channel User Level Admin Syntax Options set iochannel lt digital channel resource 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 inp
104. y prefix lt 00 7f 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 33 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 a hex value 02 would be Ctrl b b etc e Aanumber 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 4an Display the next session The current session will remain active The lowest numbered active session will be displayed e Aa 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 4al Lowercase L Locks the line until the user unlocks it The user is prompted for a password any password exclu
105. ypass 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 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 d
106. ype 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 snmp Sends an SNMP trap when

Perle Systems DS1 User's Manual

Contents

Download Pdf Manuals

Related Search

Related Contents