Perle IOLAN DS1 Cli Reference Manual

Perle IOLAN DS1 Cli Reference Manual

Command line interface
Hide thumbs Also See for IOLAN DS1:
Table of Contents

Advertisement

Quick Links

IOLAN
DS1/TS2
Command Line Interface

Reference Guide

Version 4.1
Part #5500208-41
October 2009

Advertisement

Table of Contents
loading

Summary of Contents for Perle IOLAN DS1

  • Page 1: Reference Guide

    IOLAN DS1/TS2 Command Line Interface Reference Guide Version 4.1 Part #5500208-41 October 2009...
  • Page 2 Markham, ON Canada L3R 0E1 Perle reserves the right to make changes without further notice, to any products to improve reliability, function, or design. Perle, the Perle logo, and IOLAN are trademarks of Perle Systems Limited. Microsoft, Windows 98, Windows NT, Windows 2000, Windows Server 2003, Windows XP, and Internet Explorer are trademarks of Microsoft Corporation.
  • Page 3: Table Of Contents

    Making a Technical Support Query ............12 Who To Contact ................. 12 Have Your Product Information Ready ..........12 Making a support query via the Perle web page ........ 12 Repair Procedure..................13 Feedback on this Manual............... 13 Chapter 1 Introduction............15 Introduction ................
  • Page 4 Show Server .................... 20 Hardware Commands..............20 Set Ethernet..................... 20 Show Hardware ..................20 Modbus Commands ..............21 Set Modbus Gateway................21 Show Modbus..................22 TruePort Baud Commands ............22 Set TruePort Remap-Baud ..............22 Show TruePort ..................22 IPv6 Commands................23 Set IPv6 ....................23 Show IPv6 ....................
  • Page 5 Show Sessions ..................30 Show Termtype..................30 Start ......................30 Telnet ....................... 31 Version ....................32 Configuring Users..............32 Add User....................32 Delete User....................32 Set Default User..................32 Set User ....................35 Set User Session ..................37 Show Default User.................. 37 Show User ....................
  • Page 6 Show Interface ..................55 Show Modbus..................55 Show Telnet-Client.................. 55 Show UDP....................55 Show Vmodem ..................55 Show Vmodem-Phone ................55 Modem Commands ..............56 Add Modem ..................... 56 Delete Modem..................56 Show Modems..................56 Packet Forwarding Commands ..........57 Set Packet-Forwarding Line..............57 Show Packet-Forwarding Line...............59 Chapter 5 Network Commands ........61 SNMP Commands...............61...
  • Page 7 Set Gateway .................... 65 Show Gateways ..................65 Logging Commands ..............66 Set Syslog ....................66 Show Syslog ................... 66 Chapter 6 Time Commands..........67 Time Commands ................ 67 Set Time....................67 Show Time....................67 Time/Date Setting Commands ..........67 Set Date ....................67 Set Time....................
  • Page 8 Set MOTD....................73 Show MOTD..................... 73 Chapter 8 Statistic Commands ........75 Configuration Statistics .............75 Show Netstat ...................75 Show Modbus Statistics................. 75 Show Netstat Statistics ................76 Show Routes ...................76 Run-Time Statistics ..............76 Delete Arp ....................76 Show Arp ....................76 Show Serial....................
  • Page 9 Set IOChannel IOExtension ..............88 Set IOChannel Multihost ................ 90 Show IOChannel Status ................. 90 Kill IOChannel ..................90 Show IO ....................91 Show IOChannel ..................91 I/O Channel Control Commands..........92 Digital Output..................92 Digital Input..................... 92 Relay ......................92 Analog Input....................
  • Page 10 IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 11: Preface

    Preface About This Book This guide provides the information you need to configure the IOLAN using the Command Line Interface (CLI). Intended Audience This guide is for administrators who will be configuring the IOLAN. Some prerequisite knowledge is needed to understand the concepts and examples in this guide: If you are using an external authentication application(s), working knowledge of the authentication application(s).
  • Page 12: Contacting Technical Support

    Perle offers free technical support to Perle Authorised Distributors and Registered Perle Resellers. If you bought your product from a registered Perle supplier, you must contact their Technical Support department; they are qualified to deal with your problem. Have Your Product Information Ready...
  • Page 13: Repair Procedure

    Contacting Technical Support Repair 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 directly. Customers who are in Europe, Africa or Middle East can submit repair details via a website form.
  • Page 14 Contacting Technical Support IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 15: Chapter 1 Introduction

    Introduction Chapter 1 Introduction This chapter provides the command line interface (CLI) options available for the IOLAN. The commands are grouped by function. CLI Conventions This section explains how to interpret the CLI syntax.If you are an existing Terminal Server customer and would like to configure the IOLAN in the native Terminal Server interface, you can type the command to display and use the native Terminal Server interface (you must have...
  • Page 16: Command Shortcuts

    CLI Conventions Options—Provides an explanation of each of the options for a command and the default value if there is one. Some commands do not have any options, so this category is absent. Command Shortcuts When you type a command, you can specify the shortest unique version of that command or you can press the key to complete the command.
  • Page 17: Chapter 2 Server Commands

    This chapter defines all the CLI commands associated with configuring the IOLAN’s server parameters. Server Commands Set Custom-App Description You can create a custom application that can run on the IOLAN using the Perle SDK. User Level Admin Syntax set custom-app server program-command-line <command>...
  • Page 18 Server Commands banner This parameter concerns the banner information (product name/software version). This banner information is presented to a user with a login prompt. For security reasons, you can turn off the display of this information. The default is break Enables/disables the existing Reverse Telnet break signal and the out-of-band break signals for TruePort.
  • Page 19: Set Service

    Server Commands prompt-with-name Displays the field value instead of default product name. When enabled, Server Name is displayed in the IOLAN login prompt, CLI prompt, WebManager Server Name login screen, and the heading of the Menu. The default value is single-telnet In this mode of operation, the IOLAN will only allow for a single TCP connection at a time to exist for each serial port configured for a reverse connection type.
  • Page 20: Show Custom-App

    Hardware Commands dmgrd DeviceManager daemon process in the IOLAN. If you disable this service, you will not be able to connect to the IOLAN with the DeviceManager application. DeviceManagerD listens on port 33812 and sends on port 33813. modbusd Modbus daemon process in the IOLAN on port 502. Show Custom-App Description Shows the custom application server settings.
  • Page 21: Modbus Commands

    Modbus Commands Modbus Commands Set Modbus Gateway Description Sets the Modbus parameters for the IOLAN when it is operating as a Modbus Gateway. User Level Admin Syntax set modbus gateway [addr-mode embedded|re-mapped] [broadcast on|off] [char-timeout <number>] [req-next-delay <number>] [exceptions on|off] [idle-timer <number>] [mess-timeout <number>] [port <TCP/UDP_port>] [req-queuing on|off] [remapped-id <1-247>]...
  • Page 22: Show Modbus

    TruePort Baud Commands Show Modbus Description Displays the Modbus Gateway parameters. User Level Admin Syntax show modbus gateway show modbus slave|master <line_number> TruePort Baud Commands Set TruePort Remap-Baud Description This command allows for the remapping of the baud rate being specified by the Serial application to a different value on the physical serial port on the IOLAN.
  • Page 23: Ipv6 Commands

    IPv6 Commands IPv6 Commands Set IPv6 Description Configures the basic IPv6 settings. User Level Admin Syntax set ipv6 [dhcpv6-settings ipv6-address on|off] [dhcp-settings network-prefix on|off] Set ipv6 enable-ipv6-addressing on|off [obtain-using auto-ipv6|dhcpv6] Options dhcpv6-settings Determines the types of information that the IOLAN will accept from the DHCPv6 server, IPv6 address(es) and/or network prefix(es).
  • Page 24: Add Custom-Ipv6

    IPv6 Commands Add Custom-IPv6 Description Adds a custom IPv6 address to the IOLAN. You can specify either a complete IPv6 address or an IPv6 network address. User Level Admin Syntax add custom-ipv6 method auto network-prefix <network_prefix> [prefix-bits <0-64>] add custom-ipv6 method manual ipv6-address <ipv6_address> [prefix-bits <0-128>] Options method auto...
  • Page 25: Delete Custom-Ipv6

    IPv6 Commands prefix-bits (auto) Specify the network prefix bits for the IPv6 address. Range: 0-64 Default: 64 method manual Specify this option when you want to enter a specific IPv6 address. ipv6-address Specify the complete IPv6 address. Field Format: IPv6 address prefix-bits (manual) Specify the network prefix bits for the IPv6 address.
  • Page 26 IPv6 Commands IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 27: Chapter 3 User Commands

    User Commands Chapter 3 This chapter defines all the CLI commands available 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. When you press after you type Enter this command, you will be prompted for the Admin password.
  • Page 28: Menu

    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 menu Ping Description This command checks to see if a given host is reachable via an IP message. The specific message used is called a ping User Level Normal, Admin...
  • Page 29: Set User

    Commands for Users Logged Into the IOLAN Set User Description Sets the current users settings. User Level Normal, Admin Syntax set user . [hotkey-prefix <00-7f>] [language english|customlang] [password] Options hotkey-prefix The prefix that a user types to control the current session. The default value is hex 01 which corresponds to ) (hex value 02 would be Ctrl-b (^b), etc.):...
  • Page 30: Show Line Users

    Commands for Users Logged Into the IOLAN Show Line Users Description Shows the users who are on the line. User Level Admin Syntax show line users Syslog Console Description Starts/stops or displays the status of the syslog console. User Level Admin Syntax syslog console start|stop syslog console status...
  • Page 31: Telnet

    Commands for Users Logged Into the IOLAN Telnet Description Starts a telnet session to the specified host/IP address. User Level Normal, Admin Syntax telnet <hostname/IP_address> [<tcp_port>] [termtype <terminal_name>] [line-mode on|off] [map-cr-crlf on|off] [local-echo on|off] [echo <00-7f>] [eof <00-7f>] [erase <00-7f>] [intr <00-7f>] [quit <00-7f>] [escape <00-7f>] Options <hostname/IP_address>...
  • Page 32: Version

    Configuring Users escape Defines the escape character. Returns you to the command line mode. This value is in hexadecimal with a default value of (ASCII value Version Description Displays firmware version and build. User Level Normal, Admin Syntax version Configuring Users Add User Description Adds a user.
  • Page 33 Configuring Users hotkey-prefix The prefix that a user types to control the current session. The default value is hex 01 which corresponds to ) (hex value 02 would be Ctrl-b (^b), etc.): Ctrl-a —To switch from one session to another, press and then the required ^a number session number.
  • Page 34 Configuring Users line-access Specifies the user access rights to each IOLAN device line. Options are: Read/Write—Users are given read and write access to the line. Read In—Users are given access to read only outbound data, data that is going from the IOLAN to the device. option is only for 1-port models.
  • Page 35: Set User

    Configuring Users Set User Description Sets users settings. Normal-level users can configure only their own settings. Admin-level users can configure any users settings, including their own (with the exception of their User Level, which must stay at Admin). User Level Normal, Admin Syntax set user .
  • Page 36 Configuring Users level The access that a user is allowed: Admin—The admin level user has total access to the IOLAN. You can create more than one admin user account but we recommend that you only have one. They can monitor and configure the IOLAN. Normal—The Normal level user has limited access to the IOLAN.
  • Page 37: Set User Session

    Configuring Users Set User Session Description Configures a users session settings. See Set User Session on page 29 for the options descriptions. User Level Admin Syntax set user .|<username> session 1|2|3|4|* [auto on|off] [type off|telnet] set user .|<username> session 1|2|3|4|* telnet-options [host <config_host>] [port <TCP_port>] [termtype <terminal_name>] [line-mode on|off] [map-cr-crlf on|off] [local-echo on|off]...
  • Page 38 Configuring Users IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 39: Chapter 4 Line Commands

    Line Commands Chapter 4 This chapter defines all the CLI commands associated with configuring the IOLAN’s line parameters. 1-Port vs. 2-Port Line Commands If you are using a DS1 IOLAN, the admin user does not have the option of using the number or all (*) options in the line commands, as there is only one line.
  • Page 40 Line Commands Options break Specifies how a break is interpreted: off—The IOLAN ignores the break key completely and it is not passed through to the host. This is the default setting. local—The IOLAN deals with the break locally. If the user is in a session, the break key has the same effect as a hot key.
  • Page 41 Line Commands hotkey-prefix The prefix that a user types to lock a line or redraw the Menu. The default value is , which corresponds to ) (hex value 02 would be Ctrl-b (^b), etc.): Ctrl-a —(Lowercase L) Locks the line until the user unlocks it. The user is prompted ^a l for a password (any password, excluding spaces) and locks the line.
  • Page 42 Line Commands lock When enabled, the user can lock his terminal with a password using the Hotkey Prefix (default Ctrl-a) (lowercase L). The IOLAN prompts the user for a password and a ^a l confirmation. mode Enables/disables the line (available only on the TS2 model). The default is enabled. modem-name The name of the predefined modem that is used on this line.
  • Page 43 Line Commands sess-timer Enter a time, in seconds, for which the will run. Use this timer to Session Timer forcibly close the session (connection). When the expires, the IOLAN Session Timer will end the connection. The default value is seconds so the port will never timeout. The maximum value is 4294967 seconds (about 49 days).
  • Page 44: Set Line Interface

    Line Commands Set Line Interface Description Configures line interface (hardware) parameters. User Level Admin Syntax set line .|<number>|* interface eia-232 [monitor-dcd on|off] [monitor-dsr on|off] [flow none|soft|hard|both] [speed 50|75|110|134|150|200|300|600|1200|1800|2400|4800|9600| 19200|38400|57600|115200|230400|28800|custom <baud_rate>] set line interface eia-422 [flow none|soft|hard|both] [speed 50|75|110|134|150|200|300|600|1200|1800|2400|4800| 9600|19200|38400|57600|115200|230400|28800|custom <baud_rate>] set line interface eia-485 [tx-driver-control auto|rts] [flow none|soft] [duplex full|duplex half [echo-suppression on|off]]...
  • Page 45: Set Line Service

    Line Commands echo-suppression This parameter applies only to mode. All characters will be EIA-485 Half Duplex echoed to the user and transmitted across the serial ports. Some EIA-485 applications require local echo to be enabled in order to monitor the loopback data to determine that line contention has occurred.
  • Page 46 Line Commands <host_port> The port number the target host is listening on for incoming connections. direct Direct connections bypass the IOLAN, enabling the user to log straight into a specific host. A direct connection is recommended where a user logging in to the IOLAN is not required.
  • Page 47: Set Modem

    Line Commands client-initiated When this option is turned on, the IOLAN will wait for a connection from the TruePort host (see the TruePort documentation for information on how to set up this feature on the TruePort host). When this option is turned off, the IOLAN will initiate the connection to the TruePort host.
  • Page 48: Set Termtype

    Syntax show line Line Service Commands Set Custom-App Description You can create a custom application that can run on a specific serial line in IOLAN using the Perle SDK. User Level Admin Syntax set custom-app line .|<number>|* program-command-line <command> Options...
  • Page 49: Set Telnet-Client

    Line Service Commands Set Telnet-Client Description Configures the Telnet parameters for the specified line. When the IOLAN initiates a Telnet connection to a host, it is acting as a Telnet client. User Level Normal, Admin Syntax set telnet-client line .|<number>|* [termtype <terminal_name>] [line-mode on|off] [map-cr-crlf on|off] [local-echo on|off] [echo <00-7f>] [eof <00-7f>] [erase <00-7f>] [intr <00-7f>] [quit <00-7f>] [escape <00-7f]...
  • Page 50: Set Udp

    Line Service Commands Set UDP Description Configures the UDP settings for the serial line. User Level Normal, Admin Syntax set udp line .|<number>|* entry 1|2|3|4 both auto-learn|specific <UDP_port> [<start_IP_address>] [<end_IP_address>] set udp line .|<number>|* entry 1|2|3|4 in any-port|auto-learn|specific <UDP_port> [<start_IP_address>] [<end_IP_address>] set udp line .|<number>|* entry 1|2|3|4 out <UDP_port>...
  • Page 51: Set Vmodem

    Line Service Commands Set Vmodem Description This command associates a phone number with an IP address and TCP port. This enables an existing modem application to issue a dial command with a phone number. The phone number will be searched in this table and if an exact match is found, the associated IP address and TCP port will be used to establish the connection.
  • Page 52: Set Vmodem-Phone

    Line Service Commands signals dtr You can specify how the DTR signal pin acts during your modem application connection, as itself (DTR), as DCD, or as RI. signals rts You can specify how the RTS signal pin acts during your modem application connection, as itself (RTS), as DCD, or as RI.
  • Page 53: Set Modbus-Slave Line

    Line Service Commands <IP_address> Specify the IP address of the remote host that is receiving the vmodem connection. <TCP_port> Specify the TCP port that the remote host is lisening on for the vmodem connection. delete Deletes the specified entry from the phone number table. Set Modbus-Slave Line Description Sets the Modbus slave parameters for the line.
  • Page 54: Set Multihost Line

    Line Service Commands protocol Specify the protocol that is used between the Modbus Master and Modbus Slave(s), either TCP or UDP. range-mode If you specify , the IP address is used for the first UID specified in the range. The Host last octect in the IPv4 address is then incremented for subsequent UID’s in that range.
  • Page 55: Show Custom-App

    Line Service Commands Show Custom-App Description Shows the custom application line settings. User Level Admin Syntax show custom-app line .|<number>|* Show Interface Description Shows the network interface information. User Level Admin Syntax show interface [brief|ethernet] Show Modbus Description Shows the Modbus settings for a line. User Level Admin Syntax show modbus master|slave <number>...
  • Page 56: Modem Commands

    Modem Commands Modem Commands Add Modem Description Adds a modem. User Level Admin Syntax add modem <modem_name> <initialization_string> Options <modem_name> The name of the modem. Do not use spaces. <initialization_string> The initialisation string of the modem; see your modem’s documentation. Delete Modem Description Deletes a modem.
  • Page 57: Packet Forwarding Commands

    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 LAN network. This command configures packet forwarding options for serial devices attached to the serial line.
  • Page 58 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. For example, if you set a Force ms and a bytes, whichever criteria is met Transmit Timer 1000 Packet Size...
  • Page 59: Show Packet-Forwarding Line

    Packet Forwarding Commands force-transmit-timer When the specified amount of time, in milliseconds, elapses after the first character is received from the serial port, the packet is transmitted. After a packet is transmitted, the next character received starts the timer again. A value of zero (0) ignores this parameter.
  • Page 60 Packet Forwarding Commands IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 61: Chapter 5 Network Commands

    Network Commands Chapter 5 This chapter defines all the CLI commands associated with configuring the IOLAN’s network parameters. SNMP Commands The IOLAN supports SNMP traps for restart and SNMP community authentication error. Add Community Description Adds an SNMP community (version 1 and version 2). User Level Admin Syntax add community <community_name>...
  • Page 62: Delete Community

    SNMP Commands Delete Community Description Deletes an SNMP community (version 1 and version 2). User Level Admin Syntax delete community <config_community_number> Option <config_community_number> When you add an SNMP community, it gets assigned to a number. To delete the SNMP community, you need to specify the number of the community that you want to delete. To see which community is assigned to what number, type the command.
  • Page 63: Tftp Commands

    TFTP Commands TFTP Commands Set Server TFTP Description Configures the IOLANs TFTP client settings. User Level Admin Syntax set server tftp [retry <integer>] [timeout <integer>] Options retry The number of times the IOLAN will attempt to transfer (using TFTP) a file to/from a host.
  • Page 64: Show Hosts

    Gateway Commands Show Hosts Description Shows the IOLAN host table. User Level Normal, Admin Syntax show hosts Gateway Commands Add Gateway Description Adds a gateway. You can configure up to twenty gateways. User Level Admin Syntax add gateway <config_host> default add gateway <config_host>...
  • Page 65: Set Gateway

    Gateway Commands Set Gateway Description Configures the gateway. User Level Admin Syntax set gateway <config_gateway_host> default set gateway <config_gateway_host> host <destination_ip> set gateway <config_gateway_host> network <dest_IPv4_addr>|<dest_IPv6_address> <prefixbits_mask>| Options <config_gateway_host> You can view the configured gateways that can be deleted by typing delete gateway ? default|host|network Specify the type of gateway:...
  • Page 66: Logging Commands

    Logging Commands Logging Commands Set Syslog Description Configures the system log. User Level Admin Syntax set syslog [level emergency|alert|critical|error|warning|notice|info|debug] [primary-host <config_host>] [secondary-host <config_host>] Options level Choose the event level that triggers a syslog entry: Emergency Alert Critical Error Warning Notice Info Debug When you select a...
  • Page 67: Chapter 6 Time Commands

    Time Commands Chapter 6 This chapter defines all the CLI commands associated with configuring the IOLAN’s time parameters. Time Commands Set Time Description Sets the IOLAN’s system clock. User Level Admin Syntax set time <hh:mm[:ss]> Option <hh:mm[:ss]> Sets the IOLAN’s system time, using military time format. Show Time Description Shows the ’s system clock.
  • Page 68: Show Date

    Time/Date Setting Commands Show Date Description Shows the date, according to the IOLAN system clock. User Level Normal, Admin Syntax show date Show Time Description Shows the IOLAN’s system clock. User Level Normal, Admin Syntax show time IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 69: Chapter 7 Administration Commands

    Administration Commands Chapter 7 This chapter defines all the CLI commands associated with configuring the IOLAN’s administration parameters. Bootup Commands Reboot Description Reboots the IOLAN. You will be prompted to save configuration to FLASH, if there have been unsaved configuration changes. User Level Admin Syntax reboot...
  • Page 70: Set Bootup

    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 set bootup firmware host <hostname> [file <path_filename>] set bootup configuration host <hostname> [file <path_filename>] Options firmware file The path and file name (do not use a drive letter), relative to the default path of your TFTP server software, of the update software for the IOLAN that will be loaded when...
  • Page 71: Tftp File Transfer Commands

    TFTP File Transfer Commands TFTP File Transfer Commands Netload Description Transfers a file from a remote host to the IOLAN using the TFTP protocol. User Level Admin Syntax netload text-config|factory-default-configfirmware|configuration| customlang|term1|term2|term3|customapp-file <hostname/ip_address> <filename> Options text-config Specify this option if you are uploading a text-based configuration file to the IOLAN from a TFTP server.
  • Page 72: Netsave

    Custom Factory Default Netsave Description Transfers a file from the IOLAN to a remote host using the TFTP protocol. User Level Admin Syntax netsave configuration|crash|serialt-buf|text-config <hostname/ip_address> <filename> Options configuration Specifies that you are going to upload a configuration file from the IOLAN to the specified host or IP address.
  • Page 73: Set

    MOTD Commands Description Sets the current configuration on IOLAN to act as the factory default configuration. See the User Guide for directions on how to revert back to the original factory default configuration, if required. User Level Admin Syntax set config-to-factory-default MOTD Commands Set MOTD Description Specifies the server/file that contains the message of the day (MOTD) that is displayed...
  • Page 74 MOTD Commands IOLAN DS1/TS2 CLI Reference Guide, Version 4.1...
  • Page 75: Chapter 8 Statistic Commands

    Statistic Commands Chapter 8 This chapter defines all the CLI commands associated with configuring the IOLAN’s statistic parameters. Configuration Statistics Show Netstat Description Shows currently used TCP/UDP sockets/ports. User Level Admin Syntax show netstat [all] [listening] [tcp] [udp] [tcpv6] [updv6] Options Displays all ports, including server (listening) ports;...
  • Page 76: Show Netstat Statistics

    Run-Time Statistics Show Netstat Statistics Description Shows protocol (IP/ICMP/TCP/UDP) counters. User Level Admin Syntax show netstat statistics [ip] [ipv6] [icmp] [icmpv6] [tcp] [udp] [udp6] Show Routes Description Shows current information about IPv4 or IPv6 network routes. User Level Admin Syntax show routes [ipv6] Run-Time Statistics Delete Arp...
  • Page 77: Chapter 9 I/O Commands

    I/O Commands Chapter 9 This chapter defines all the CLI commands associated with configuring the IOLAN’s I/O parameters. Global I/O Commands Set IO UDP Description Sets the UDP settings for I/O unicast messages. User Level Admin Syntax set io udp [mode on|off] [broadcast-interval <broadcast_interval>] set io udp entry 1|2|3|4 disabled set io udp entry 1|2|3|4 <udp_port>...
  • Page 78: Set Io Failsafe

    Set Line Set IO Failsafe Description Sets the failsafe (watchdog) settings for I/O. User Level Admin Syntax set io failsafe [mode on|off] [timeout <seconds>] Options mode Enables/disables the Failsafe Timer. This is the global setting that must be enabled to set the Failsafe Action on the channel for digital outputs and relays.
  • Page 79: Set Iochannel

    Set IOChannel Set IOChannel Set IOChannel Mode Description Sets general I/O channel settings for the specified channel, these settings are available to all channels and I/O serial pins. User Level Admin Syntax set iochannel <i/o_channel> [mode enabled|disabled] [description <string>] Options i/o_channel Specify the channel number, for example, d2 or a4.
  • Page 80: Set Iochannel Digital Input (Serial Pins)

    Set IOChannel trigger When the trigger condition is met, triggers the specified alarm action. Triggers can be: Disabled—No alarm settings. This is the default. Inactive—When the expected Digital input is active, going inactive will trigger an alarm. Active—When the expected Digital input is inactive, going active will trigger an alarm.
  • Page 81: Set Iochannel Digital Output

    Set IOChannel trigger When the trigger condition is met, triggers the specified alarm action. Triggers can be: Disabled—No alarm settings. This is the default. Inactive—When the expected Digital input is active, going inactive will trigger an alarm. Active—When the expected Digital input is inactive, going active will trigger an alarm.
  • Page 82 Set IOChannel type Specify the type of digital output: Sink—Specifies that the channel will be grounded when active. Source—Specifies that the channel will provide voltage when active. Sink and Source—Specifies that channel will be grounded when it is inactive and will provide voltage when it is active.
  • Page 83: Set Iochannel Digital Output (Serial Pins)

    Set IOChannel Set IOChannel Digital Output (Serial Pins) Description Sets the Digital output for serial pins RTS and DTR. This option is only available when is set to Line Service Signal I/O User Level Admin Syntax set iochannel rts|dtr [description <string>] [failsafe-action none|activate-outut|deactivate-output] [mode enabled|disabled] Options...
  • Page 84: Set Iochannel Analog (True Analog)

    Set IOChannel active-to-inactive-delay When the I/O is commanded to an inactive state, this is the length of the delay before the command is executed. Valid values are 1-9999 x 100 ms. The default is 100 ms. inactive-to-active-delay When the I/O is commanded to an active state, this is the length of the delay before the command is executed.
  • Page 85 Set IOChannel alarm Configures alarm settings when the Analog input trigger is activated. level You can specify up to five alarm trigger/clear severity levels. If the Trigger Type , an alarm is triggered when the input drops below the specified value;...
  • Page 86: Set Iochannel Analog (Temperature)

    Set IOChannel Set IOChannel Analog (Temperature) Description Sets the Analog input channel settings for Temperature models. User Level Admin Syntax set iochannel <analog_channel> type rtd|thermocouple range <range_specifier> set iochannel <analog_channel> alarm [level 1|2|3|4|5 [mode on|off] [trigger-type disabled|low|high] [trigger-level <decimal_value>] [clear-mode auto|manual] [clear-level <decimal_value>] [snmp on|off] [syslog on|off]] Options analog_channel...
  • Page 87 Set IOChannel level You can specify up to five alarm trigger/clear severity levels. If the Trigger Type , an alarm is triggered when the input drops below the specified value; Trigger other severity level trigger values must decrease in value with each subsequent level. If , an alarm is triggered when the input is higher than the Trigger Type High...
  • Page 88: Set Iochannel Ioextension

    Set IOChannel Set IOChannel IOExtension Description Configures the I/O extension options that allow you to connect the Digital Input channel or input serial signal pin (when the line is configured for signal-io) to Digital Output/Relay channels or output serial signal pins (when the line is configured for signal-io) on the same IOLAN, remote IOLAN(s), and/or TCP/IP applications running on local hosts.
  • Page 89 Set IOChannel connection-method The connection-method is one of the following: Client-Initiated—When specified, the channel/serial signal pin will wait for connections to be initiated by another I/O channel or a TCP/IP application. Server-Initiated—When specified, the channel/serial signal pin initiates communication to another I/O channel or a TCP/IP application. Local-Connection—When specified, the input or output, depending on how the channel or serial signal pin is configured, will be associated with another local IOLAN I/O channel or serial signal pin.
  • Page 90: Set Iochannel Multihost

    Set IOChannel Set IOChannel Multihost Description Configures up to 49 hosts/IOLANs that the Digital input channel or input serial signal pins (DSR, DCD, or CTS-when the line is configured for signal-io) will connect to. To see a list of configured hosts/IOLANs, enter the show iochannel <channel>...
  • Page 91: Show Io

    Set IOChannel Show IO Description Shows global I/O information (for example, UDP, TruePort, Modbus). Temperature input is Analog. User Level Admin Syntax show iochannel <i/o_channel> show iochannel rts|cts|dtr|dsr|dcd Options i/o_channel Specify the channel number, for example, d2 or a4. Temperature models use Analog input, so the channel numbers are a1-a4.
  • Page 92: I/O Channel Control Commands

    I/O Channel Control Commands I/O Channel Control Commands The I/O commands in this section are used to manually manage the I/O channels. Digital Output Description Manages the Digital output channel status. Not all models have four digital channels, most have just two. User Level Admin Syntax iochannel d1|d2|d3|d4|cts|dsr|dcd clear alarm|input-latch...
  • Page 93: Glossary

    Glossary This chapter provides definitions for IOLAN terms. BOOTP (BOOTstrap An Internet protocol that enables a diskless workstation to discover its own IP address, the IP Protocol) address of a BOOTP server on the network, and a file to be loaded into memory to boot the machine.

This manual is also suitable for:

Iolan ts2

Table of Contents