Quick Reference for Configuring Features | Digi 90000566_H specs

Quick Reference for Configuring Features

Quick Reference for Configuring Features

The following table shows common features that can be configured from the command line, and the commands used to configure each feature. If you are viewing the PDF file of this document, click the commands in the “Commands” column to go to the command descriptions.

	Feature/Task	Commands

	Alarms	"set alarm" on page 70.

	Autoconnection (automatically connect a user to	"set autoconnect" on page 81.
	a server or network device)	"set serial" on page 189.
		"set serial" on page 189.
		"set tcpserial" on page 212.

	Bisynchronous communications	"set bsc" on page 85

	Configuration management/administration	Backup/restore a configuration from a TFTP server on the
		network: "backup" on page 18.
		Update firmware: "boot" on page 19.
		Reset configuration to factory defaults: "revert" on page
		61; or boot action=factory (see "boot" on page 19).
		Reboot the device: "boot" on page 19.

	Connectware Manager/Remote Management:	"set mgmtconnection" on page 137.
	Connectware Device Protocol configuration	"set mgmtglobal" on page 140.
	settings	"set mgmtglobal" on page 140.
	settings	"set mgmtnetwork" on page 143.
		"set mgmtnetwork" on page 143.

	Custom menus	"set menu" on page 132.

	DHCP (Dynamic Host Configuration Protocol)	To configure a DHCP server: "set dhcpserver" on page 96.
		To manage and show status of a DHCP server:
		"dhcpserver" on page 23.

	Display current configuration settings in a device	"show" on page 249.

	Dynamic DNS (DDNS)	"set ddns" on page 92.

	Ekahau Client™ device-location software	"set ekahau" on page 104

	Ethernet settings for wired devices	"set ethernet" on page 107.

	General Purpose Input/Output (GPIO) pins	"set gpio" on page 113.
		"set alarm" on page 70.

	Help on device commands	"help and ?" on page 40.

	Host name for a device (Specify a name for the	"set host" on page 118.
	device)

	Industrial Automation (IA)	• “set profile profile=ia” See "set profile" on page 172.
		• "set ia" on page 119.
		• For additional information on configuring Industrial
		Automation, see this web site:
		http://www.digi.com/support/ia

	IP address settings	"set network" on page 149.

8	Chapter 1 Introduction

Image 8

Digi 90000566_H manual Quick Reference for Configuring Features, Feature/Task Commands

Contents

