T r o d u c t i o n, Chapter | Digi 90000566_H specification

Digi Connect Products and Families to Which This Book Applies

Chapter 1

I n t r o d u c t i o n

This book describes the commands in the command-line interface for several Digi product families, listed below. This chapter provides the following:

•A quick reference showing the commands used to configure features or perform configuration tasks from the command line.

•Basic information that applies to all commands, including navigation and editing keys, displaying online help, abbreviating commands, syntax conventions, and entering special characters in string values.

•How to access the command line.

•How to configure an IP address for a Digi device from the command line, if an address has not already been assigned.

•Information about user models and user permissions in Digi Connect products, and how they affect the commands you can issue.

Digi Connect Products and Families to Which This Book Applies

This manual documents the command-line interface for the following Digi products:

•The Digi Connect Family, which includes these products:

•Digi Connect SP

•Digi Connect Wi-SP

•Digi Connect ME

•Digi Connect Wi-ME

•Digi Connect EM

•Digi Connect Wi-EM

•Digi Connect ES Family (Digi Connect ES 4/8/16 devices)

•Connectport TS 8

•ConnectPort TS 8 MEI

•The Digi Cellular Family, which includes these products:

•Digi Connect WAN

•Digi Connect WAN VPN

•ConnectPort WAN VPN

•Digi Connect WAN IA

•Digi Connect WAN Sync

•The ConnectPort X Family, which includes these products:

•ConnectPort X8

•ConnectPort Display

Chapter 1 Introduction

7

Image 7

Digi 90000566_H manual T r o d u c t i o n, Chapter

Contents

