Perle Systems 5500208-41 User Manual

IOLAN DS1/TS2 Command Line Interface Reference GuideVersion 4.1Part #5500208-41October 2009

10 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 11PrefaceAbout This BookThis guide provides the information you need to configure the IOLAN using the C

Contacting Technical Support12 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Contacting Technical SupportMaking a Technical Support QueryWho To Conta

13Contacting Technical SupportRepair ProcedureBefore sending a IOLAN for repair, you must contact your Perle supplier. If, however, you bought your p

Contacting Technical Support14 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 15Introduction Chapter 11IntroductionThis chapter provides the command line interface (CLI) options ava

CLI Conventions16 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1z Options—Provides an explanation of each of the options for a command and the defaul

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 17Server Commands Chapter 22This chapter defines all the CLI commands associated with configuring the I

Server Commands18 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1bannerThis parameter concerns the banner information (product name/software version).

19Server CommandsSet Service prompt-with-nameDisplays the Server Name field value instead of default product name. When enabled, the Server Name is d

Copyright StatementThis document must not be reproduced in any way whatsoever, either printed or electronically, without the consent of:Perle Systems

Hardware Commands20 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show Custom-AppDescription Shows the custom application server settings.User Level

21Modbus CommandsModbus CommandsSet Modbus GatewayDescription Sets the Modbus parameters for the IOLAN when it is operating as a Modbus Gateway.User

TruePort Baud Commands22 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show ModbusDescription Displays the Modbus Gateway parameters.User Level Admin

23IPv6 CommandsIPv6 CommandsSet IPv6Description Configures the basic IPv6 settings.User Level AdminSyntaxOptions dhcpv6-settingsivp6-addressnetwork-p

IPv6 Commands24 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Add Custom-IPv6Description Adds a custom IPv6 address to the IOLAN. You can specify eit

25IPv6 CommandsDelete Custom-IPv6Description Deletes the specified custom IPv6 address. To see a list of configured IPv6 addresses, type the command

IPv6 Commands26 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 27User Commands Chapter 33This chapter defines all the CLI commands available to users who are logged i

Commands for Users Logged Into the IOLAN28 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1MenuDescription Switches from a command line based interface

29Commands for Users Logged Into the IOLANSet UserDescription Sets the current users settings.User Level Normal, AdminSyntaxOptions hotkey-prefixlang

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 3Preface ...11About This Bo

Commands for Users Logged Into the IOLAN30 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show Line UsersDescription Shows the users who are on the li

31Commands for Users Logged Into the IOLANTelnetDescription Starts a telnet session to the specified host/IP address.User Level Normal, AdminSyntaxte

Configuring Users32 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1VersionDescription Displays firmware version and build.User Level Normal, AdminSynt

33Configuring Usershotkey-prefixThe prefix that a user types to control the current session. The default value is hex 01, which corresponds to Ctrl-a

Configuring Users34 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1line-accessSpecifies the user access rights to each IOLAN device line. Options are:

35Configuring UsersSet User Description Sets users settings. Normal-level users can configure only their own settings. Admin-level users can configu

Configuring Users36 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1levelThe access that a user is allowed:z Admin—The admin level user has total acces

37Configuring UsersSet User SessionDescription Configures a users session settings. See Set User Session on page 29 for the options descriptions.User

Configuring Users38 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 39Line Commands Chapter 44This chapter defines all the CLI commands associated with configuring the IOL

4 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show Server ...

Line Commands40 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Options breakSpecifies how a break is interpreted:z off—The IOLAN ignores the break key

41Line Commandshotkey-prefixThe prefix that a user types to lock a line or redraw the Menu. The default value is hex 01, which corresponds to Ctrl-a

Line Commands42 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1lockWhen enabled, the user can lock his terminal with a password using the Hotkey Prefi

43Line Commandssess-timerEnter a time, in seconds, for which the Session Timer will run. Use this timer to forcibly close the session (connection). W

Line Commands44 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set Line InterfaceDescription Configures line interface (hardware) parameters.User Leve

45Line CommandsSet Line Service echo-suppressionThis parameter applies only to EIA-485 Half Duplex mode. All characters will be echoed to the user an

Line Commands46 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1<host_port>The port number the target host is listening on for incoming connectio

47Line CommandsSet ModemDescription Sets the modem initialization string for a modem defined in the modem table. If you wish to add a new modem, use

Line Service Commands48 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set TermtypeDescription Sets the terminal type for the current terminal session

49Line Service CommandsSet Telnet-ClientDescription Configures the Telnet parameters for the specified line. When the IOLAN initiates a Telnet conne

5Show Sessions ... 30Show Termtype...

Line Service Commands50 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set UDPDescription Configures the UDP settings for the serial line.User Level N

51Line Service CommandsSet VmodemDescription This command associates a phone number with an IP address and TCP port. This enables an existing modem a

Line Service Commands52 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set Vmodem-Phonesignals dtrYou can specify how the DTR signal pin acts during y