Digi Connect Family Page Chapter Command Descriptions Chapter Introduction Contents Index 271 Modem Emulation CommandsWho 258 Contents T r o d u c t i o n Chapter Feature/Task Commands Quick Reference for Configuring FeaturesQuick Reference for Configuring Features Guide Feature/Task Commands Access the Command Line Access the Command LineConfigure an IP Address Basic Command Information Entering Special Characters in String Values Escape Processed as SequenceEscape Sequences for Special Characters Length Limitations on String Values User Models and User Permissions in Digi Connect Products Identifying the User Model for Your Digi Connect ProductOne-user Model Two-user Model Login Suppression Feature Increasing Security for Digi Device Users User Models and User Permissions in Digi Connect Products Verifying Device Support for Commands Verifying Device Support for Commands To=serveripaddressfilename From=serveripaddressfilename Load file BootHost ip address Examples See also Connection number Session Type Default Escape KeysClose Serial port Dhcpserver Ip address Display Dhcp server status Assigned active Assigned expiredReserved active Reserved inactive Offered pre-lease ReleasedUnavailable Address Set dhcpserver on Display Buffers Options AccesscontrolArp Device DdnsGpio Memory Switches SerialSockets Spd Display device information Display Virtual Private Network VPN status information Output StateIp address Primary dns addr Reset status Last reset reason No serviceAdministrative Non-administrative Lcp echo requests Session successesSession failures Session consecutive failures Total link down requests Total bypasses Display buffers Tail=numberTftp=serverfilename Server Set buffer on Display port buffering information on the screenOutput buffering information to a Tftp server Output multi-port buffering information to a Tftp server Exit Help and ? help and ? Displaying Online Help on Icmp InfoEthernet Displays statistics from the wireless Ethernet wlan table Statistics, see Output onDisplays statistics from the TCP table Displays statistics from the UDP table Icmp statistics Statistic DescriptionEthernet statistics IP statistics Serial statistics TCP statistics UDP statistics Wireless Wlan statistics Display Icmp statistics Connection id KillRange Crmod=onoff OptionsBinary=onoff Name=string NewpassId=number Ipaddress Count=0nInterval=milliseconds Size=bytes Provision Given you Enter phone numbers as numbers only with no dashesDisplay current provisioning parameters Manually provision the module for a SIP-only network Spc=service programming code MSL Nai=network access idMdn=mobile directory number Min=mobile ID number Ha=home address Priha=primary host agent IP addressSecha=secondary host agent IP address Hass=host agent shared secret Otaspnumber= Otasp number for example, *228 Type=iotaType=otasp Tftp server ipfilename Program args Quit =serial port s=session Revert multiple settings Auth command. The revert auth command revert authenticationRevert Time Alarm Options allAuth Autoconnect port=range Login EkahauForwarding Host Service Pmodem port=rangePppoutbound port=range Profile port=range Vpn allglobaltunnelphase1phase2 Phase1Phase2 Wireless Options Esc User=user name -luser name Send Set accesscontrol Options Enabled=onoffOff Autoaddsubnets=onoff Subnets will be allowed to access this device server Netmask 255.255.255.0 to access this device serverSubnip1-32=ipaddress Subnmask1-32= mask Set alarm Configure alarms with general options applies to all alarmsConfigure alarms for a range set multiple alarms Devices supported Purpose Required permissions Syntax Configure alarms based on data pattern matching Configure alarms based on mobile signal strength GSMConfigure alarms based on signal strength Cdma Configure alarms based on mobile temperature State= onoff Mailserverip=ipaddressFrom=string Cwm=onoff Cc=string To=string Lowpins=list of lowpins Pins=list of pinsHighpins=list of highpins Reminder=onoff Reminderinterval=secondsTriggerinterval=seconds Mode=match Celldata=byte count threshold Time=max time Mode=configchange Mode=mobiletempMode=1xevdounavail Mode=mobileunavail Error conditions triggering alarms Set alarm #1 mode to Gpio modeSet alarm #1 to designate which pins trigger alarm Enable alarm #1 Set snmp on Set alarm Turn alarm #10 onGpio input, Gpio output, or standard serial Set autoconnect Service=rawrloginssltelnet RloginState=onoff Trigger=alwaysdatadcddsrstring Nodelay=onoff Description=stringIpaddress=ipaddress Ipport=ipport Network IP destination when data arrives on the serial port Set network onSet serial on Set tcpserial on Set bsc State=disabledenabled Serialmode=bisync3270bisync3275Baudrate=baud rateexternalclock Baud rate Codeset=asciiebcdic Textconversion=onoffPollingaddress=0x followed by 2 hex digits Selectionaddress=0x followed by 2 hex digits Rxtimeout=milliseconds Txretries option Poweronmessage=0x followed by up to 64 hex digitsNoresponsemessage=0x followed by up to 64 hex digits Size Options ClearPort On mode and the buffer size to 64 kilobytes Data will not be buffered and all data will be cleared fromBuffer Pause Update requests will be rejected Registered with that serviceFor a user to display Dynamic DNS settings set permissions Ddnsupdater=read Service=disableddyndnsorg DisabledAction=updatenowclearstatus Updatenow Ddpassword=password StandardhttpAlternatehttp Securehttp Display on Dynamic DNS serviceNochg User interface’s Network Configuration settings Command. See dhcpserver onFor a user to display Dhcp server settings set permissions Set dhcpserver set dhcpserver Item=scope Action=setrevertSet Revert Offerdelay=0-5000 Startip=ip addressEndip=ip address Leasetime=timeinfinite Item=reservation Range=1-16allIp=ip address Clientid=client MAC address First address in the exclusion block Item=exclusionRange=1-4all Using the web UI Disable all reservations that were previously addedIP address, which is the purpose of a reservation Is, reservations override exclusions 102 Command Descriptions Dhcp terminology and managing Dhcp server operation Web user interface, the online help for Network SettingsDhcpserver on Wireless device Set ekahau set ekahauDigi Connect Wi-EM only Proprietary hardware components Name=device name Id=device idServer=hostnameip address Enable Ekahau Client Set identifiers Set ethernet Options DuplexHalf Full Speed 100 Set forwarding Privileges Options ipforwarding=onoff Staticrouteindex=1-8Action=addchangedelete Add Net=destination ip address Mask=subnet maskGateway=ip address Metric=1-16 Set nat on Settings under Network ConfigurationRouting information Set gpio Devices supported PurposeOptions Range=1-n Mode=serialinputoutput Pin Number Default Serial Signal Signal Direction SignalsMessages or Snmp traps when Gpio pins change Default serial signal settings for Gpio pins Set group Options AddRemove Id=range Commandline=onoff Defaultaccess=nonecommandlinemenuCommandline Name= string Default Permissions Examples Device support Options Name=name Set ia Configure serial-port connected devices set ia serial Configure network-based masters set ia master Instead of a set ia command with no options Serial settings, which includeSerial= range Serial options Slavetimeout=10-99999 ms applies to slave only Chartimeout=3-99999 ms applies to master or slaveIdletimeout=0=disabled1-99000 seconds Table=1..8 applies to master only Priority=highmediumlow Medium Modbus options Modbusrtu Modbusascii Modbustcp Messagetimeout=100-99000 ms Chartimeout=3-99000 msMaster=range Type=tcpudp 126 Command Descriptions Table options Addroute=route indexMoveroute=fromrouteindex,torouteindex Route options Port=serial port Mapto=protocol address Settings for the Digi Connect WAN IA Configuration settings in the Web user interfaceRevert on page 61. The revert ia command options revert any Existing IA configuration settings Set login Options Suppress=onoff Quitkey=key Quitlabel=string Previouskey=keyPreviouslabel=string Presskeylabel=string Title=string subtitle=string Sortby=nonekeylabelKey Label Direction=horizontalvertical HorizontalVertical Item=1-32 Command=string Submenu=stringMenu displayed to the user upon selecting the menu item Contains spaces, enclose it in double quotes Set mgmtconnection Lkaupdateenabled=onoff Timedperiod=periodTimedoffset=immediateoneperiodrandomtime Immediate Clntreconntimeout=nonetimeout Retry timeout interval featureDisplay current connection settings Set values for the client connection Settings set permissions s-mgmtglobal=rw Set mgmtglobalSet permissions s-mgmtglobal=read Options Deviceid=hex string Tcpkeepalivesenabled=onoff Rcicompressionenabled=onoffTcpnodelayenabled=onoff Connidletimeout=nonetimeout value Revertdeviceid Set mgmtnetwork Options Networktype=modempppethernet802.11Modemppp 802.11 Proxylogin=string Proxypassword=stringConnectionmethod=autononemtmdhproxy Mdh Mtwaitcount=count Mdhrxkeepalive=timeMdhtxkeepalive=time Mdhwaitcount=count Protocol forwarding settings Settings set permissions s-router=rwSet nat set nat Supported are Prenabled1-4=onoff Poenabled1-64=onoffMaxentries=64-1024 Prnumber1-4=greesp Poproto1-64=tcpudp Pocount=1-64=number of ports in range, minimumPoexternal1-64=number of ports in range, minimum Pointernal1-64=number of ports in range, minimum Setting user permissions for commands Set networkNetwork level Where Ip address options Ip=device ip addressGateway=gateway ip Submask=device submask TCP keepalive options TCP retransmit options Garp=30-3600 seconds ARP optionsArpttl=1-20 minutes Set passthrough Using Pinholes to Manage the Digi Cellular Family Device Remote Device Management and IP Pass-through Options State=enableddisabled Http=passterminateHttps=passterminate Telnet=passterminate Ping=passterminate Connectware=passterminateSurelink=passterminate Set permissions On page 14 for more informationHelp Permission descriptions Set permissions Backup=noneexecute Boot=noneexecuteExecute Self Rlogin=noneexecute Accesscontrol=nonereadrwConnect=noneexecute Dhcpserver=noneexecute Alarm=nonereadrw Ddnsupdater=nonereadrwLogin=nonereadrw Autoconnect=noner-selfreadrw-selfw-self-rrw Service=nonereadrw Permissions=nonereadrwPmodem=noner-selfreadrw-selfw-self-rrw Ppp=nonereadrw User=nonereadrw Vpn=nonereadrwWlan=nonereadrw Status=nonereadrw Enables modem emulation Disables modem emulationConfigure modem emulation Display modem-emulation settings Enables Telnet processing Disables Telnet processingModem Emulation Commands for descriptions of Digi Specific commands for modem-emulation configurations Set pppoutbound Authmethod=nonePAPCHAPboth PapChap Both Defaultgateway=yesno Addressmask=ip address maskProtocolcompression=onoff Addresscompression=onoff Lcpkeepalive=onoff Lcpkaquiettime=10-86400 secondsAsyncmap=hex string 000A0000 N1-4=phonenumber Loginscript=chat script Ipcpdnsenabled=onoffDisplay pppstats command displays the current status of PPP Dialscript=chat script Or displays the current port-profile settings Port as a console to access the command line interfaceSet profile set profile Option’s description Localconfig Options Port=portProfile=profile Consolemanagement Udpsockets TcpsocketsTunneling For it to process Displays current terminal-emulation settingsSet putty Width=80132 Height=10-60Hostport=/com/0/com/1/vcom/0 Keyboardport=/com/0/com/1No Keyboard Cursortype=noneblockunderlinevertical BlockUnderline Blinkcursor=onoff Characterset=host charset Set putty Complete list of allowed character sets is Character Set name Description Key mapping terminal emulation options Deletekeymaprange=1-32 Keymaprange=1-32Inseq=00-FF Outseq=00-FF Emulation settings Would enterNow, to delete the first 2 entries One enter Options Range=1 Command=filenameSet python Options State Exclusive=onoff Set realportOptions Keepalive=onoff Set service keepalive=onoff, or clients such as autoconnect Probecount, probeinterval, garbagebyte, and overridedhcp Set rtstoggle Predelay=delay Postdelay=delay Set serial Altpin=onoff Baudrate=bps Csize=5678Flowcontrol=hardwaresoftwarenone Hardware Ipport=network port Set serviceOptions Range= range Delayedack=0-1000 Base network port number + serial port number Service Services Provided Network Port Number Command Descriptions 195 Index numbers and changing default port numbers Set surelink on Service tableDevice is configured for IP passthrough Setsenabled=onoff Options Trapdestip=ipaddressPubliccommunity=string Privatecommunity=string Logintrap=onoff Authfailtrap=onoffColdstarttrap=onoff Linkuptrap=onoff Configure a socket tunnel Display current socket tunnel settingsSet sockettunnel End initiated the tunnel Fromport=port number Toport=port number Connection-failure settings can be disabled as well Set surelink set surelinkPing Test TCP Connection Test Moduleresetconnectfailures=1-2550=off Systemresetconnectfailures=1-2550=offDisplay current SureLink settings Options for Hardware reset thresholds Test=pingtcpdns Ping Interval DnsTrigger=intervalidle Interval=10-65535 Ipport=1-65535Dnsfqdn1=dns fqdn Dnsfqdn2=dns fqdn Display pppstats command displays connection and activity Statistics on page 35 for descriptions of these statistics Set switches set switches Configure MEI settingsDisplay current MEI settings Used Wires=twofour Options Range=rangeMode=232485 232 Display on page 27. The display switches command displays Current switch settingsRevert on page 61. The revert switches command reverts Set switches configuration Set system Options Description=stringLocation=string Contact=string Serial settings This command affects the following TCP serial connectionsConnections made using the autoconnect feature For a user to display the TCP serial settings for any line Sidstring=socketid string Sendtime=01-65535ms Endpattern=stringStrippattern=onoff Revert on Show on Command line of the device Configure terminal settingsDisplay current terminal settings Set term Another service, the data will be sent to the serial port For a user to display the UDP serial settings for any lineConnect WAN and ConnectPort Display Are logged in set permissions s-udpserial=r-self Sendtime=0 time Port= rangeSendcount= bytes Range=1-64 Sidstring=stringClostime=time UDP serial settings UDP port of the destination to which data is sentIdentifies the range of UDP destinations to be displayed Data to be sent on to the network destination Change user configuration attributes Display user configuration attributesFor a user to display user configuration attributes For a user to display and set user configuration attributes Maximum of 32 users can be defined AssociateTwo groups Disassociate Groupaccess=onoff User cannot use group access rights Default is offUser is not allowed to access the custom menu interface Gid=number Defaultaccess=nonecommandlinemenugroup Defaultgroup=nonegidgnameGroup Gid Tftphost Publickey=tftphostfilenameclearTftphostfilename Set video Splashtime=0-30 seconds Port=vnc server network port Password=vnc server passwordServer=vnc server ipaddrdns name Remote Access VNC Client Settings Configured globallyServer services are enabled and disabled by the set service VPN Settings and VPN Tunnel Settings Display current VPN settings Security associations SAs Display current VPN settings Set IKE/ISAKMP SA Phase 1 OptionsSet IKE/ISAKMP SA Phase 2 Options Identity=fqdnuser fqdnip address Pfs=onoff Identity=ip-addressDhgroup=125 Newname=tunnel name Tunnel optionsName=tunnel name Remotevpnendpoint=fqdnip address Manually-keyed optionsMode=manually-keyed Inboundspi=256 Inboundauthentication=nonemd5sha1 Md5Sha1 Inboundauthkey=ascii keyhex key Outboundauthentication=nonemd5sha1 Inboundenckey=ascii keyhex keyOutboundspi=256 Outboundauthkey=ascii keyhex key Encryption Authentication SA Lifetime Isakmp optionsMode=isakmp Sharedkey=ascii keyhex key Set vpn phase1 Authentication=md5sha1Authmethod=sharedkeydssrsa Sharedkey Set vpn phase2 Salifetime=10-232Salifetimedata=0-232 Tunnel=1-2 Authentication=nonemd5sha1 Encryption=nonedes3desaesSalifetime=60-232 Salifetimedata=0 232 kilobytes Set wlan ConfiguringSettings Authentication methods and associated data fields PSK Configure wireless settings Inner and outer protocols Ssid=string Authentication= OpenWepauth Wpapsk Encryption=open,wep,tkip,ccmp,any WepTkip Ccmp Password=string GtcMschapv2 Otp Psk=string WepkeyN=hex string Issued to the device User permissions for commandsSettings... column to go to the command descriptions Show Show Command Descriptions 251 Display settings for a particular user Configuration table entry or range of entriesDisplay network configuration settings Command Descriptions 253 Session number Tcp port TelnetIp addr Disconnect Options StatusconnectdisconnectConnect This command enables the tunnel at index 1 to be used Set vpn on page 228. The set vpn command configures VPNThis command Connections Management page in the Web user interface from To set permissions who=execute to use this command. See Who whoDisplays active connections to and from the device None at this time What Is Modem Emulation? Modem Emulation Cable SignalsWhat Is Modem Emulation? Modes of Operation User Scenario Diagram a Common User Scenarios for Modem Emulation User Scenario Diagram B Connection Scenarios for Modem Emulation Outgoing Modem Emulation ConnectionIncoming Modem Emulation Connection Modem Emulation Pooling About the Commands in this Chapter Accepted But Ignored AT Commands Function Result Command Code Modem Emulation AT Command SetEmulation configuration scenario Modem Emulation Commands 265 Command Function Result Register Function Range Units Default Register Definitions Register Function Range Units Default Short Long Form Emulation commandsResult Codes 270 Modem Emulation Commands D e ESP GRE PSK Self user permission 198 Snmp