Perle SystemsメーカーDS1の使用説明書/サービス説明書
ページ先へ移動 of 88
IOLAN DS1/TS2 Command Line Interface Reference Guide Version 4.5 Part #5500208-45 July 2013.
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.5 3 Preface ........................ ....................................................... 11 About This Book .............. .................................... ...................... 11 Intended Audience .
4 Show Server ............. ................ ................................................. .............. 19 Hardware Commands ............ .............................. ...................... 20 Set Ethernet ............. ................ ......
5 Syslog Console............ ................................................. ............... ........... 29 Show Sessions ................... ............................ .............. ............... ........... 29 Show Termtype .......... .......
6 Set Line Initiate-Connection ... ................ ................................. .............. 51 Show Custom-App ...... ................. ................................ ............... ........... 52 Show Interface .................. ........
7 Show Hosts .............. ................................ ................................. .............. 61 Gateway Commands .............. .............................. ...................... 61 Add Gateway .............. ......................
8 Custom Factory Default . ........................................................... 69 Netload .............. .............................................. .............. ............... ........... 69 Set ................. .......................
9 Set IOChannel Digital Output (Serial Pins) ..... ............................ ......... 79 Set IOChannel Relay ...... ................................ .............. ............... ........... 79 Set IOChannel Analog (True Analog) ......... .......
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 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.
12 Contacting T echnical Support 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.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 14 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.
15 CLI Conventions z Options —Provides an explanation of each of the op tions for a command and the default value if there is one. Some commands do not have any option s, so this category is absent.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 16 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.
17 Server Commands 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. The default is Off .
18 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 inst ead of the default prompt, login: .
19 Server Commands Set Service Description Sets server service parameters. User Level Admin Syntax Options telnetd httpd snmpd spcd syslog dmgrd modbusd Show Custom-App Description Shows the custom application server settings. User Level Admin Syntax Show Modbus Description Shows the Modbus settings for the gateway .
20 Hardware Commands Hardware Commands Set Ethernet Description Sets the hardware configuration for th e Ethernet port(s). User Level Admin Syntax Options auto|10-half|10-full| 100-half|100-full Show Hardware Description Shows the hardware resources, Ethernet link status, date and time.
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 .
22 T ruePort Baud Commands Show Modbus Description Displays the Modbus Gateway parameters. User Level Admin Syntax T ruePort Baud Commands Set T ruePort Remap-Baud Description This command allows for the remapping of th e baud rate being specified by the Serial application to a different value on th e physical serial port on the IOLAN.
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.
24 IPv6 Commands 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.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 26 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 .
27 Commands for Users Logged Into the IOLAN 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.
28 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 Option wyse6.
29 Commands for Users Logged Into the IOLAN 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. User Level Admin Syntax Options start|stop Star t or stop console lo gging.
30 Commands for Users Logged Into the IOLAN Te l n e t Options 1|2|3|4 The number of the session that you want to start. Description Starts a telnet session to the specified host/IP address.
31 Configu ring Users 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. For units with 8 or mor e serial por ts, the maxi mum number of users which can be added is 48.
32 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 .
33 Configu ring Users Set User 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.
34 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 .
35 Configu ring Users Set User Session Description Configures a users session settings. See Set User Ses sion for the options descriptions. User Level Admin Syntax Show Default User Description Shows the Default Users settings.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 36 Line Commands Chapter 4 4 This chapter defines all the CLI commands associat ed with configuring the IOLAN ’ s line parameters.
37 Line Commands Elevated User set line .|< number >|* speed [50|75|110|134|150|200|300|600|1200|18 00|2400|4800|9600|19,200|3 8,400|57,600|115,200|230,400|28,800|cu stom] Note: The save command must be executed by an admin user in order for this parameter to be permanently s aved.
38 Line Commands flowin Determines if input flow contro l is to be used. Default is On . This is active only when Line Flow Control is set to Sof t , Hard , or Both . flowout Determines if output flow control is to be used. Default is On . This is active on ly when Line Flow Control is set to Sof t , Hard , or Both .
39 Line Commands internet-address Used with reverse sessions, users can access s erial devices connect ed to the IOLAN by the specified Internet Address (or host name that can be resolved by a DNS). Y ou must reboot the IOLAN for the Internet Address to take affect (the kill line option does not apply to this parameter).
40 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 se rial devices at .
41 Line Commands Set Line Interface discard-characters-in-error When enabled, the IOLAN will discard characters rece ived with a parity or framing error . Default: Disabled. Description Configures line interface (hardware) parameters. User Level Admin Syntax set line .
42 Line Commands Set Line Service duplex Specify whether the line is Full Duplex (communication both ways at t he same time) or Half Duplex (communication in one directio n at a time). echo-suppression This parameter applies only to EIA-485 Half Duplex mode.
43 Line Commands < server_port > The IOLAN port number . < 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.
44 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.
45 Line Service Commands Set T ermtype Description Sets the terminal type for the current termin al session. term1, term2, and term3 refer to the user-uploadable custom terminal definitions .
46 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 .
47 Line Service Commands 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 . For each entry the user can specify a dif ferent IP address ra nge, UDP port and direction of data flow .
48 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 .
49 Line Service Commands 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. signals rts Y ou can specify how the R TS signal pin acts during you r modem application connection, as itself (R TS), as DCD, or as RI.
50 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.
51 Line Service Commands Set Multihost Line Description Configures multiple hosts or a prim ary/back up host schema fo r Silent Raw , Reverse Raw , or Client-Initi ated T ruePort servi ce types (multihost must be enabled by the line service type for this to take effect, see Set Line Service for the command to enable multiho st).
52 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.
53 Modem Commands Modem Commands Add Modem Description Adds a modem. User Level Admin Syntax Options < mod em_name > < initialization_ string > Delete Modem Description Deletes a modem. User Level Admin Syntax Option < config_modem_name > Y ou can see a the list of modems that can be deleted by typing delete modem ? .
54 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.
55 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.
56 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.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 57 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 .
58 SNMP Commands 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 . T o delete the SNMP community , you need to specify the number of the community that you want to delet e.
59 SNMP Commands Set SNMP engine-id-string Description Configures SNMP v3 Engine ID . User Level Admin Syntax Options string Set SNMP inform-timeout Description Configures SNMP inform traps timeout value. User Level Admin Syntax Options number Set SNMP inform-retries Description Configures SNMP i nform traps number of retires.
60 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 .
61 Gateway Commands Show Host s Description Shows the IOLAN host table. User Level Normal, Admin Syntax Gateway Commands Add Gateway Description Adds a gateway .
62 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 ? .
63 Logging Commands 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.5 64 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.
65 T ime/Date Setti ng Commands Show Date Description Shows the date, according to the IOLAN system clock. User Level Normal, Admin Syntax Show Time Description Shows the IOLAN’ s system clock.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 66 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.
67 Bootup Commands Set Bootup Description Specifies remote the TFTP host and pathname for files to be loaded after a IOLAN reboot. User Level Admin Syntax Options firmwar e file configuration file host The host name or IPv4/IPv6 address of the se rver that contains t he configurati on or firmware file.
68 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 .
69 Custom Factory Default 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.
70 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.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 71 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.
72 Run-T ime S tatistics 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. User Level Admin Syntax Run-T ime St atistics Delete Arp Description Delete entries from the IOLA N's ARP cache.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 73 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.
74 Set Line Set IO Failsafe Description Sets the failsafe (watchdog) settings for I/O. User Level Admin Syntax Options mode timeout Set IO Modbus Description Enabling the Modbus option makes the IOLAN act as a Modb us Slave, allowing Modbus Masters to communicat e with the IOLAN to control and/or retrieve I/O data.
75 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.
76 Set IOChannel 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. z Inactive —When the expected Digital input is active, going inactiv e will trigger an alarm.
77 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.
78 Set IOChannel type Specify the type of digital output: z Sink —Specifies that the channel will be grounded when active. z Sourc e —Specifies that the channel wi ll provide voltag e when active. z Sink and Sour ce —Specifies that channel will be grounded when it is inactive and will provide voltage when it is active.
79 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 .
80 Set IOChannel 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.
81 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.
82 Set IOChannel Set IOChannel Analog (T emperature) Description Sets the Analog input channel se ttin gs for T emperature models. User Level Admin Syntax set iochannel < analog_channel > type r.
83 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.
84 Set IOChannel Set IOChannel IOExtension Description Configures the I/O extension options that allo w you to connect the Digital Input channel or input serial signal pin (when the line is confi gure.
85 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.
86 Set IOChannel Set IOChannel Multihost Description Configures up to 49 hosts/IOLANs that the Di g ital input channel or input serial sign al pins (DSR, DCD, or CTS-when the line is confi gured for signal-io) will connect to. T o see a list of configured hosts/IO LANs, enter the show iochannel < channel > command.
87 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.
88 I/O Channel Control Commands 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. No t all models have four digital channels, most have just two.
IOLAN DS1/TS2 CLI Referenc e Guide, V ersion 4.5 89 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.
デバイスPerle Systems DS1の購入後に(又は購入する前であっても)重要なポイントは、説明書をよく読むことです。その単純な理由はいくつかあります:
Perle Systems DS1をまだ購入していないなら、この製品の基本情報を理解する良い機会です。まずは上にある説明書の最初のページをご覧ください。そこにはPerle Systems DS1の技術情報の概要が記載されているはずです。デバイスがあなたのニーズを満たすかどうかは、ここで確認しましょう。Perle Systems DS1の取扱説明書の次のページをよく読むことにより、製品の全機能やその取り扱いに関する情報を知ることができます。Perle Systems DS1で得られた情報は、きっとあなたの購入の決断を手助けしてくれることでしょう。
Perle Systems DS1を既にお持ちだが、まだ読んでいない場合は、上記の理由によりそれを行うべきです。そうすることにより機能を適切に使用しているか、又はPerle Systems DS1の不適切な取り扱いによりその寿命を短くする危険を犯していないかどうかを知ることができます。
ですが、ユーザガイドが果たす重要な役割の一つは、Perle Systems DS1に関する問題の解決を支援することです。そこにはほとんどの場合、トラブルシューティング、すなわちPerle Systems DS1デバイスで最もよく起こりうる故障・不良とそれらの対処法についてのアドバイスを見つけることができるはずです。たとえ問題を解決できなかった場合でも、説明書にはカスタマー・サービスセンター又は最寄りのサービスセンターへの問い合わせ先等、次の対処法についての指示があるはずです。