Digi IX20 - Page 1134

To Next Page

To Previous Page

Command lineinterface Execute a command from theweb interface

IX20 User Guide

1134

Depending on your device configuration, you may be presented with an Access selection

menu. Type admin to accessthe Admin CLI.

The Admin CLI prompt appears.

Main Page

Table of Contents9
What's New in Digi IX20 Version 23.922
Digi IX20 Quick Start23
Step 1: Connect Your Device23
Apply Dielectric Grease over SIM Contacts24
Step 2: Connect Dcpower26
Step 3: Set up Access to Digi Remote Manager26
Step 4: Register Your Device26
Step 5: Complete Setup26
Step 6: Configure Cellular APN27
Digi IX20 Hardware Reference28
Digi IX20 Features and Specifications28
IX20 Accessories28
IX20 Front View28
IX20 Leds29
Power30
Int30
Wi-Fi Service (Ix20Wmodel Only)30
Sim131
Sim231
Lte31
Signal Quality Indicators32
Ethernet Link and Activity32
Signal Quality Bars Explained33
IX20 Power Supply Requirements34
Digi IX20 Serial Connector Pinout34
Configuration for Extreme Thermal Conditions34
Qrcode Definition36
Hardware Setup38
Install SIM Cards in the Plug-In LTE Modem39
Apply Dielectric Grease over SIM Contacts40
Tips for Improving Cellular Signal Strength40
Connect Data Cables41
Mount the IX20 Device41
Attach to a Mounting Surface by Using the Mounting Tabs41
Attach to DIN Rail with Clip41
Attach to DIN Rail with Bracket42
Firmware Configuration45
Review IX20 Default Settings45
Local Webui45
Digi Remote Manager45
Default Interface Configuration45
Other Default Configuration Settings46
Primary Responder Mode47
Differences between Standard Firmware Operation and Primary Responder Mode47
Enable Primary Responder Mode47
Change the Default Password for the Admin User49
Change the Default SSID and Pre-Shared Key for the Preconfigured Wi-Fi Access Point51
Configuration Methods53
Using Digi Remote Manager53
Using the Local Web Interface54
Log out of the Web Interface55
Use the Local REST API to Configure the IX20 Device55
Use the GET Method to Return Device Configuration Information55
Use the POST Method to Modify Device Configuration Parameters and List Arrays57
Use the DELETE Method to Remove Items from a List Array58
Using the Command Line60
Access the Command Line Interface60
Log in to the Command Line Interface60
Exit the Command Line Interface61
Central Management62
Digi Remote Manager Support63
Certificate-Based Enhanced Security63
Configure Your Device for Digi Remote Manager Support63
Collect Device Health Data and Set the Sample Interval70
Enable Event Log Upload to Digi Remote Manager73
Reach Digi Remote Manager on a Private Network75
Pinhole Method75
Proxy Server Method75
VPN Tunnel Method76
Log into Digi Remote Manager76
Use Digi Remote Manager to View and Manage Your Device77
Add a Device to Remote Manager77
Add a Device to Remote Manager Using Information from the Label77
Add a Device to Remote Manager Using Your Remote Manager Login Credentials78
Configure Multiple IX20 Devices by Using Digi Remote Manager Configurations79
View Digi Remote Manager Connection Status80
Learn more81
Interfaces82
Wide Area Networks (Wans)83
Wide Area Networks (Wans) and Wireless Wide Area Networks (Wwans)84
Configure WAN/WWAN Priority and Default Route Metrics84
WAN/WWAN Failover87
Configure Surelink Active Recovery to Detect WAN/WWAN Failures88
Configure the Device to Reboot When a Failure Is Detected105
Disable Surelink118
Example: Use a Ping Test for WAN Failover from Ethernet to Cellular127
Using Ethernet Devices in a WAN130
Using Cellular Modems in a Wireless WAN (WWAN)131
Configure a Wide Area Network (WAN)157
Configure a Wireless Wide Area Network (WWAN)165
Show WAN and WWAN Status and Statistics177
Delete a WAN or WWAN178
Default Outbound WAN/WWAN Ports180
Local Area Networks (Lans)181
About Local Area Networks (Lans)182
Configure a Local Area Network (LAN)182
Configure the WAN/ETH1 Port as a LAN or in a Bridge190
Change the Default LAN Subnet199
Show LAN Status and Statistics201
Delete a LAN202
DHCP Servers204
Default Services Listening on LAN Ports221
Configure an Interface to Operate in Passthrough Mode221
Virtual Lans (Vlans)228
Create a Trunked VLAN Route229
Create a VLAN Using Switchport Mode231
Bridging234
Edit the Preconfigured ETH2 Bridge235
Configure a Bridge238
Show Surelink Status and Statistics241
Show Surelink State241
Show Surelink Status for All Interfaces242
Show Surelink Status for a Specific Interface243
Show Surelink Status for All Ipsec Tunnels243
Show Surelink Status for a Specific Ipsec Tunnel244
Show Surelink Status for All Openvpn Clients244
Show Surelink Status for a Specific Openvpn Client245
Configure a TCP Connection Timeout245
Serial Port247
Default Serial Port Configuration247
Serial Mode Options247
View Serial Port Information247
Configure Login Mode248
Configure Remote Access Mode251
Configure Application Mode268
Configure PPP Dial-In Mode270
Configure UDP Serial Mode277
Configure Modem Emulator Mode288
Configure Modbus Mode291
Configure Realport Mode Using the Digi Navigator294
Installation and Configuration Process294
Digi Navigator Features294
Install the Digi Navigator295
Configure Realport on a Digi Device from the Digi Navigator296
Digi Navigator Application Features298
Advanced Realport Configuration Without Using the Digi Navigator301
Windows Operating System301
Linux Operating System301
Download the Realport Driver301
Configure Realport on Your Laptop302
Configure the Serial Port for Realport Mode304
Configure the Realport Service307
Show Serial Status and Statistics308
Review the Serial Port Message Log308
Wi-Fi312
Wi-Fi Configuration312
Default Access Point SSID and Password312
Default Wi-Fi Configuration312
Configure the Wi-Fi Radio's Channel314
Configure the Wi-Fi Radio to Support DFS Channels in Client Mode316
Required Configuration Items316
Configure the Wi-Fi Radio's Band and Protocol318
Configure the Wi-Fi Radio's Transmit Power320
Configure an Open Wi-Fi Access Point322
Configure a Wi-Fi Access Point with Personal Security328
Configure a Wi-Fi Access Point with Enterprise Security335
Isolate Wi-Fi Clients342
Isolate Clients Connected to the same Access Point342
Isolate Clients Connected to Different Access Points344
Configure a Wi-Fi Client and Add Client Networks350
Show Wi-Fi Access Point Status and Statistics359
Show Wi-Fi Client Status and Statistics361
Hotspot363
Hotspot Authentication Modes364
Hotspot DHCP Server365
Hotspot Security365
Hotspot Configuration366
Show Hotspot Status and Statistics408
Customize the Hotspot Login Page410
Hotspot RADIUS Attributes415
Routing416
IP Routing417
Configure a Static Route418
Delete a Static Route421
Policy-Based Routing423
Configure a Routing Policy424
Example: Dual WAN Policy-Based Routing432
Example: Domain-Based Routing with Dual WAN435
Example: Route Traffic to a Specific WAN Interface Based on the Client MAC Address438
Routing Services444
Configure Routing Services444
Show the Routing Table447
Dynamic DNS449
Configure Dynamic DNS449
Virtual Router Redundancy Protocol (VRRP)454
Vrrp455
Configure VRRP455
Configure VRRP459
Example: VRRP/VRRP+ Configuration466
Configure Device One (Master Device)467
Configure Device Two (Backup Device)471
Show VRRP Status and Statistics477
Ipsec481
Ipsec Data Protection481
Ipsec Mode481
Ipsec Modes481
Internet Key Exchange (IKE) Settings481
Authentication482
Configure an Ipsec Tunnel482
Configure Ipsec Failover510
Configure Surelink Active Recovery for Ipsec513
Show Ipsec Status and Statistics529
Debug an Ipsec Configuration530
Configure a Simple Certificate Enrollment Protocol Client532
Example: SCEP Client Configuration with Fortinet SCEP Server539
Show SCEP Client Status and Information544
Openvpn546
Configure an Openvpn Server547
Configure an Openvpn Authentication Group and User556
Configure an Openvpn Client by Using an .Ovpn File560
Configure an Openvpn Client Without Using an .Ovpn File563
Configure Surelink Active Recovery for Openvpn567
Show Openvpn Server Status and Statistics585
Show Openvpn Client Status and Statistics586
Generic Routing Encapsulation (GRE)588
Configuring a GRE Tunnel588
Show GRE Tunnels593
Example: GRE Tunnel over an Ipsec Tunnel594
Dynamic Multipoint VPN (DMVPN)608
Configure a DMVPN Spoke609
L2Tp615
Configure a PPP-Over-L2TP Tunnel616
L2TP with Ipsec625
Show L2TP Tunnel Status626
L2Tpv3 Ethernet627
Configure an L2Tpv3 Tunnel628
Show L2TPV3 Tunnel Status632
Macsec633
Configure a Macsec Tunnel634
Nemo636
Configure a NEMO Tunnel637
Show NEMO Status642
Allow Remote Access for Web Administration and SSH645
Configure the Web Administration Service649
Configure SSH Access659
Use SSH with Key Authentication667
Generating SSH Key Pairs667
Configure Telnet Access670
Configure DNS675
Show DNS Server681
WAN Bonding682
Use Digi Remote Manager to Enable and Configure WAN Bonding on Multiple Devices683
Configure WAN Bonding on Your Local Device686
Show WAN Bonding Status and Statistics692
Simple Network Management Protocol (SNMP)694
SNMP Security694
Configure Simple Network Management Protocol (SNMP)694
Download Mibs699
Location Information701
Configure the Location Service702
Enable or Disable Modem GNSS Support704
Configure the Device to Use a User-Defined Static Location706
Configure the Device to Accept Location Messages from External Sources708
Forward Location Information to a Remote Host713
Configure Geofencing719
Show Location Information732
Modbus Gateway733
Configure the Modbus Gateway734
Show Modbus Gateway Status and Statistics747
System Time751
Configure the System Time751
Manually Set the System Date and Time755
Network Time Protocol755
Configure the Device as an NTP Server756
Show Status and Statistics of the NTP Server761
Configure a Multicast Route762
Ethernet Network Bonding765
Enable Service Discovery (Mdns)770
Use the MQTT Broker Service774
Show MQTT Broker Information784
Use the Iperf Service785
Example Performance Test Using Iperf3790
Configure the Ping Responder Service790
Example Performance Test Using Iperf3794
Develop Python Applications797
Set up the IX20 for Python Development798
Create and Test a Python Application798
Python Modules802
The Use(Led) Function830
Releasing the Leds to System Control831
Use Python to Control the Color of Multi-Colored Leds831
Example: Set the LTE Connection Indicator to Flashing Purple833
Set up the IX20 to Automatically Run Your Applications841
Configure Scripts to Run Automatically841
Show Script Information849
Stop a Script that Is Currently Running849
Start an Interactive Python Session851
Run a Python Application at the Shell Prompt851
Configure Scripts to Run Manually853
Task One: Upload the Application853
Task Two: Configure the Application to Run Automatically855
Start a Manual Script859
IX20 User Authentication862
User Authentication Methods862
Add a New Authentication Method864
Delete an Authentication Method866
Rearrange the Position of Authentication Methods868
Authentication Groups870
Change the Access Rights for a Predefined Group872
Add an Authentication Group874
Delete an Authentication Group879
Local Users881
Change a Local User's Password882
Configure a Local User884
Delete a Local User892
Terminal Access Controller Access-Control System Plus (TACACS+)894
TACACS+ User Configuration895
TACACS+ Server Failover and Fallback to Local Authentication896
Configure Your IX20 Device to Use a TACACS+ Server896
Remote Authentication Dial-In User Service (RADIUS)901
RADIUS User Configuration902
RADIUS Server Failover and Fallback to Local Configuration902
Configure Your IX20 Device to Use a RADIUS Server903
Ldap906
LDAP User Configuration908
LDAP Server Failover and Fallback to Local Configuration909
Configure Your IX20 Device to Use an LDAP Server909
Configure Serial Authentication914
Disable Shell Access916
Set the Idle Timeout for IX20 Users918
Example User Configuration921
Example 1: Administrator User with Local Authentication921
Example 2: RADIUS, TACACS+, and Local Authentication for One User924
Firewall Configuration932
Create a Custom Firewall Zone932
Configure the Firewall Zone for a Network Interface934
Delete a Custom Firewall Zone936
Port Forwarding Rules937
Configure Port Forwarding937
Delete a Port Forwarding Rule942
Packet Filtering945
Configure Packet Filtering945
Enable or Disable a Packet Filtering Rule949
Delete a Packet Filtering Rule951
Configure Custom Firewall Rules953
Configure Captive Portals956
Delete Captive Portals960
Configure Quality of Service Options961
Web Filtering972
Configure Web Filtering with Cisco Umbrella973
Configure Web Filtering with Manual DNS Servers975
Verify Your Web Filtering Configuration978
Show Web Filter Service Information981
Use Digi Remote Manager to Deploy and Run Containers983
Use an Automation to Start the Container986
Upload a New Lxccontainer987
Configure a Container988
Starting and Stopping the Container993
Starting the Container993
Stopping the Container994
View the Status of Containers994
Show Status of All Containers995
Show Status of a Specific Container995
Schedule a Script to Run in the Container996
Create a Custom Container998
Create the Custom Container File999
Test the Custom Container File999
System Administration1001
Review Device Status1002
Configure System Information1003
Update System Firmware1005
Manage Firmware Updates Using Digi Remote Manager1006
Certificate Management for Firmware Images1006
Downgrading1006
Dual Boot Behavior1010
Update Cellular Module Firmware1011
Update Modem Firmware over the Air (OTA)1012
Update Modem Firmware by Using a Local Firmware File1014
Reboot Your IX20 Device1015
Reboot Your Device Immediately1015
Schedule Reboots of Your Device1016
Erase Device Configuration and Reset to Factory Defaults1018
Custom Factory Default Settings1021
Locate the Device by Using the Find Me Feature1023
Configure a Power Profile1024
Enable FIPS Mode1027
Configuration Files1030
Save Configuration Changes1030
Save Configuration to a File1031
Restore the Device Configuration1032
Schedule System Maintenance Tasks1035
Disable Device Encryption1041
Re-Enable Cryptography after It Has Been Disabled1041
Configure the Speed of Your Ethernet Ports1043
Configure the System Watchdog1045
Intelliflow1050
Enable Intelliflow1051
Configure Service Types1053
Configure Domain Name Groups1055
Use Intelliflow to Display Average CPU and RAM Usage1058
Use Intelliflow to Display Top Data Usage Information1059
Use Intelliflow to Display Data Usage by Host over Time1061
Configure Netflow Probe1062
File System1067
The IX20 Local File System1068
Display Directory Contents1068
Create a Directory1069
Display File Contents1070
Copy a File or Directory1070
Move or Rename a File or Directory1071
Delete a File or Directory1072
Upload and Download Files1073
Upload and Download Files by Using the Webui1073
Upload and Download Files by Using the Secure Copy Command1074
Upload and Download Files Using SFTP1075
Perform a Speedtest1078
Generate a Support Report1078
Support Report Overview1079
View System and Event Logs1083
View System Logs1083
View Event Logs1085
Configure Syslog Servers1088
Configure Options for the Event and System Logs1090
Analyze Network Traffic1096
Configure Packet Capture for the Network Analyzer1097
Example Filters for Capturing Data Traffic1106
Capture Packets from the Command Line1107
Stop Capturing Packets1108
Show Captured Traffic Data1109
Save Captured Data Traffic to a File1111
Download Captured Data to Your PC1111
Clear Captured Data1113
Use the Ping Command to Troubleshoot Network Connections1114
Ping to Check Internet Connection1114
Stop Ping Commands1114
Use the Traceroute Command to Diagnose IP Routing Problems1114
Digi IX20 Regulatory and Safety Statements1116
RF Exposure Statement1116
Federal Communication (FCC) Part 15 Class B1116
Radio Frequency Interference (RFI) (FCC15.105)1116
European Community - CE Mark Declaration of Conformity (Doc)1117
Ifetel1117
Maximum Transmit Power for Radio Frequencies1118
Innovation, Science, and Economic Development Canada (IC) Certifications1118
Rohs Compliance Statement1119
Special Safety Notes for Wireless Routers1119
Product Disposal Instructions1120
Safety Warnings1121
English1121
Bulgarian--Български1121
Croatian--Hrvatski1122
French--Français1123
Greek--Ελληνικά1123
Hungarian--Magyar1124
Italian--Italiano1124
Latvian--Latvietis1125
Lithuanian--Lietuvis1126
Polish--Polskie1126
Portuguese--Português1127
Slovak--Slovák1127
Slovenian--Esloveno1128
Spanish--Español1129
Digi IX20 Certifications1129
International EMC(Electromagnetic Compatibility) and Safety Standards1129
Command Line Interface1131
Access the Command Line Interface1132
Log in to the Command Line Interface1132
Exit the Command Line Interface1133
Execute a Command from the Web Interface1133
Display Help for Commands and Parameters1135
The Help Command1135
The Question Mark (?) Command1135
Display Help for Individual Commands1136
Use the Tab Key or the Space Bar to Display Abbreviated Help1137
Auto-Complete Commands and Parameters1137
Available Commands1138
Use the Scp Command1139
Display Status and Statistics Using the Show Command1141
Show Config1141
Show System1141
Show Network1142
Device Configuration Using the Command Line Interface1142
Execute Configuration Commands at the Root Admin CLI Prompt1142
Display Help for the Config Command from the Root Admin CLI Prompt1142
Configuration Mode1144
Enable Configuration Mode1144
Enter Configuration Commands in Configuration Mode1144
Save Changes and Exit Configuration Mode1145
Exit Configuration Mode Without Saving Changes1145
Configuration Actions1145
Display Command Line Help in Configuration Mode1146
Move Within the Configuration Schema1149
Manage Elements in Lists1150
The Revert Command1152
Enter Strings in Configuration Commands1154
Example: Create a New User by Using the Command Line1154
Command Line Reference1157
Analyzer Clear1159
Analyzer Save1159
Analyzer Start1159
Analyzer Stop1159
Cat1160
Clear Dhcp-Lease Ip-Address1160
Clear Dhcp-Lease Mac1160
Container Create1160
Container Delete1160
Grep1161
Help1161
Mkdir1163
Modem at1163
Modem At-Interactive1163
Modem Firmware Check1163
Modem Firmware List1163
Modem Firmware Ota Check1164
Modem Firmware Ota Download1164
Modem Firmware Ota List1164
Modem Firmware Ota Update1164
Modem Firmware Update1165
Modem Pin Change1165
Modem Pin Disable1165
Modem Pin Enable1166
Modem Pin Status1166
Modem Pin Unlock1166
Modem Puk Status1166
Modem Puk Unlock1167
Modem Reset1167
Modem Scan1167
Modem Sim-Slot1167
Monitoring1168
Monitoring Metrics Upload1168
More1168
Ping1169
Poweroff1169
Reboot1169
Scp1171
Show Analyzer1171
Show Arp1171
Show Cloud1171
Show Config1172
Show Containers1172
Show Dhcp-Lease1172
Show Dns1172
Show Eth1172
Show Event1173
Show Hotspot1173
Show Ipsec1173
Show L2Tp Lac1173
Show L2Tp Lns1174
Show L2Tpeth1174
Show Location1174
Show Log1174
Show Manufacture1174
Show Modbus-Gateway1175
Show Modem1175
Show Mqtt1175
Show Nemo1175
Show Network1176
Show Ntp1176
Show Openvpn Client1176
Show Openvpn Server1176
Show Route1177
Show Scep-Client1177
Show Scripts1177
Show Serial1177
Show Surelink Interface1177
Show Surelink Ipsec1178
Show Surelink Openvpn1178
Show Surelink State1178
Show System1178
Show Usb1179
Show Version1179
Show Vrrp1179
Show Wan-Bonding1179
Show Web-Filter1179
Show Wifi Ap1180
Show Wifi Client1180
Show Wifi-Scanner1180
Show Wifi-Scanner Blocklist1181
Show Wifi-Scanner Candidates1181
Show Wifi-Scanner Log1181
Speedtest1181
Ssh1182
System Backup1182
System Disable-Cryptography1182
System Duplicate-Firmware1183
System Factory-Erase1183
System Find-Me1183
System Firmware Ota Check1183
System Firmware Ota List1183
System Firmware Ota Update1184
System Firmware Update1184
System Power Ignition Off_Delay1184
System Restore1184
System Script Start1185
System Script Stop1185
System Serial Restart1185
System Serial Save1185
System Serial Show1185
System Support-Report1186
System Time Set1186
System Time Sync1186
System Time Test1186
Tail1187
Telnet1187
Traceroute1187
Calibrate Analog Input Ports1188

Digi IX20 - Page 1134

Table of Contents