Digi IX10

To Next Page

To Previous Page

Command line interface Execute a command from the web interface

IX10 User Guide

944

The Admin CLI prompt appears.

Main Page

Revision History-900023992
Table of Contents8
What's New in Digi IX10 Version 23.320
Digi IX10 Quick Start21
Step 1: What's in the Box21
Step 2: Gather Accessories21
Step 3: Connect22
Apply Dielectric Grease over SIM Contacts23
Step 4: Configure24
Digi IX10 Hardware Reference26
Digi IX10 Features and Specifications26
IX10 Accessories26
IX10 Front and Side Views26
IX10 Leds27
Power (PWR)28
Sim28
Lte28
Signal Quality Indicators29
Ethernet Link and Activity30
Signal Quality Bars Explained30
IX10 Power Supply Requirements31
Digi IX10 Serial Connector Pinout31
10-Pin Serial Cabling Options32
QR Code Definition32
Hardware Setup34
Install SIM Cards35
Apply Dielectric Grease over SIM Contacts35
SIM Removal36
Tips for Improving Cellular Signal Strength36
Connect Data Cables36
Mount the IX10 Device36
Attach to a Mounting Surface by Using the Mounting Tabs37
Attach to DIN Rail with Clip37
Firmware Configuration41
Review IX10 Default Settings41
Local Webui41
Digi Remote Manager41
Default Interface Configuration41
Other Default Configuration Settings42
Change the Default Password for the Admin User42
Configuration Methods44
Using Digi Remote Manager45
Using the Local Web Interface45
Log out of the Web Interface46
Use the Local REST API to Configure the IX10 Device46
Use the GET Method to Return Device Configuration Information46
Use the POST Method to Modify Device Configuration Parameters and List Arrays48
Use the DELETE Method to Remove Items from a List Array49
Using the Command Line51
Access the Command Line Interface51
Log in to the Command Line Interface51
Exit the Command Line Interface52
Central Management53
Digi Remote Manager Support54
Certificate-Based Enhanced Security54
Configure Your Device for Digi Remote Manager Support54
Collect Device Health Data and Set the Sample Interval61
Enable Event Log Upload to Digi Remote Manager64
Log into Digi Remote Manager66
Use Digi Remote Manager to View and Manage Your Device67
Add a Device to Digi Remote Manager67
Configure Multiple IX10 Devices by Using Digi Remote Manager Configurations68
View Digi Remote Manager Connection Status69
Learn more69
Interfaces70
Wireless Wide Area Networks (Wwans)71
Configure Surelink Active Recovery to Detect Modem Failures71
Configure the Device to Reboot When a Failure Is Detected88
Disable Surelink101
Using Cellular Modems in a Wireless WAN (WWAN)110
Configure a Wireless Wide Area Network (WWAN)129
Show WWAN Status and Statistics139
Delete a WWAN140
Local Area Networks (Lans)143
About Local Area Networks (Lans)144
Configure a LAN144
Change the Default LAN Subnet151
Change the LAN Address Type152
Show LAN Status and Statistics154
Delete a LAN155
DHCP Servers157
Virtual Lans (Vlans)175
Create a Trunked VLAN Route176
Create a VLAN Using Switchport Mode178
Show Surelink Status and Statistics180
Show Surelink State180
Show Surelink Status for All Interfaces181
Show Surelink Status for a Specific Interface181
Show Surelink Status for All Ipsec Tunnels182
Show Surelink Status for a Specific Ipsec Tunnel182
Show Surelink Status for All Openvpn Clients183
Show Surelink Status for a Specific Openvpn Client183
Serial Port185
Default Serial Port Configuration185
Serial Mode Options185
View Serial Port Information185
Configure Login Mode186
Configure Remote Access Mode190
Configure Application Mode206
Configure PPP Dial-In Mode208
Configure UDP Serial Mode215
Configure Modbus Mode226
Configure Realport Mode Using the Digi Navigator229
Installation and Configuration Process230
Digi Navigator Features230
Install the Digi Navigator230
Configure Realport on a Digi Device from the Digi Navigator231
Digi Navigator Application Features233
Advanced Realport Configuration Without Using the Digi Navigator236
Windows Operating System237
Linux Operating System237
Download the Realport Driver237
Configure Realport on Your Laptop237
Configure the Serial Port for Realport Mode239
Configure the Realport Service243
Show Serial Status and Statistics243
Review the Serial Port Message Log244
Routing246
IP Routing247
Configure a Static Route248
Delete a Static Route251
Policy-Based Routing253
Configure a Routing Policy253
Example: Dual WAN Policy-Based Routing261
Example: Domain-Based Routing with Dual WAN264
Example: Route Traffic to a Specific WAN Interface Based on the Client MAC Address267
Routing Services273
Configure Routing Services273
Show the Routing Table276
Dynamic DNS277
Configure Dynamic DNS278
Virtual Router Redundancy Protocol (VRRP)283
Vrrp283
Configure VRRP283
Configure VRRP287
Example: VRRP/VRRP+ Configuration295
Configure Device One (Master Device)295
Configure Device Two (Backup Device)300
Show VRRP Status and Statistics305
Ipsec309
Ipsec Data Protection309
Ipsec Mode309
Ipsec Modes309
Internet Key Exchange (IKE) Settings309
Authentication310
Configure an Ipsec Tunnel310
Configure Ipsec Failover338
Configure Surelink Active Recovery for Ipsec341
Show Ipsec Status and Statistics357
Debug an Ipsec Configuration358
Configure a Simple Certificate Enrollment Protocol Client360
Example: SCEP Client Configuration with Fortinet SCEP Server367
Show SCEP Client Status and Information372
Openvpn375
Configure an Openvpn Server376
Configure an Openvpn Authentication Group and User385
Configure an Openvpn Client by Using an .Ovpn File390
Configure an Openvpn Client Without Using an .Ovpn File393
Configure Surelink Active Recovery for Openvpn398
Show Openvpn Server Status and Statistics415
Show Openvpn Client Status and Statistics416
Generic Routing Encapsulation (GRE)418
Configuring a GRE Tunnel418
Show GRE Tunnels424
Example: GRE Tunnel over an Ipsec Tunnel425
Dynamic Multipoint VPN (DMVPN)440
Configure a DMVPN Spoke441
L2Tp448
Configure a PPP-Over-L2TP Tunnel448
L2TP with Ipsec457
Show L2TP Tunnel Status458
L2Tpv3 Ethernet459
Configure an L2Tpv3 Tunnel460
Show L2TPV3 Tunnel Status464
Nemo465
Configure a NEMO Tunnel466
Show NEMO Status471
Allow Remote Access for Web Administration and SSH474
Configure the Web Administration Service478
Configure SSH Access488
Use SSH with Key Authentication496
Generating SSH Key Pairs496
Configure Telnet Access499
Configure DNS504
Show DNS Server510
Simple Network Management Protocol (SNMP)512
SNMP Security512
Configure Simple Network Management Protocol (SNMP)512
Download Mibs517
Location Information519
Configure the Location Service520
Enable or Disable Modem GNSS Support522
Configure the Device to Use a User-Defined Static Location524
Configure the Device to Accept Location Messages from External Sources527
Forward Location Information to a Remote Host530
Configure Geofencing536
Show Location Information549
Modbus Gateway550
Configure the Modbus Gateway551
Show Modbus Gateway Status and Statistics564
System Time568
Configure the System Time568
Manually Set the System Date and Time572
Network Time Protocol572
Configure the Device as an NTP Server573
Show Status and Statistics of the NTP Server578
Configure a Multicast Route579
Enable Service Discovery (Mdns)582
Use the MQTT Broker Service585
Show MQTT Broker Information596
Use the Iperf Service597
Example Performance Test Using Iperf3602
Configure the Ping Responder Service602
Example Performance Test Using Iperf3606
Develop Python Applications608
Set up the IX10 for Python Development609
Create and Test a Python Application609
Python Modules613
The Use(Led) Function642
Releasing the Leds to System Control642
Use Python to Control the Color of Multi-Colored Leds642
Example: Set the LTE Connection Indicator to Flashing Purple644
Set up the IX10 to Automatically Run Your Applications653
Configure Scripts to Run Automatically653
Show Script Information660
Stop a Script that Is Currently Running661
Start an Interactive Python Session662
Run a Python Application at the Shell Prompt663
Configure Scripts to Run Manually664
Task One: Upload the Application665
Task Two: Configure the Application to Run Automatically666
Start a Manual Script670
User Authentication672
IX10 User Authentication673
User Authentication Methods673
Add a New Authentication Method675
Delete an Authentication Method677
Rearrange the Position of Authentication Methods679
Authentication Groups681
Change the Access Rights for a Predefined Group683
Add an Authentication Group685
Delete an Authentication Group690
Local Users692
Change a Local User's Password693
Configure a Local User695
Delete a Local User703
Terminal Access Controller Access-Control System Plus (TACACS+)705
TACACS+ User Configuration706
TACACS+ Server Failover and Fallback to Local Authentication707
Configure Your IX10 Device to Use a TACACS+ Server707
Remote Authentication Dial-In User Service (RADIUS)712
RADIUS User Configuration713
RADIUS Server Failover and Fallback to Local Configuration713
Configure Your IX10 Device to Use a RADIUS Server714
Ldap718
LDAP User Configuration719
LDAP Server Failover and Fallback to Local Configuration720
Configure Your IX10 Device to Use an LDAP Server720
Configure Serial Authentication725
Disable Shell Access728
Set the Idle Timeout for IX10 Users730
Example User Configuration733
Example 1: Administrator User with Local Authentication733
Example 2: RADIUS, TACACS+, and Local Authentication for One User736
Firewall Configuration744
Create a Custom Firewall Zone744
Configure the Firewall Zone for a Network Interface746
Delete a Custom Firewall Zone748
Port Forwarding Rules749
Configure Port Forwarding750
Delete a Port Forwarding Rule754
Packet Filtering757
Configure Packet Filtering757
Enable or Disable a Packet Filtering Rule761
Delete a Packet Filtering Rule763
Configure Custom Firewall Rules765
Configure Quality of Service Options767
Web Filtering777
Configure Web Filtering with Cisco Umbrella777
Configure Web Filtering with Manual DNS Servers780
Verify Your Web Filtering Configuration783
Show Web Filter Service Information785
Use Digi Remote Manager to Deploy and Run Containers788
Use an Automation to Start the Container791
Upload a New LXC Container792
Configure a Container793
Starting and Stopping the Container798
Starting the Container798
Stopping the Container799
View the Status of Containers799
Show Status of All Containers800
Show Status of a Specific Container800
Schedule a Script to Run in the Container801
Create a Custom Container804
Create the Custom Container File804
Test the Custom Container File805
System Administration806
Review Device Status807
Configure System Information808
Update System Firmware811
Manage Firmware Updates Using Digi Remote Manager811
Certificate Management for Firmware Images811
Downgrading811
Dual Boot Behavior815
Update Cellular Module Firmware816
Update Modem Firmware over the Air (OTA)817
Update Modem Firmware by Using a Local Firmware File819
Reboot Your IX10 Device820
Reboot Your Device Immediately820
Schedule Reboots of Your Device821
Erase Device Configuration and Reset to Factory Defaults823
Custom Factory Default Settings826
Locate the Device by Using the Find Me Feature828
Configure a Power Profile829
Configuration Files833
Save Configuration Changes833
Save Configuration to a File834
Restore the Device Configuration836
Schedule System Maintenance Tasks838
Disable Device Encryption843
Re-Enable Cryptography after It Has Been Disabled844
Configure the Speed of Your Ethernet Port846
Configure the System Watchdog848
Intelliflow853
Enable Intelliflow854
Configure Service Types856
Configure Domain Name Groups858
Use Intelliflow to Display Average CPU and RAM Usage862
Use Intelliflow to Display Top Data Usage Information863
Use Intelliflow to Display Data Usage by Host over Time865
Configure Netflow Probe866
File System872
The IX10 Local File System872
Display Directory Contents872
Create a Directory873
Display File Contents874
Copy a File or Directory874
Move or Rename a File or Directory875
Delete a File or Directory876
Upload and Download Files877
Upload and Download Files by Using the Webui877
Upload and Download Files by Using the Secure Copy Command878
Upload and Download Files Using SFTP879
Perform a Speedtest882
Generate a Support Report882
Support Report Overview883
View System and Event Logs887
View System Logs887
View Event Logs889
Configure Syslog Servers892
Configure Options for the Event and System Logs895
Analyze Network Traffic900
Configure Packet Capture for the Network Analyzer901
Example Filters for Capturing Data Traffic910
Capture Packets from the Command Line911
Stop Capturing Packets912
Show Captured Traffic Data913
Save Captured Data Traffic to a File915
Download Captured Data to Your PC915
Clear Captured Data917
Use the Ping Command to Troubleshoot Network Connections918
Ping to Check Internet Connection918
Stop Ping Commands918
Use the Traceroute Command to Diagnose IP Routing Problems918
Digi IX10 Regulatory and Safety Statements920
RF Exposure Statement920
Federal Communication (FCC) Part 15 Class B920
Radio Frequency Interference (RFI) (FCC 15.105)920
European Community - CE Mark Declaration of Conformity (Doc)920
Ifetel921
Maximum Transmit Power for Radio Frequencies922
Innovation, Science, and Economic Development Canada (IC) Certifications922
Rohs Compliance Statement923
Special Safety Notes for Wireless Routers923
Product Disposal Instructions924
English926
Bulgarian--Бъ Л Га Рс Ки927
Croatian--Hrvatski928
French--Français929
Greek--Ε Λλην Ικά930
Hungarian--Magyar931
Italian--Italiano932
Latvian--Latvietis933
Lithuanian--Lietuvis934
Polish--Polskie935
Portuguese--Português936
Slovak--Slovák937
Slovenian--Esloveno938
Spanish--Español939
Digiix10 Certifications939
International EMC (Electromagnetic Compatibility) and Safety Standards939
Command Line Interface942
Access the Command Line Interface942
Log in to the Command Line Interface942
Exit the Command Line Interface943
Execute a Command from the Web Interface943
Display Help for Commands and Parameters945
The Help Command945
The Question Mark (?) Command945
Display Help for Individual Commands946
Use the Tab Key or the Space Bar to Display Abbreviated Help947
Auto-Complete Commands and Parameters947
Available Commands948
Use the Scp Command949
Display Status and Statistics Using the Show Command951
Show Config951
Show System951
Show Network952
Device Configuration Using the Command Line Interface952
Execute Configuration Commands at the Root Admin CLI Prompt952
Display Help for the Config Command from the Root Admin CLI Prompt952
Configuration Mode954
Enable Configuration Mode954
Enter Configuration Commands in Configuration Mode954
Save Changes and Exit Configuration Mode955
Exit Configuration Mode Without Saving Changes955
Configuration Actions955
Display Command Line Help in Configuration Mode956
Move Within the Configuration Schema959
Manage Elements in Lists960
The Revert Command962
Enter Strings in Configuration Commands964
Example: Create a New User by Using the Command Line964
Command Line Reference967
Analyzer Clear968
Analyzer Save969
Analyzer Start969
Analyzer Stop969
Clear Dhcp-Lease Ip-Address969
Clear Dhcp-Lease Mac970
Container Create970
Container Delete970
Grep971
Help971
Mkdir973
Modem at973
Modem At-Interactive973
Modem Firmware Check973
Modem Firmware List973
Modem Firmware Ota Check974
Modem Firmware Ota Download974
Modem Firmware Ota List974
Modem Firmware Ota Update974
Modem Firmware Update975
Modem Pin Change975
Modem Pin Disable975
Modem Pin Enable976
Modem Pin Status976
Modem Pin Unlock976
Modem Puk Status976
Modem Puk Unlock977
Modem Reset977
Modem Scan977
Modem Sim-Slot977
Monitoring978
Monitoring Metrics Upload978
More978
Ping979
Poweroff979
Reboot979
Scp981
Show Analyzer981
Show Arp981
Show Cloud981
Show Config982
Show Containers982
Show Dhcp-Lease982
Show Dns982
Show Eth982
Show Event983
Show Hotspot983
Show Ipsec983
Show L2Tp Lac983
Show L2Tp Lns984
Show L2Tpeth984
Show Location984
Show Log984
Show Manufacture984
Show Modbus-Gateway985
Show Modem985
Show Mqtt985
Show Nemo985
Show Network986
Show Ntp986
Show Openvpn Client986
Show Openvpn Server986
Show Route987
Show Scep-Client987
Show Scripts987
Show Serial987
Show Surelink Interface987
Show Surelink Ipsec988
Show Surelink Openvpn988
Show Surelink State988
Show System988
Show Usb989
Show Version989
Show Vrrp989
Show Web-Filter989
Speedtest989
Ssh990
System Backup990
System Disable-Cryptography990
System Duplicate-Firmware991
System Factory-Erase991
System Find-Me991
System Firmware Ota Check991
System Firmware Ota List992
System Firmware Ota Update992
System Firmware Update992
System Power Ignition Off_Delay992
System Restore992
System Script Start993
System Script Stop993
System Serial Restart993
System Serial Save993
System Serial Show994
System Support-Report994
System Time Set994
System Time Sync994
System Time Test994
Tail995
Telnet995

Table of Contents

Related product manuals