Digi Connect Family Page Chapter Introduction Chapter Command Descriptions Contents Who 258 Modem Emulation CommandsIndex 271 Contents Chapter T r o d u c t i o n Quick Reference for Configuring Features Quick Reference for Configuring FeaturesFeature/Task Commands Guide Feature/Task Commands Configure an IP Address Access the Command LineAccess the Command Line Basic Command Information Length Limitations on String Values Entering Special Characters in String ValuesEscape Processed as Sequence Escape Sequences for Special Characters Two-user Model User Models and User Permissions in Digi Connect ProductsIdentifying the User Model for Your Digi Connect Product One-user Model Increasing Security for Digi Device Users Login Suppression Feature User Models and User Permissions in Digi Connect Products Verifying Device Support for Commands Verifying Device Support for Commands From=serveripaddressfilename To=serveripaddressfilename Host ip address BootLoad file See also Examples Close Session Type Default Escape KeysConnection number Serial port Ip address Dhcpserver Display Dhcp server status Reserved inactive Assigned activeAssigned expired Reserved active Set dhcpserver on Offered pre-leaseReleased Unavailable Address Display Arp Options AccesscontrolBuffers Memory DeviceDdns Gpio Spd SwitchesSerial Sockets Display Virtual Private Network VPN status information Display device information Primary dns addr OutputState Ip address Reset status Non-administrative Last reset reasonNo service Administrative Session consecutive failures Lcp echo requestsSession successes Session failures Total bypasses Total link down requests Server Display buffersTail=number Tftp=serverfilename Output multi-port buffering information to a Tftp server Set buffer onDisplay port buffering information on the screen Output buffering information to a Tftp server Exit Displaying Online Help on Help and ? help and ? Ethernet InfoIcmp Displays statistics from the UDP table Displays statistics from the wireless Ethernet wlan tableStatistics, see Output on Displays statistics from the TCP table Ethernet statistics Statistic DescriptionIcmp statistics IP statistics Serial statistics UDP statistics TCP statistics Wireless Wlan statistics Display Icmp statistics Range KillConnection id Binary=onoff OptionsCrmod=onoff Id=number NewpassName=string Size=bytes IpaddressCount=0n Interval=milliseconds Provision Manually provision the module for a SIP-only network Given youEnter phone numbers as numbers only with no dashes Display current provisioning parameters Min=mobile ID number Spc=service programming code MSLNai=network access id Mdn=mobile directory number Hass=host agent shared secret Ha=home addressPriha=primary host agent IP address Secha=secondary host agent IP address Type=otasp Type=iotaOtaspnumber= Otasp number for example, *228 Program args Tftp server ipfilename Quit =serial port s=session Time Revert multiple settingsAuth command. The revert auth command revert authentication Revert Autoconnect port=range AlarmOptions all Auth Host LoginEkahau Forwarding Profile port=range ServicePmodem port=range Pppoutbound port=range Wireless Vpn allglobaltunnelphase1phase2Phase1 Phase2 User=user name -luser name Options Esc Send Autoaddsubnets=onoff Set accesscontrolOptions Enabled=onoff Off Subnmask1-32= mask Subnets will be allowed to access this device serverNetmask 255.255.255.0 to access this device server Subnip1-32=ipaddress Devices supported Purpose Required permissions Syntax Set alarmConfigure alarms with general options applies to all alarms Configure alarms for a range set multiple alarms Configure alarms based on mobile temperature Configure alarms based on data pattern matchingConfigure alarms based on mobile signal strength GSM Configure alarms based on signal strength Cdma Cwm=onoff State= onoffMailserverip=ipaddress From=string Cc=string To=string Highpins=list of highpins Pins=list of pinsLowpins=list of lowpins Mode=match Reminder=onoffReminderinterval=seconds Triggerinterval=seconds Time=max time Celldata=byte count threshold Mode=mobileunavail Mode=configchangeMode=mobiletemp Mode=1xevdounavail Enable alarm #1 Error conditions triggering alarmsSet alarm #1 mode to Gpio mode Set alarm #1 to designate which pins trigger alarm Gpio input, Gpio output, or standard serial Set alarm Turn alarm #10 onSet snmp on Set autoconnect Trigger=alwaysdatadcddsrstring Service=rawrloginssltelnetRlogin State=onoff Ipport=ipport Nodelay=onoffDescription=string Ipaddress=ipaddress Set tcpserial on Network IP destination when data arrives on the serial portSet network on Set serial on Set bsc Baud rate State=disabledenabledSerialmode=bisync3270bisync3275 Baudrate=baud rateexternalclock Selectionaddress=0x followed by 2 hex digits Codeset=asciiebcdicTextconversion=onoff Pollingaddress=0x followed by 2 hex digits Rxtimeout=milliseconds Noresponsemessage=0x followed by up to 64 hex digits Poweronmessage=0x followed by up to 64 hex digitsTxretries option Port Options ClearSize Pause On mode and the buffer size to 64 kilobytesData will not be buffered and all data will be cleared from Buffer Ddnsupdater=read Update requests will be rejectedRegistered with that service For a user to display Dynamic DNS settings set permissions Updatenow Service=disableddyndnsorgDisabled Action=updatenowclearstatus Securehttp Ddpassword=passwordStandardhttp Alternatehttp Nochg Dynamic DNS serviceDisplay on Set dhcpserver set dhcpserver User interface’s Network Configuration settingsCommand. See dhcpserver on For a user to display Dhcp server settings set permissions Revert Item=scopeAction=setrevert Set Leasetime=timeinfinite Offerdelay=0-5000Startip=ip address Endip=ip address Clientid=client MAC address Item=reservationRange=1-16all Ip=ip address Range=1-4all Item=exclusionFirst address in the exclusion block Is, reservations override exclusions Using the web UIDisable all reservations that were previously added IP address, which is the purpose of a reservation 102 Command Descriptions Dhcpserver on Web user interface, the online help for Network SettingsDhcp terminology and managing Dhcp server operation Proprietary hardware components Wireless deviceSet ekahau set ekahau Digi Connect Wi-EM only Server=hostnameip address Id=device idName=device name Set identifiers Enable Ekahau Client Full Set ethernetOptions Duplex Half 100 Speed Privileges Set forwarding Add Options ipforwarding=onoffStaticrouteindex=1-8 Action=addchangedelete Metric=1-16 Net=destination ip addressMask=subnet mask Gateway=ip address Routing information Settings under Network ConfigurationSet nat on Mode=serialinputoutput Set gpioDevices supported Purpose Options Range=1-n Default serial signal settings for Gpio pins Pin Number Default Serial Signal Signal DirectionSignals Messages or Snmp traps when Gpio pins change Id=range Set groupOptions Add Remove Name= string Commandline=onoffDefaultaccess=nonecommandlinemenu Commandline Permissions Examples Default Options Name=name Device support Set ia Configure network-based masters set ia master Configure serial-port connected devices set ia serial Serial options Instead of a set ia command with no optionsSerial settings, which include Serial= range Table=1..8 applies to master only Slavetimeout=10-99999 ms applies to slave onlyChartimeout=3-99999 ms applies to master or slave Idletimeout=0=disabled1-99000 seconds Medium Priority=highmediumlow Modbus options Type=tcpudp Modbusrtu Modbusascii Modbustcp Messagetimeout=100-99000 msChartimeout=3-99000 ms Master=range 126 Command Descriptions Route options Table optionsAddroute=route index Moveroute=fromrouteindex,torouteindex Port=serial port Mapto=protocol address Existing IA configuration settings Settings for the Digi Connect WAN IAConfiguration settings in the Web user interface Revert on page 61. The revert ia command options revert any Options Suppress=onoff Set login Quitkey=key Presskeylabel=string Quitlabel=stringPreviouskey=key Previouslabel=string Label Title=string subtitle=stringSortby=nonekeylabel Key Item=1-32 Direction=horizontalverticalHorizontal Vertical Contains spaces, enclose it in double quotes Command=stringSubmenu=string Menu displayed to the user upon selecting the menu item Set mgmtconnection Immediate Lkaupdateenabled=onoffTimedperiod=period Timedoffset=immediateoneperiodrandomtime Set values for the client connection Clntreconntimeout=nonetimeoutRetry timeout interval feature Display current connection settings Options Deviceid=hex string Settings set permissions s-mgmtglobal=rwSet mgmtglobal Set permissions s-mgmtglobal=read Tcpnodelayenabled=onoff Rcicompressionenabled=onoffTcpkeepalivesenabled=onoff Revertdeviceid Connidletimeout=nonetimeout value 802.11 Set mgmtnetworkOptions Networktype=modempppethernet802.11 Modemppp Mdh Proxylogin=stringProxypassword=string Connectionmethod=autononemtmdhproxy Mdhwaitcount=count Mtwaitcount=countMdhrxkeepalive=time Mdhtxkeepalive=time Supported are Protocol forwarding settingsSettings set permissions s-router=rw Set nat set nat Prnumber1-4=greesp Prenabled1-4=onoffPoenabled1-64=onoff Maxentries=64-1024 Pointernal1-64=number of ports in range, minimum Poproto1-64=tcpudpPocount=1-64=number of ports in range, minimum Poexternal1-64=number of ports in range, minimum Where Setting user permissions for commandsSet network Network level Submask=device submask Ip address optionsIp=device ip address Gateway=gateway ip TCP retransmit options TCP keepalive options Arpttl=1-20 minutes ARP optionsGarp=30-3600 seconds Set passthrough Remote Device Management and IP Pass-through Using Pinholes to Manage the Digi Cellular Family Device Telnet=passterminate Options State=enableddisabledHttp=passterminate Https=passterminate Surelink=passterminate Connectware=passterminatePing=passterminate Permission descriptions Set permissionsOn page 14 for more information Help Set permissions Self Backup=noneexecuteBoot=noneexecute Execute Dhcpserver=noneexecute Rlogin=noneexecuteAccesscontrol=nonereadrw Connect=noneexecute Autoconnect=noner-selfreadrw-selfw-self-rrw Alarm=nonereadrwDdnsupdater=nonereadrw Login=nonereadrw Ppp=nonereadrw Service=nonereadrwPermissions=nonereadrw Pmodem=noner-selfreadrw-selfw-self-rrw Status=nonereadrw User=nonereadrwVpn=nonereadrw Wlan=nonereadrw Display modem-emulation settings Enables modem emulationDisables modem emulation Configure modem emulation Specific commands for modem-emulation configurations Enables Telnet processingDisables Telnet processing Modem Emulation Commands for descriptions of Digi Set pppoutbound Both Authmethod=nonePAPCHAPbothPap Chap Addresscompression=onoff Defaultgateway=yesnoAddressmask=ip address mask Protocolcompression=onoff 000A0000 Lcpkeepalive=onoffLcpkaquiettime=10-86400 seconds Asyncmap=hex string N1-4=phonenumber Dialscript=chat script Loginscript=chat scriptIpcpdnsenabled=onoff Display pppstats command displays the current status of PPP Option’s description Or displays the current port-profile settingsPort as a console to access the command line interface Set profile set profile Consolemanagement LocalconfigOptions Port=port Profile=profile Tunneling TcpsocketsUdpsockets Set putty Displays current terminal-emulation settingsFor it to process Keyboardport=/com/0/com/1No Keyboard Width=80132Height=10-60 Hostport=/com/0/com/1/vcom/0 Blinkcursor=onoff Cursortype=noneblockunderlineverticalBlock Underline Characterset=host charset Character Set name Description Set putty Complete list of allowed character sets is Key mapping terminal emulation options Outseq=00-FF Deletekeymaprange=1-32Keymaprange=1-32 Inseq=00-FF One enter Emulation settingsWould enter Now, to delete the first 2 entries Set python Command=filenameOptions Range=1 Options State Options Keepalive=onoff Set realportExclusive=onoff Probecount, probeinterval, garbagebyte, and overridedhcp Set service keepalive=onoff, or clients such as autoconnect Set rtstoggle Postdelay=delay Predelay=delay Altpin=onoff Set serial Hardware Baudrate=bpsCsize=5678 Flowcontrol=hardwaresoftwarenone Options Range= range Set serviceIpport=network port Delayedack=0-1000 Base network port number + serial port number Port Number Service Services Provided Network Command Descriptions 195 Index numbers and changing default port numbers Device is configured for IP passthrough Service tableSet surelink on Privatecommunity=string Setsenabled=onoffOptions Trapdestip=ipaddress Publiccommunity=string Linkuptrap=onoff Logintrap=onoffAuthfailtrap=onoff Coldstarttrap=onoff End initiated the tunnel Configure a socket tunnelDisplay current socket tunnel settings Set sockettunnel Toport=port number Fromport=port number TCP Connection Test Connection-failure settings can be disabled as wellSet surelink set surelink Ping Test Options for Hardware reset thresholds Moduleresetconnectfailures=1-2550=offSystemresetconnectfailures=1-2550=off Display current SureLink settings Ping Test=pingtcpdns Trigger=intervalidle DnsInterval Dnsfqdn2=dns fqdn Interval=10-65535Ipport=1-65535 Dnsfqdn1=dns fqdn Statistics on page 35 for descriptions of these statistics Display pppstats command displays connection and activity Used Set switches set switchesConfigure MEI settings Display current MEI settings 232 Wires=twofourOptions Range=range Mode=232485 Set switches configuration Display on page 27. The display switches command displaysCurrent switch settings Revert on page 61. The revert switches command reverts Contact=string Set systemOptions Description=string Location=string For a user to display the TCP serial settings for any line Serial settingsThis command affects the following TCP serial connections Connections made using the autoconnect feature Sidstring=socketid string Revert on Show on Sendtime=01-65535msEndpattern=string Strippattern=onoff Set term Command line of the deviceConfigure terminal settings Display current terminal settings Are logged in set permissions s-udpserial=r-self Another service, the data will be sent to the serial portFor a user to display the UDP serial settings for any line Connect WAN and ConnectPort Display Sendcount= bytes Port= rangeSendtime=0 time Clostime=time Sidstring=stringRange=1-64 Data to be sent on to the network destination UDP serial settingsUDP port of the destination to which data is sent Identifies the range of UDP destinations to be displayed For a user to display and set user configuration attributes Change user configuration attributesDisplay user configuration attributes For a user to display user configuration attributes Disassociate Maximum of 32 users can be definedAssociate Two groups Gid=number Groupaccess=onoffUser cannot use group access rights Default is off User is not allowed to access the custom menu interface Gid Defaultaccess=nonecommandlinemenugroupDefaultgroup=nonegidgname Group Tftphostfilename Publickey=tftphostfilenameclearTftphost Splashtime=0-30 seconds Set video Server=vnc server ipaddrdns name Password=vnc server passwordPort=vnc server network port Server services are enabled and disabled by the set service Configured globallyRemote Access VNC Client Settings VPN Settings and VPN Tunnel Settings Security associations SAs Display current VPN settings Set IKE/ISAKMP SA Phase 2 Options Set IKE/ISAKMP SA Phase 1 OptionsDisplay current VPN settings Identity=fqdnuser fqdnip address Dhgroup=125 Identity=ip-addressPfs=onoff Name=tunnel name Tunnel optionsNewname=tunnel name Inboundspi=256 Remotevpnendpoint=fqdnip addressManually-keyed options Mode=manually-keyed Inboundauthkey=ascii keyhex key Inboundauthentication=nonemd5sha1Md5 Sha1 Outboundauthkey=ascii keyhex key Outboundauthentication=nonemd5sha1Inboundenckey=ascii keyhex key Outboundspi=256 Sharedkey=ascii keyhex key Encryption Authentication SA LifetimeIsakmp options Mode=isakmp Sharedkey Set vpn phase1Authentication=md5sha1 Authmethod=sharedkeydssrsa Tunnel=1-2 Set vpn phase2Salifetime=10-232 Salifetimedata=0-232 Salifetimedata=0 232 kilobytes Authentication=nonemd5sha1Encryption=nonedes3desaes Salifetime=60-232 Settings ConfiguringSet wlan PSK Authentication methods and associated data fields Inner and outer protocols Configure wireless settings Ssid=string Wpapsk Authentication=Open Wepauth Ccmp Encryption=open,wep,tkip,ccmp,anyWep Tkip Otp Password=stringGtc Mschapv2 WepkeyN=hex string Psk=string Show Issued to the deviceUser permissions for commands Settings... column to go to the command descriptions Show Command Descriptions 251 Display network configuration settings Configuration table entry or range of entriesDisplay settings for a particular user Command Descriptions 253 Session number Ip addr TelnetTcp port Connect Options StatusconnectdisconnectDisconnect Connections Management page in the Web user interface from This command enables the tunnel at index 1 to be usedSet vpn on page 228. The set vpn command configures VPN This command None at this time To set permissions who=execute to use this command. SeeWho who Displays active connections to and from the device Modes of Operation What Is Modem Emulation?Modem Emulation Cable Signals What Is Modem Emulation? Common User Scenarios for Modem Emulation User Scenario Diagram a User Scenario Diagram B Modem Emulation Pooling Connection Scenarios for Modem EmulationOutgoing Modem Emulation Connection Incoming Modem Emulation Connection Accepted But Ignored AT Commands About the Commands in this Chapter Emulation configuration scenario Modem Emulation AT Command SetFunction Result Command Code Modem Emulation Commands 265 Function Result Command Register Definitions Register Function Range Units Default Register Function Range Units Default Result Codes Emulation commandsShort Long Form 270 Modem Emulation Commands D e ESP GRE PSK Self user permission 198 Snmp