API Over TruePort Only | Perle Systems STS, SCS guide

TruePort I/O

API Over TruePort Only

If you have a custom application that talks to a serial port, you can use TruePort as a virtual serial port to communicate with the IOLAN over the network to access I/O data using the Perle API. You also have the option of enabling SSL as a security option to encrypt the data that is communicated between the IOLAN and the host machine (SSL/TLS must be configured in the Server settings and on the TruePort host). See Accessing I/O Data Via TruePort on page 275 for more information on the API.)

Network

PC running

Custom

Application (API)/

TruePort

perle

IOLAN

Power

I/O Digital

Output

The host running TruePort must be in I/O API mode.

274	IOLAN SDS/SCS/STS User’s Guide, Version 3.6

Image 274

Perle Systems STS, SCS manual API Over TruePort Only, PC running Custom Application API TruePort

Contents

Iolan SDS/SCS/STS EN 55022 1998, Class A, Note Table of Contents Configuration Methods DHCP/BOOTP Getting Started Network Settings Configuring Serial Ports UDP Sockets Profile 132 Remote Access Slip Profile 179 Configuring Users Configuring Security Configuring I/O Interfaces Channels UDP Configuring Clustering Controlling the RPS, I/O Channels, System Administration Applications Appendix B SSL/TLS Ciphers Appendix E Setting Jumpers 361 Appendix G Utilities Appendix I Troubleshooting Glossary Index Intended Audience PrefaceAbout This Book Documentation Typeface Conventions Online Help About the Iolan IntroductionIolan Family Models Iolan Features Hardware Software Security Ldap Iolan Components ConnectivityIntroduction What’s Included Power Over Ethernet PoE Models Power Supply SpecificationsAvailable Accessories Desktop Models Getting to Know Your Iolan DC Power RequirementsAC Power Requirements Rack Mount Models Port Serial Activity Port Top View End View Console Port/LED View Rack MountSerial/Ethernet View Serial Mode Console/Serial SwitchConsole Mode Dedicated Console Port Rack Mount Models Desktop/Rack Mount Models Powering Up the IolanModels Primary Supply DC Power ModelsEarthing Wire Secondary back-up Supply Disconnecting 48V Power Supplies from the Iolan Powering Up the Iolan Configuration Methods Chapter Configures an IP Address Configuration Methods OverviewRequires a Configured IP Address Easy Config Wizard Connecting to the Iolan Using DeviceManager Access PlatformsUnique Features DeviceManager DeviceManager Using DeviceManager WebManager Connecting to the Iolan Using WebManager Iolan Using WebManager Connecting to the Iolan Using the CLI Command Line InterfaceThrough the Network Menu Using the CLIConnecting to the Iolan Using the Menu Through the Serial Port Using the Menu Connecting to the Iolan Using DHCP/BOOTP Using DHCP/BOOTP DHCP/BOOTP Parameters TACACS+ Securid Connecting to the Iolan Using Snmp Snmp Using the Snmp MIB Using the IOLAN+ Interface Connecting to the Iolan to Use the IOLAN+ InterfaceIOLAN+ Interface REMOTE-ADMIN Changes to the IOLAN+ Interface Opt HEX Rlogin/Telnet Remote Access Systems Screen Name Wchiewsds2 Debug mode IP address IOLAN+ Interface Easy Configuration Wizard Getting Started Setting Up the Network Using a Direct Serial Connection to Specify an IP Address Using a Direct Serial Connection to Enable BOOTP/DHCP Using ARP-Ping For an IPv6 Network Setting Up the Serial Ports Setting Up the Serial Ports Setting Up Users Using DeviceManager WebManager Navigating DeviceManager/WebManager DeviceManager WebManager EasyPort Web Using DeviceManager to Connect to the Iolan Starting a New Session Assigning a Temporary IP Address to a New Iolan Adding/Deleting Manual IOLANs Logging in to the Iolan Creating a New Iolan Configuration in DeviceManager Using WebManager to Connect to the IolanConfiguration Files Logging into the Iolan Importing an Existing Configuration File Opening an Existing Configuration FileManaging the Iolan Network Settings Overview IP SettingsIPv4 Settings Field Descriptions IPv6 Settings DHCPv6 AutoconfigurationIPv6 Custom IPv6 Prefix Bits Range Default Adding/Editing a Custom IPv6 Address Advanced Server Name.Domain Prefix.Domain Name Default Disabled Advertise DHCPv6 Default 100 msDefault 200 ms Configuration Functionality AdvancedHost Table IP Filtering Data Options Fully Qualified Adding/Editing a HostHost Name Domain Name Route List Type Default DefaultAdding/Editing Routes IPv4 Subnet Mask DNS/WINS RIP Editing/Adding DNS/WINS Servers Authentication Ethernet ModeDefault None Password End Time Dynamic DNSOverview Functionality Key User Name Account SettingsDefault Dynamic System Type Cipher Suite Field Descriptions Adding/Editing a Cipher Suite Validation Criteria Field Descriptions IPv6 Tunnels Common Name Name Default ManualAdding/Editing an IPv6 Tunnel Mode 102 Iolan SDS/SCS/STS User’s Guide, Version Serial Ports Functionality Editing a Serial Port Copying a Serial Port Serial Port Profiles Resetting a Serial PortCommon Tabs Hardware Tab Field Descriptions Enable Inbound Default FullDefault Auto Flow Control Flow Control Default Enabled Enable Outbound Email Alert Tab Field Descriptions Packet Forwarding Tab Field Descriptions Packet Definition Enable Trigger1Enable Trigger2 Packet Size EOF2 Character Default TriggerEOF1 Character Trigger SSL/TLS Settings Tab Field Descriptions Default Client 114 Iolan SDS/SCS/STS User’s Guide, Version 115 116 Iolan SDS/SCS/STS User’s Guide, Version General Tab Field Descriptions Default TelnetConsole Management Profile Protocol Advanced Tab Field Descriptions Support Default Disabled Multisessions Enable MicrosoftAdministrator Idle Timeout Modem TruePort ProfilePhone Connect to System Default Enabled Host NameConnect to remote Multiple Hosts Hosts to connect to Host and backupAdding/Editing Additional TruePort Hosts Define a primary Adding/Editing a Multihost Entry Backup HostPrimary Host Day Motd Default Disabled Enable TCP Signals highWhen Session Timeout Enable DataLogging Connection Workstation/Server on the network Default Enabled TCP Sockets Profile Initiate Connection Received on the serial port Adding/Editing Additional Hosts 129 Day Motd Default Disabled Enable Data 131 UDP Sockets Profile Start IP Address UDP port DirectionEnd IP Address Terminal Profile Default 0 zeroUDP Port TVI925 Default DumbVT100 VT320 specifically supporting VT320-7 Default Disabled Protocol Is received Data Range 138 Iolan SDS/SCS/STS User’s Guide, Version User Service Settings Login Settings Quit Telnet SettingsInterrupt Erase User is only prompted for a password Rlogin SettingsEscape SSH Settings Authentication for the SSH session Slip SettingsRSA authentication for the SSH session Arcfour Routing VJ Compression PPP Settings IPv6 Remote Default ChapNone Remote User Timeout Remote PasswordConfigure Req Default 3 seconds Challenge Interval Default 1 minuteRoaming Callback Address/Control Printer Profile Serial Serial Tunneling ProfileSerial Server Tunnel Client Iolan Tunnel Client Default Disabled Host Name Act As Tunnel Virtual Modem Profile 154 Iolan SDS/SCS/STS User’s Guide, Version DCD AT Command DTR Signal Acts as RTS Signal Always On RTS Signal Acts asResponse Delay Phone Number to Host Mapping Phone Number Control Signal I/O ProfileVModem Phone Number Entry Host IP Address Description Input Signal Field DescriptionsInvert Signal Latch Manual Clear Auto Clear ModeMode Default Disabled Syslog Output Signal Field Descriptions Failsafe Action Modbus Gateway Profile IP Mappings Settings Button UID RangeDestination Slave Advanced Slave Default 1000 ms Default 30 msAdvanced Field Descriptions Modbus Slave IP Settings Field Descriptions UID Start Adding/Editing Modbus Slave IP SettingsDefault Host UID End Range Default 50 ms Modbus Slave Advanced Settings Field DescriptionsDefault TCP Data Options TCP or UDP Power Management Profile RPS Name Editing Power Management Plug Settings Field DescriptionsDefault RSP820 RPS Model Default Off Remote Access PPP ProfileDefault State Data Options On, Off Negotiate IP IPv6 Global Authentication Tab Field Descriptions 174 Iolan SDS/SCS/STS User’s Guide, Version Account Settings Enable DynamicDNS for this Serial Default Disabled Port Host Dynamic DNS Field Descriptions 176 Iolan SDS/SCS/STS User’s Guide, Version Enable VJ Configure RequestCompression Default Enabled Enable Protocol Enable Magic MS Direct Host Dial In/OutMS Direct Guest Remote Access Slip Profile 180 Iolan SDS/SCS/STS User’s Guide, Version 181 Custom Application Profile General Tab Field Description Local Port Buffering Port BufferingKeyboard Buttons Hot Keys Direction Field Definitions Remote Port Buffers NFS Host Enable PortData Default Disabled Enable Key Stroke NFS Directory Process Break Advanced Serial Settings TabSignals Deny Multiple String Default ~menuSerial Port Menu Session Escape Adding/Editing a Modem Modems TabName Name of the modem TruePort Baud Rate Tab Field Definitions 190 Iolan SDS/SCS/STS User’s Guide, Version Configuring Users User Settings Adding/Editing Users General Tab Default Normal Default DSPrompt Services TabService Host IP IPv6 Interface Indentifier Advanced Tab Default English Sessions Tab Session 1, 2, 3 Connect Allow Access to Serial Port Access TabSerial Port Access Clustered Ports 202 Iolan SDS/SCS/STS User’s Guide, Version Configuring Security Authentication Primary AuthenticationMethod Default Local Secondary Method Local Radius General Field Descriptions Attributes Field Descriptions Authenticator response Default Enabled RetryNAS-IP-Address Default Enabled NAS-Identifier KDC Domain KerberosRealm KDC Port Base Enable TLSTLS Port Authorization Port Default Authentication Authentication Authorization Primary Host Secondary HostDefault None Authentication Primary Host Default None SecurID NIS Lynn Users Logging into the Iolan Using SSHDevice Server Tracy Lynn Sales Server Users Passing Through the Iolan Using SSH Dir/SilHR Server Allow SSH-1 Interactive Default Enabled PasswordField Descriptions Keyboard Output Default Disabled Enable VerboseBreak String Button For a valid SSL/TLS connection 218 Iolan SDS/SCS/STS User’s Guide, Version Adding/Editing a Cipher 220 Iolan SDS/SCS/STS User’s Guide, Version VPN Authentication Algorithms-MD5, SHA1, SHA2 IKE Phase 1 ProposalsESP Phase 2 Proposals IPsec Adding/Editing the IPsec Tunnel Validation Criteria Default LeftSecret/Remote Local Device Shared Secret Field Description Remote Validation Criteria Field Descriptions L2TP/IPsec Allow L2TP/IPsec Exceptions Adding/Editing a VPN Exception Field Description TruePort Full ServicesTelnet Server Syslog Client SSH Server DeviceManagerWebManager Sntp Client Keys and Certificates Key Type 234 Iolan SDS/SCS/STS User’s Guide, Version Configuring I/O InterfacesChapter Settings Access Functionality Advanced Slave Modbus Settings Request Queuing Default 30 seconds Failsafe Timer FunctionalityFailsafe Action is triggered Broadcast of I/O Default Disabled Status Enable UDPUDP Functionality UDP Settings UDP Entry Temperature Functionality Default Celsius Monitoring Application A4D2 ChannelsAnalog Analog I/O Analog Default Current Alarm Settings Monitoring Application Digital InputDigital I/O Input Mode 247 Digital Output Default Sink Output ModeOutput Delay Pulse ModeInactive Signal Width Active Signal Width Pulse Count Monitoring Application A4D2Relay RelayRelay I/O Inactive Signal Width Front Door Active SignalDigital I/O Extension Warehouse Perle Iolan Reception Message type 1 Byte Current Alarm State 1 Byte z 0 = Not in alarmInput number 1 Byte Extension Enable I/OInput TCP Port Hosts Local connection Simultaneously Communicate to the Primary Host Temperature Temperature I/O Industrial Freezers Default RTD Alarm Settings Basic Analog Alarm Settings Clear Mode Advanced Analog Alarm SettingsTrigger Type Clear UDP Unicast Format UDP Broadcast Packet Analog Section Length EnabledSection Channel Length Channel Serial Pin Signal SectionDigital/Relay Section Length Pin Modbus Serial Application Connected to the Serial Port Modbus SlaveUDP Unicast Example Modbus Serial Application Connected to the Network Modbus TCP Application Modbus I/O AccessModbus RTU Or Ascii Application Power Digital Output Function Codes Coil/Register Descriptions Data Model A1/T1 A2/T2 A3/T3 A4/T4 Holding Registers Serial Port Coil/Register DescriptionsA4/T4 Registers Input Registers A4D2/A4R2 Registers Data Model D1/R1 D2/R2 Coils Data Model D3/R1 D4/R2 Coils Serial Pin SignalsD4/D2R2 Registers Data Model Pin Coils TruePort I/O Modbus Serial Application TruePort Power Digital OutputTruePort/Modbus Combination API Over TruePort Only PC running Custom Application API TruePort Setup Accessing I/O Data Via TruePortIntroduction Command Format Format of API CommandsGet Commands Response Format Set Commands Example 1 Turn on the first relay on a D2R2 unit Successful Response FormatUnsuccessful Response Format Example 2 Turn on the first and second relay on a D2R2 unit Error Codes Snmp Traps 280 Iolan SDS/SCS/STS User’s Guide, Version Clustering Slave List Configuring Clustering ChapterAdvanced Button Adding Clustering Slaves Advanced Clustering Slave Options Editing Clustering Slave SettingsPort Name Slave TCP Port Master TCP Port Option Card Settings Configuring the Option CardConfiguring the Iolan Modem Card Overview Field Descriptions Configuring a Wireless WAN CardCard APN 288 Iolan SDS/SCS/STS User’s Guide, Version Alerts Configuring the System ChapterEmail Alerts Alerts Syslog Location ManagementContact Community Default DES Auth Algorithm Data Options MD5, SHA Default MD5Auth Password Privacy Password Confirm Password Trap Algorithm Data Options MD5, SHA Default MD5Privacy Algorithm Data Options DES, AES Default DES Time Network Time Tab Field Descriptions Sntp ModeSntp Version Time Zone/Summer Time Tab Field Descriptions Custom App/Plugin Login Tab Field Descriptions Bootup Files Tab Field Descriptions Filename Message of the Day Motd Tab Field DescriptionsTftp Host Display Motd WebManager/Easy Port Web Console Port Tab Field Descriptions Default Flow ControlTftp Tab Field Descriptions Baud Rate 302 Iolan SDS/SCS/STS User’s Guide, Version Controlling the RPS, I/O Channels, and IPsec Tunnels State Button Management profile settingsRPS Control Plug Control OK Button Closes the window Power Plug Status Serial Port Power ControlButton Serial port Deactivate Output Manually deactivates the channel output IPsec Tunnel Control 308 Iolan SDS/SCS/STS User’s Guide, Version Saving Configuration Files System Administration ChapterManaging Configuration Files Downloading Configuration Files Downloading Configuration Files to Multiple IOLANs Reboot Server Specifying a Custom Factory Default Configuration Uploading Configuration FilesLess than 3 seconds-Reboots the Iolan Calibrating Analog Input Downloading Iolan FirmwareCalibrating I/O Calibrating Voltage Calibrating Thermocouple Calibrating Temperature InputCalibrating Analog Channels Calibrating RTD Resetting Calibration Data Rebooting the Iolan Setting the IOLAN’s Date and TimeResetting the Iolan to Factory Defaults Language Support Resetting the SecurID Node SecretLoading a Supplied Language Software Upgrades and Language Files Translation Guidance Downloading Terminal Definitions Creating Terminal Definition Files Resetting Configuration Parameters For example Lost Admin Password Configuring a Slave Gateway Configuring ModbusConfiguring a Master Gateway Applications Modbus Master Gateway Modbus Gateway SettingsModbus Slave Gateway Modbus Slave UID Modbus Serial Port SettingsModbus Master Settings Master Gateway Serial EIA-232 Modbus Master Slave Gateway Modbus Slave SettingsSerial Port EIA-422/485 Modbus Master Modbus Slave UID Configuring PPP Dial On Demand 172.16.0.0 Setting Up Printers Remote Printing Using LPD Remote Printing Using RCP Remote Printing Using Host-Based Print Handling Software Configuring a Virtual Private Network IOLAN-to-Host/Network Or just Network-to-Network 172.16.45.84 192.168.45.87 192.168.45.12 Gateway Router Host-to-HostLeft External IP Address Right 172.16.45.99 332 Iolan Device Server User’s Guide, Version VPN Client-to-Network VPN Client Initiate Communication Router Broadband Right 334 Iolan Device Server User’s Guide, Version Radius and TACACS+ Appendix a Supported Radius Parameters PPP User level. See Perle Radius Dictionary Example Accounting Message Mapped Radius Parameters to Iolan Parameters Radius Parameter Iolan Parameter Perle Radius Dictionary Example Value Accessing the Iolan Through a Serial Port Users TACACS+ Name Values Description Slip Accessing the Iolan from the Network Users Accessing the Iolan from the Network User Example Settings SSL/TLS Ciphers Valid SSL/TLS Ciphers DES-CBC-MD5 Commands Virtual Modem Initialization Commands AT&Rn AT&SnAT&Cn Serial Pinouts Pinouts and Cabling DiagramsDB25 Male DB25 Female RJ45 RJ45 SCS48C/SCS32C/SCS16C/SCS8C DB9 Male Serial Only Power Over Ethernet Pinouts DB9 Male I/O DB25 Male EIA-232 Cabling DiagramsTerminal DB25 Connector DB25 Female DB9 Male RJ4510-pin Pin Modem DB25 Connector Iolan RJ45 DCE RxD TxD DTR 20 DTR GND 360 Iolan SDS/SCS/STS User’s Guide, Version Setting Jumpers Port Iolan DB25 Male/Female Port Iolan RJ45 P Power Over Ethernet Port Iolan RJ45 Port Iolan DB9 Port Iolan SDS1M Modem Port Iolan Port Desktop Iolan Port/Line # Line Termination 5V Output Input Volt Output Digital I/O Module Analog Input Module 368 Iolan SDS/SCS/STS User’s Guide, Version Digital Input Wet Contact Wiring I/O DiagramsDigital I/O Digital Input Dry Contact Digital Output Sink Digital Output Source Current Analog InputVoltage RTD 3-Wire Temperature InputRTD 2-Wire Thermocouple Normally Open Contact RTD 4-WireRelay Output Normally Closed Contact 374 Iolan SDS/SCS/STS User’s Guide, Version Utilities TruePort API Request Format API I/O Access Over TruePortAPI Response Format Error Codes Decoder 378 Iolan SDS/SCS/STS User’s Guide, Version Accessories Installing a Perle PCI Card Installing a Perle PCI Card Accessories Starter Kit Adapters/Cable RJ45F to DB25M DTE Crossover Adapter RJ45F to DB25M DCE Modem Adapter RJ45F to DB25F DTE Crossover Adapter RJ45F DB25F RJ45F to DB9M DTE Crossover Adapter Sun/Cisco RJ45M Connector Cable for Rack Mount Models RJ45F to DB9F DTE Crossover Adapter SCS48C/SCS32C/SCS16C/SCS8C Starter Kit Adapters/Cable GND DTR 20 DTR DSR RJ45F to DB25F DTE Crossover Adapter 390 Iolan SDS/SCS/STS User’s Guide, Version Sun/Cisco Roll-Over Adapter for Rack Mount Models RJ45F 392 Iolan SDS/SCS/STS User’s Guide, Version Power/Ready LED stays red after a boot TroubleshootingHardware Troubleshooting Power/Ready LED on a rack mount model flashes red DeviceManager Problems Communication IssuesGeneral communication checks and practices are as follows Host Problems Radius Authentication Problems Login Problems Problems with Terminals Language Problems DHCP/BOOTP ProblemsCallback Problems You observe Tftp errors when the Iolan boots, for example Printing Problems Modem ProblemsPPP Problems Long Reboot Cycle Could not obtain peers certificate Certificate did not match configurationModels An A4R2 model is starting/stopping IPv6 Issues Contacting Technical Support Making a Technical Support Query Repair Procedure Feedback on this Manual Glossary Authentication Dial Users Services Reverse Connection PAP PasswordAuthentication Protocol Radius Remote RIP Routing Index API Ldap Radius Index W