Perle-systems 5500208-43 Manual do Utilizador Página 1

IOLAN DS1/TS2 Command Line Interface Reference GuideVersion 4.3Part #5500208-43January 2012

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

12Contacting Technical SupportContacting Technical SupportMaking a Technical Support QueryWho To ContactNote:Perle offers free technical support to P

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

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

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

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

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

18Server CommandsnetmaskThe network subnet mask. For example, 255.255.0.0.oem-loginWhen set, and a custom language file is in use, the login prompt w

Server Commands19 IOLAN DS1/TS2 CLI Reference Guide, Version 4.3Set ServiceDescription Sets server service parameters.User Level AdminSyntaxOptions t

20Hardware CommandsHardware CommandsSet EthernetDescription Sets the hardware configuration for the Ethernet port(s).User Level AdminSyntaxOptions au

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

Modbus Commands21 IOLAN DS1/TS2 CLI Reference Guide, Version 4.3Modbus CommandsSet Modbus GatewayDescription Sets the Modbus parameters for the IOLAN

22TruePort Baud CommandsShow ModbusDescription Displays the Modbus Gateway parameters.User Level AdminSyntaxTruePort Baud CommandsSet TruePort Remap-

IPv6 Commands23 IOLAN DS1/TS2 CLI Reference Guide, Version 4.3IPv6 CommandsSet IPv6Description Configures the basic IPv6 settings.User Level AdminSyn

24IPv6 CommandsAdd Custom-IPv6Description Adds a custom IPv6 address to the IOLAN. You can specify either a complete IPv6 address or an IPv6 network

IPv6 Commands25 IOLAN DS1/TS2 CLI Reference Guide, Version 4.3Delete Custom-IPv6Description Deletes the specified custom IPv6 address. To see a list

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

27Commands for Users Logged Into the IOLANMenuDescription Switches from a command line based interface to Menu mode of operation.User Level Restricte

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

29Commands for Users Logged Into the IOLANShow Line UsersDescription Shows the users who are on the line.User Level AdminSyntaxSyslog ConsoleDescript

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

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

31Configuring UsersVersionDescription Displays firmware version and build.User Level Normal, AdminSyntaxConfiguring UsersAdd UserDescription Adds a u

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

33Configuring Usersline-accessSpecifies the user access rights to each IOLAN device line. Options are:z Read/Write—Users are given read and write acc

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

35Configuring UserslevelThe access that a user is allowed:z Admin—The admin level user has total access to the IOLAN. You can create more than one ad

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

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

38Line CommandsOptions breakSpecifies how a break is interpreted:z off—The IOLAN ignores the break key completely and it is not passed through to the

39Line 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

40Line CommandskeepaliveEnables a per-connection TCP keepalive feature. After the configured number of seconds, the connection will send a gratuitous

4Show Server ...19Hardware Commands...

41Line Commandssession stringsControls the sending of ASCII strings to serial devices at session start and session termination as follows;z Send at S

42Line CommandsSet Line InterfaceDescription Configures line interface (hardware) parameters.User Level AdminSyntaxset line .|<number>|* interf

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

44Line Commands<host_port>The port number the target host is listening on for incoming connections.directDirect connections bypass the IOLAN, e

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

46Line Service CommandsSet TermtypeDescription Sets the terminal type for the current terminal session. term1, term2, and term3 refer to the user-upl

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

48Line Service CommandsSet UDPDescription Configures the UDP settings for the serial line.User Level Normal, AdminSyntaxOptions entry 1|2|3|4Selects

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

50Line Service CommandsSet Vmodem-Phonesignals dtrYou can specify how the DTR signal pin acts during your modem application connection, as itself (DT

5Show Sessions ... 29Show Termtype...

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

52Line Service CommandsSet Multihost LineDescription Configures multiple hosts or a primary/backup host schema for Silent Raw, Reverse Raw, or Client

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

54Modem CommandsModem CommandsAdd ModemDescription Adds a modem.User Level AdminSyntaxOptions <modem_name><initialization_string>Delete M

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

56Packet Forwarding Commandscustom-on-specific-eventsThis section allows you to set a variety of packet definition options. The first criteria that i

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

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

59SNMP CommandsDelete CommunityDescription Deletes an SNMP community (version 1 and version 2).User Level AdminSyntaxOption <config_community_numb

60SNMP CommandsSet SNMP engine-id-stringDescription Configures SNMP v3 Engine ID.User Level AdminSyntaxOptions stringSet SNMP inform-timeoutDescripti

6Show Interface ...53Show Modbus...

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

62Gateway CommandsShow HostsDescription Shows the IOLAN host table.User Level Normal, AdminSyntaxGateway CommandsAdd GatewayDescription Adds a gatewa

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

64Logging CommandsLogging CommandsSet SyslogDescription Configures the system log.User Level AdminSyntaxOptions levelprimary-hostsecondary-hostShow S

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

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

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

68Bootup CommandsSet BootupDescription Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot.User Level AdminSyntax

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

70Custom Factory DefaultNetsaveDescription Transfers a file from the IOLAN to a remote host using the TFTP protocol.User Level AdminSyntaxOptions con

7Gateway Commands... 62Add Gateway...

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

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

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

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

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

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

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

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

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

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

8Set... 71MOTD Commands...

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

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

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

84Set 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 IOChannel85 IOLAN DS1/TS2 CLI Reference Guide, Version 4.3Set IOChannel IOExtensionDescription Configures the I/O extension options that allow yo

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

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

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

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

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

9Set IOChannel Analog (True Analog) .............. 81Set IOChannel Analog (Temperature).......