Gebruiksaanwijzing /service van het product 5500208-41 van de fabrikant Perle Systems
Ga naar pagina of 93
IOLAN DS1/TS2 Command Line Interface Reference Guide Version 4.1 Part #5500208-41 October 2009.
Copyright S tatement This document must not be repro duced in any way whatsoever , either printed or electronicall y , without the consent of: Perle Systems Limi ted, 60 Renfrew Drive Markham, ON Canada L3R 0E1 Perle reserves the right to make change s without further notice, to any products to improve reliability , function, or design.
IOLAN DS1/TS2 CLI Refere nce Guide, V ersion 4.1 3 Preface ........................ ....................................................... 11 About This Book .............. .................................... ...................... 11 Intended Audience .
4 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Server ............. ................................................. ................ .............. 20 Hardware Commands ........... .............................. ........................ 20 Set Ethernet .
5 Show Sessions ................... ............................ .............. ............... ........... 30 Show Termtype .......... ................ .................................................. ........... 30 Start ................ .........
6 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Interface ......... ................ ................................................. .............. 55 Show Modbus............. ................................................. ................
7 Set Gateway .......... ............................ ............................ ............... ........... 65 Show Gateways ........... ................................. ................ ............... ........... 65 Logging Commands ............
8 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Set MOTD ......... ................................................. ............................ ........... 73 Show MOTD ................ ................. ................................ ..........
9 Set IOChannel IOExtension ..... ............... ................................. .............. 88 Set IOChannel Multihost ......... ................................. ................ .............. 90 Show IOChannel Status ........ ...............
10 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 1 1 Preface About This Book This guide provides the information you need to configure the IOLAN using the Comm and Line Interface (CLI). Intended Audience This guide is for adm inistrators who w ill be configuring th e IOLAN.
Contacting T echnical Support 12 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Cont acting T echnical Support Making a T echnical Support Query Who T o Cont act Note: Perle offers free technical suppo rt to Perle Authori sed Distributors and Registered Perle Resellers.
13 Contacting T echnical Support Rep air 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 direct ly . Customers who are in Europe, Afri ca or Middle East can submit repair d etails via a websit e form.
Contacting T ech nical Support 14 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 15 Introduction Chapter 1 1 Introduction This chapter provides the command line interface (CLI) options availabl e for the IOLAN. The commands are grouped by function. CLI Conventions This section explains how to interp ret the CLI synt ax.
CLI Conventions 16 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 z Options —Provides an explanation of each of the op tions for a command and the default value if there is one.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 17 Server Commands Chapter 2 2 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s server parameters. Server Commands Set Custom-App Description Y ou can create a custom application that can run on the IOLAN using the Perle SDK.
Server Commands 18 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 banner This parameter concerns the b anner informa tion (product name/so ftware version). This banner information is presente d to a user with a login prompt. For security reasons, you can turn off the display of this information.
19 Server Commands Set Service promp t-with-name Displays the Server Name field value instead of defau lt product name. When enabled, the Server Name is displaye d in the IOLAN login prompt, CLI prompt, W ebManager login screen, and the heading of the Menu.
Hardware Commands 20 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Custom-App Description Shows the custom appli cation server settings. User Level Admin Syntax Show Modbus Description Shows the Modbus settings for the gateway . User Level Normal, Admin Syntax Show Server Description Shows the parameters set for the server .
21 Modbus Commands Modbus Commands Set Modbus Gateway Description Sets the Modbus parameters for the IOLA N wh en it is operating as a Modbus Gateway .
T ruePort Baud Commands 22 IOLAN DS1/TS2 CLI Reference Guide, V ersion 4.1 Show Modbus Description Displays the Modbus Gateway parameters. User Level Admin Syntax T ruePort Baud Commands Set T ruePort.
23 IPv6 Commands IPv6 Commands Set IPv6 Description Configures the basic IPv6 settings. User Level Admin Syntax Options dhcpv6-settings ivp6-addr ess network-prefix enable-ipv 6-addr essing obtain-using auto-ipv6|dh cpv6 z auto-ipv6 —When enabled, the IOLAN will send out a Router Solicitation message.
IPv6 Commands 24 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Add Custom-IPv6 Description Adds a custom IPv6 address to the IOLAN. Y ou can specify either a complete IPv6 address or an IPv6 network address.
25 IPv6 Commands Delete Custom-IPv6 Description Deletes the specified custom IPv6 address. T o see a list of configured IPv6 addresses, type the command delete custom-ipv6 ? . User Level Admin Syntax prefix-bits (auto) Specify the network prefix bits for the IPv6 address.
IPv6 Commands 26 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 27 User Commands Chapter 3 3 This chapter defines all the CLI commands avai lable to users who are logged into the IOLAN. Commands for Users Logged Into the IOLAN Admin Description Changes a Normal-level user to the Admin user .
Commands for Users Logged Into the IOLAN 28 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Menu Description Switches from a command line based interface to Menu mode of operation. User Level Restricted, Normal, Admin Syntax Ping Description This command checks to see if a given host is reachable via an IP me ssage.
29 Commands for Users Logged Into the IOLAN Set User Description Sets the current users settings. User Level Normal, Admin Syntax Options hotkey-p refix language password Set User Session Description Sets the current users session settings.
Commands for Users Logged Into the IOLAN 30 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Line Users Description Shows the users who are on the line. User Level Admin Syntax Syslog Console Description Starts/stops or displays the status of the syslog console.
31 Commands for Users Logged Into the IOLAN Te l n e t Description Starts a telnet session to the specified host/IP address. User Level Normal, Admin Syntax telnet < hostname/IP_address > [< .
Configuring Users 32 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Ve r s i o n Description Displays firmware version and build . User Level Normal, Admin Syntax Configuring Users Add User Description Adds a user . For units with 4 or less serial ports, you can configure up to 4 users.
33 Configu ring Users hotkey-pre fix 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. ): z ^a number —T o switch from one session to another , press ^a and then th e required session number .
Configuring Users 34 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 line-access Specifies the user access rights to each IOLAN device line. Options are: z Read/Write —Users are given read an d write access to the line. z Read In —Users are given access to read only outbound dat a, data that is going from the IOLAN to the device.
35 Configu ring Users Set User Description Sets users settings. Normal-level users can configure only t heir own settings. Admin-level users can configure any users settin gs, including their own (with the exception of their User Level, which must st ay at Admin).
Configuring Users 36 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 level The access that a user is allowed: z Admin —The admin level user has total access to the IOLAN. Y ou can create more than one admin user account but we recomm end that you only have one.
37 Configu ring Users Set User Session Description Configures a users session settings. See Set User Ses sion on page 29 for the options descriptions. User Level Admin Syntax Show Default User Description Shows the Default Users settings.
Configuring Users 38 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 39 Line Commands Chapter 4 4 This chapter defines all the CLI commands associat ed with configuring the IOLAN ’ s line parameters.
Line Commands 40 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Options br eak Specifies how a break is interpreted: z off —The IOLAN ignores the break key completely and it is not passed through to the host. This is the default setting. z local —The IOLAN deals with the break locally .
41 Line Commands hotkey-pre fix The prefix that a user types to lock a line or redraw the Menu. The default value is h ex 01 , which corresponds to Ctrl-a ( ^a ) (hex value 02 would be Ctrl-b (^b), etc.): z ^a l —(Lowercase L) Locks the line until the us er unlocks it.
Line Commands 42 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 lock When enabled, the user can lock hi s terminal with a password using the Hotkey Prefix (default Ctrl-a) ^a l (lowercase L). The IOLAN prompts the user for a password and a confirmation.
43 Line Commands sess-timer Enter a time, in seconds, for w hich the Session Timer will run. Use th is timer to forcibly close the session (connection). When the Session T imer expires, the IOLAN will end the connection. The default value is 0 seconds so the port will never timeout.
Line Commands 44 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Line Interface Description Configures line interface (hardware) parameters. User Level Admin Syntax set line .
45 Line Commands Set Line Service 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 port s. Some EIA-485 applications require local echo to be enabled in order to monitor the loopback data to determine that line contentio n has occurred.
Line Commands 46 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 < host_port > The port number the target host is listening on for incoming connections. direct Direct connections b ypass the IOLAN, enabling the user to log straight into a specific host.
47 Line Commands Set Modem Description Sets the modem initialization string fo r a modem defined in the modem table. If you wish to add a new modem, use the add modem command. User Level Admin Syntax Options < mod em_name > Predefined modem name.
Line Service Commands 48 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set T ermtype Description Sets the terminal type for th e current terminal session. term1, term2, and term3 refer to the user-uploadable custom terminal definitions . If these are not present, the default is wyse60.
49 Line Service Commands Set T elnet-Client Description Configures the T elnet parameters for the sp ecified line. When the IOLAN initiates a T elnet connection to a host, it is acting as a T elnet client. User Level Normal, Admin Syntax Options termtype line-mode map-cr -crlf local-echo echo eof erase intr quit escape set telnet-client line .
Line Service Commands 50 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set UDP Description Configures the UDP settings for the serial line. User Level Normal, Admin Syntax Options entry 1|2|3|4 Selects which of the 4 available entries we wish to define/modify .
51 Line Service Commands Set Vmodem Description This command associates a phone number w ith an IP address and TCP p ort. This enables an existing modem application to i ssue a dial command with a phone number .
Line Service Commands 52 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Vmodem-Phone signals dtr Y ou can specify how the DTR signal pin acts during your modem application connection, as itself (DTR), as DCD, or as RI.
53 Line Service Commands Set Modbus-Slave Line Description Sets the Modbus slave pa rameters for the line. User Level Admin Syntax Options crlf protocol uid-range Set Modbus-Master Line < IP_address > Specify the IP address of the remote hos t that is receiving the vmodem connection.
Line Service Commands 54 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Multihost Line Description Configures multiple hosts or a prim ary/back up host schema fo r Silent Raw , Reverse Raw , or .
55 Line Service Commands Show Custom-App Description Shows the custom application line settings. User Level Admin Syntax Show Interface Description Shows the network interface information. User Level Admin Syntax Show Modbus Description Shows the Modbus settings for a line.
Modem Commands 56 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Modem Commands Add Modem Description Adds a modem. User Level Admin Syntax Options < mod em_name > < initialization_ string > Delete Modem Description Deletes a modem.
57 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 device is packetized before forwarding the packet onto the LA N network.
Packet Forwarding Commands 58 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 custom-on-specific-events This section allows you to set a variety of packet definition options.
59 Packet Forwarding Commands Show Packet-Forwarding Line Description Shows the packet-forwarding settings for the line. User Level Admin Syntax force-transmit-timer When the specified amount of time, in milliseconds, elapses after the first character is received from the serial port, th e packet is transmitted.
Packet Forwarding Commands 60 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 61 Network Commands Chapter 5 5 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s network parameters. SNMP Commands The IOLAN supports SNMP traps for restar t and SNMP communi ty authentication error .
SNMP Commands 62 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Delete Community Description Deletes an SNMP community (version 1 and version 2). User Level Admin Syntax Option < config_community_number > When you add an SNMP communi ty , it gets assigned to a number .
63 TFTP Commands TFTP Commands Set Server TFTP Description Configures the IOLANs TFTP client settings. User Level Admin Syntax Options retr y timeout Host s Commands Add Host Description Adds a host to the IOLAN host table.
Gateway Comma nds 64 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Host s Description Shows the IOLAN host table. User Level Normal, Admin Syntax Gateway Commands Add Gateway Description Adds a gateway . Y ou can configure up to twenty gateways.
65 Gateway Commands Set Gateway Description Configures the gateway . User Level Admin Syntax Options < config_gateway_host > Y ou can view the configured gateways that can be d eleted by typing delete gateway ? .
Logging Comma nds 66 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Logging Commands Set Syslog Description Configures the system log. User Level Admin Syntax Options level primary-host secondary-host Show Syslog Description Shows the syslog settings.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 67 T ime Commands Chapter 6 6 This chapter defines all the CLI commands a ssociated with configuring the IOLAN’ s time parameters. T ime Commands Set T ime Description Sets the IOLAN’ s system clock.
T ime/Date Setting Command s 68 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Date Description Shows the date, according to the IOLAN system clock.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 69 Administration Commands Chapter 7 7 This chapter defines all the CLI commands associ ated with configuring the IOLAN ’ s ad ministration parameters. Bootup Commands Reboot Description Reboots the IOLAN.
Bootup Commands 70 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set Bootup Description Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot.
71 TFTP File T ransfer Commands TFTP File T ransfer Commands Netload Description T ransfers a file from a remote host to the IOLAN using the TFTP protocol. User Level Admin Syntax Options text-config Specify this option i f you are uploading a text-based configuration file to the IOLAN from a TFTP server .
Custom Factory Default 72 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Net save Description T ransfers a file from the IOLA N to a remote host using the TFTP protocol. User Level Admin Syntax Options configurat ion Specifies that you are going to upload a co nfiguration file from the IOLAN to the specified host or IP address.
73 MOTD Commands Set Description Sets the current configuration on IOLAN to act as the factory default configuration. See the User Guide for dir ections on ho w to rever t b ack to the original facto ry default configuration, if required.
MOTD Commands 74 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 75 S t atistic Commands Chapter 8 8 This chapter defines all the CLI commands asso ciated with co nfiguring the IOLAN’ s statistic parameters. Configuration S t atistics Show Net stat Description Shows currently used TCP/UDP sockets/ports.
Run-T i me S tatistics 76 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Show Net st at S tatistics Description Shows protocol (IP/IC MP/TCP/UDP) counters. User Level Admin Syntax Show Routes Description Shows current information about IPv4 or IPv6 network routes.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 77 I/O Commands Chapter 9 9 This chapter defines all the CLI commands associat ed with configuring the IOLAN’ s I/O parameters. Global I/O Commands Set IO UDP Description Sets the UDP settings fo r I/O unicast messages.
Set Line 78 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IO Failsafe Description Sets the failsafe (watchdog) settings for I/O. User Level Admin Syntax Options mode timeout Set IO Modbus Descr.
79 Set IOChannel Set IOChannel Set IOChannel Mode Description Sets general I/O channel set tings for the sp ecified channel, these settings are available to all channels and I/O serial pins. User Level Admin Syntax Options i/o_channel Specify the channel number , for example, d2 or a4.
Set IOChannel 80 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Digit al Input (Serial Pins) trigger When the trigger con dition is met, tr iggers the specified alarm action. T riggers can be: z Disabled —No alarm settings. This is the default.
81 Set IOChannel Set IOChannel Digit al Output trigger When the trigger con dition is met, tr iggers the specified alarm action. T riggers can be: z Disabled —No alarm settings. This is the default. z Inactive —When the expected Digital input is active, going inactiv e will trigger an alarm.
Set IOChannel 82 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 type Specify the type of digital output: z Sink —Specifies that the channel will be grounded when active.
83 Set IOChannel Set IOChannel Digit al Output (Serial Pins) Description Sets the Digital output for serial pins R TS and DTR. This option is only availa ble when the Line Service is set to Signal I/O .
Set IOChannel 84 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Analog (T rue Analog) active-to-inactive-delay When the I/O is commanded to an inactive state, this is the len gth of the delay b efore the command is executed. V alid values are 1-9999 x 10 0 ms.
85 Set IOChannel alarm Configures alarm settings when the Analog input trigger is activated. level Y ou can specify up to five alarm tr igger/clear severity levels.
Set IOChannel 86 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Analog (T emperature) Description Sets the Analog input channel se ttin gs for T emperature models.
87 Set IOChannel level Y ou can specify up to five alarm tr igger/clear severity levels. If the Tr i g g e r Ty p e is Low , an alarm is triggered when th e input drops below the specified T rigger value; other severity level trigger va lues must decrease in value with each subsequent level.
Set IOChannel 88 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel IOExtension Description Configures the I/O extension options that allo w you to connect the Digital Input channel or inp.
89 Set IOChannel connection-method The connection-metho d is one of the following: z Client-Initiated —When specified, the channel/seri al signal pin will wait for connections to be initiated by an othe r I/O channel or a TCP/IP application.
Set IOChannel 90 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 Set IOChannel Multihost Description Configures up to 49 hosts/IOLANs that the Di g ital input channel or input serial signal pins (DSR, DCD, or CTS-when the line is configured for signal -io) will connect to.
91 Set IOChannel Show IO Description Shows global I/O information (for example, UDP , TruePort, Modbus). T emperature input is Analog. User Level Admin Syntax Options i/o_channel Specify the channel number , for example, d2 or a4. T emperature models use Analog input, so the channel numbers are a1-a4.
I/O Channel Control Commands 92 IOLAN DS1/TS2 CLI Reference Guide, V e rsion 4.1 I/O Channel Control Commands The I/O commands in this section are used to manual ly manage the I/O channels. Digit al Output Description Manages the Digital output channel status.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.1 93 Glossary This chapter provides definitions for IOLAN terms. BOOTP (BOOT strap Protocol) 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.
Een belangrijk punt na aankoop van elk apparaat Perle Systems 5500208-41 (of zelfs voordat je het koopt) is om de handleiding te lezen. Dit moeten wij doen vanwege een paar simpele redenen:
Als u nog geen Perle Systems 5500208-41 heb gekocht dan nu is een goed moment om kennis te maken met de basisgegevens van het product. Eerst kijk dan naar de eerste pagina\'s van de handleiding, die je hierboven vindt. Je moet daar de belangrijkste technische gegevens Perle Systems 5500208-41 vinden. Op dit manier kan je controleren of het apparaat aan jouw behoeften voldoet. Op de volgende pagina's van de handleiding Perle Systems 5500208-41 leer je over alle kenmerken van het product en krijg je informatie over de werking. De informatie die je over Perle Systems 5500208-41 krijgt, zal je zeker helpen om een besluit over de aankoop te nemen.
In een situatie waarin je al een beziter van Perle Systems 5500208-41 bent, maar toch heb je de instructies niet gelezen, moet je het doen voor de hierboven beschreven redenen. Je zult dan weten of je goed de alle beschikbare functies heb gebruikt, en of je fouten heb gemaakt die het leven van de Perle Systems 5500208-41 kunnen verkorten.
Maar de belangrijkste taak van de handleiding is om de gebruiker bij het oplossen van problemen te helpen met Perle Systems 5500208-41 . Bijna altijd, zal je daar het vinden Troubleshooting met de meest voorkomende storingen en defecten #MANUAl# samen met de instructies over hun opplosinge. Zelfs als je zelf niet kan om het probleem op te lossen, zal de instructie je de weg wijzen naar verdere andere procedure, bijv. door contact met de klantenservice of het dichtstbijzijnde servicecentrum.