53Line Service CommandsSet Modbus-Slave LineDescription Sets the Modbus slave parameters for the line. User Level AdminSyntaxOptions crlfprotocoluid-

Line Service Commands54 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set Multihost LineDescription Configures multiple hosts or a primary/backup hos

55Line Service CommandsShow Custom-AppDescription Shows the custom application line settings.User Level AdminSyntaxShow InterfaceDescription Shows th

Modem Commands56 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Modem CommandsAdd ModemDescription Adds a modem.User Level AdminSyntaxOptions <mode

57Packet Forwarding CommandsPacket Forwarding CommandsSet Packet-Forwarding LineDescription The Packet Forwarding feature allows you to control how t

Packet Forwarding Commands58 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1custom-on-specific-eventsThis section allows you to set a variety of packe

59Packet Forwarding CommandsShow Packet-Forwarding LineDescription Shows the packet-forwarding settings for the line.User Level AdminSyntaxforce-tran

6 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show Interface ...

Packet Forwarding Commands60 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 61Network Commands Chapter 55This chapter defines all the CLI commands associated with configuring the

SNMP Commands62 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Delete CommunityDescription Deletes an SNMP community (version 1 and version 2).User Le

63TFTP CommandsTFTP CommandsSet Server TFTPDescription Configures the IOLANs TFTP client settings.User Level AdminSyntaxOptions retrytimeoutHosts Com

Gateway Commands64 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show HostsDescription Shows the IOLAN host table.User Level Normal, AdminSyntaxGatew

65Gateway CommandsSet GatewayDescription Configures the gateway.User Level AdminSyntaxOptions <config_gateway_host>You can view the configured

Logging Commands66 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Logging CommandsSet SyslogDescription Configures the system log.User Level AdminSynt

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 67Time Commands Chapter 66This chapter defines all the CLI commands associated with configuring the IOL

Time/Date Setting Commands68 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show DateDescription Shows the date, according to the IOLAN system clock.U

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 69Administration Commands Chapter 77This chapter defines all the CLI commands associated with configuri

7Set Gateway ... 65Show Gateways ...

Bootup Commands70 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set BootupDescription Specifies remote the TFTP host and pathname for files to be loa

71TFTP File Transfer CommandsTFTP File Transfer CommandsNetloadDescription Transfers a file from a remote host to the IOLAN using the TFTP protocol.U

Custom Factory Default72 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1NetsaveDescription Transfers a file from the IOLAN to a remote host using the

73MOTD CommandsSetDescription Sets the current configuration on IOLAN to act as the factory default configuration. See the User Guide for directions

MOTD Commands74 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 75Statistic Commands Chapter 88This chapter defines all the CLI commands associated with configuring th

Run-Time Statistics76 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Show Netstat StatisticsDescription Shows protocol (IP/ICMP/TCP/UDP) counters.User

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 77I/O Commands Chapter 99This chapter defines all the CLI commands associated with configuring the IOLA

Set Line78 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IO FailsafeDescription Sets the failsafe (watchdog) settings for I/O.User Level AdminSyn

79Set IOChannelSet IOChannelSet IOChannel ModeDescription Sets general I/O channel settings for the specified channel, these settings are available t

8 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set MOTD...

Set IOChannel80 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IOChannel Digital Input (Serial Pins)triggerWhen the trigger condition is met, trig

81Set IOChannelSet IOChannel Digital OutputtriggerWhen the trigger condition is met, triggers the specified alarm action. Triggers can be:z Disabled—

Set IOChannel82 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1typeSpecify the type of digital output:z Sink—Specifies that the channel will be ground

83Set IOChannelSet IOChannel Digital Output (Serial Pins)Description Sets the Digital output for serial pins RTS and DTR. This option is only availab

Set IOChannel84 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IOChannel Analog (True Analog)active-to-inactive-delayWhen the I/O is commanded to

85Set IOChannelalarmConfigures alarm settings when the Analog input trigger is activated.levelYou can specify up to five alarm trigger/clear severity

Set IOChannel86 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IOChannel Analog (Temperature)Description Sets the Analog input channel settings fo

87Set IOChannellevelYou can specify up to five alarm trigger/clear severity levels. If the Trigger Type is Low, an alarm is triggered when the input

Set IOChannel88 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IOChannel IOExtensionDescription Configures the I/O extension options that allow yo

89Set IOChannelconnection-methodThe connection-method is one of the following:z Client-Initiated—When specified, the channel/serial signal pin will w

9Set IOChannel IOExtension ... 88Set IOChannel Multihost...

Set IOChannel90 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1Set IOChannel MultihostDescription Configures up to 49 hosts/IOLANs that the Digital in

91Set IOChannelShow IODescription Shows global I/O information (for example, UDP, TruePort, Modbus). Temperature input is Analog.User Level AdminSynt

I/O Channel Control Commands92 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1I/O Channel Control CommandsThe I/O commands in this section are used to

IOLAN DS1/TS2 CLI Reference Guide, Version 4.1 93GlossaryThis chapter provides definitions for IOLAN terms.BOOTP (BOOTstrap Protocol)An Internet proto