Perle Systems DS1 Manuel d'utilisateur

IOLAN DS1/TS2 Command Line Interface Reference GuideVersion 4.5Part #5500208-45July 2013

IOLAN DS1/TS2 CLI Reference Guide, Version 4.5 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.5 14Introduction Chapter 11IntroductionThis chapter provides the command line interface (CLI) options ava

15CLI Conventionsz Options—Provides an explanation of each of the options for a command and the default value if there is one. Some commands do not h

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

17Server CommandsbannerThis parameter concerns the banner information (product name/software version). This banner information is presented to a user

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

19Server CommandsSet ServiceDescription Sets server service parameters.User Level AdminSyntaxOptions telnetdhttpdsnmpdspcdsyslogdmgrdmodbusd Show Cus

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

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

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

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

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

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

IOLAN DS1/TS2 CLI Reference Guide, Version 4.5 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 IOLANTelnetOptions 1|2|3|4The number of the session that you want to start.Description Starts a telnet session t

IOLAN DS1/TS2 CLI Reference Guide, Version 4.5 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 UsersSet User line-accessSpecifies the user access rights to each IOLAN device line. Options are:z Read/Write—Users are given read and

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

35Configuring UsersSet User SessionDescription Configures a users session settings. See Set User Session for the options descriptions.User Level Adm

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

37Line CommandsElevated Userset line .|<number>|* speed [50|75|110|134|150|200|300|600|1200|1800|2400|4800|9600|19,200|38,400|57,600|115,200|23

38Line CommandsflowinDetermines if input flow control is to be used. Default is On. This is active only when Line Flow Control is set to Soft, Hard,

39Line Commandsinternet-addressUsed with reverse sessions, users can access serial devices connected to the IOLAN by the specified Internet Address (

40Line Commandssend-nameWhen enabled, the port name will be sent to the host upon session initiation.Default: Disabledsession stringsControls the sen

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

41Line CommandsSet Line Interfacediscard-characters-in-errorWhen enabled, the IOLAN will discard characters received with a parity or framing error.D

42Line CommandsSet Line Service duplexSpecify whether the line is Full Duplex (communication both ways at the same time) or Half Duplex (communicatio

43Line Commands<server_port>The IOLAN port number.<host_port>The port number the target host is listening on for incoming connections.dir

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

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

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

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

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

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

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

5Syslog Console... 29Show Sessions ...

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

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

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

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

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

56Packet 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.5 57Network Commands Chapter 55This chapter defines all the CLI commands associated with configuring the

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

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

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

6Set Line Initiate-Connection... 51Show Custom-App ...

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

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

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

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

65Time/Date Setting CommandsShow DateDescription Shows the date, according to the IOLAN system clock.User Level Normal, AdminSyntaxShow TimeDescripti

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

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

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

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

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

7Show Hosts... 61Gateway Commands...

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

72Run-Time StatisticsShow Netstat StatisticsDescription Shows protocol (IP/ICMP/TCP/UDP) counters.User Level AdminSyntaxShow RoutesDescription Shows

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

74Set LineSet IO FailsafeDescription Sets the failsafe (watchdog) settings for I/O.User Level AdminSyntaxOptions modetimeoutSet IO ModbusDescription

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

76Set IOChannelSet IOChannel Digital Input (Serial Pins)triggerWhen the trigger condition is met, triggers the specified alarm action. Triggers can b

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

78Set IOChanneltypeSpecify the type of digital output:z Sink—Specifies that the channel will be grounded when active.z Source—Specifies that the chan

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

80Set IOChannelSet IOChannel Analog (True Analog)active-to-inactive-delayWhen the I/O is commanded to an inactive state, this is the length of the de

8Custom Factory Default ... 69Netload ...

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

82Set IOChannelSet IOChannel Analog (Temperature)Description Sets the Analog input channel settings for Temperature models.User Level AdminSyntaxset

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

84Set IOChannelSet IOChannel IOExtensionDescription Configures the I/O extension options that allow you to connect the Digital Input channel or input

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

86Set IOChannelSet IOChannel MultihostDescription Configures up to 49 hosts/IOLANs that the Digital input channel or input serial signal pins (DSR, D

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

88I/O Channel Control CommandsI/O Channel Control CommandsThe I/O commands in this section are used to manually manage the I/O channels.Digital Outpu

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

9Set IOChannel Digital Output (Serial Pins) ........... 79Set IOChannel Relay ...........