Digi IX14

To Next Page

To Previous Page

Command line interface Command line reference

IX14 User Guide

803

Parameters

None

Main Page

Revision History-900022912
Table of Contents9
What's New in Digi IX14 Version 22.219
Digi IX14 Quick Start20
Step 1: What's in the Box20
Step 2: Gather Accessories20
Step 3: Connect Hardware21
Step 4: Sign up for Digi Remote Manager22
Step 5: Access the IX14 Local Web Interface22
Step 6: Configure Cellular Connection Using the Web Interface23
Step 7: Add Your IX14 to Your Digi Remote Manager Account23
Next Steps23
Reset the Device to Factory Defaults23
Digi IX14 Hardware Reference25
IX14 Features and Specifications25
IX14 Front View25
IX14 Back View25
IX14 Power Supply Requirements26
IX14 Leds26
Digi IX14 Serial Connector Pinout27
IX14 Accessory Kits28
IX14 Antennas28
Hardware Setup29
Install SIM Cards30
Apply Dielectric Grease over SIM Contacts30
Attach and Position Antennas31
Connect the WAN/ETH1 Port32
Connect the Serial Port32
Power on the IX1432
QR Code Definition32
Configuration and Management34
Review IX14 Default Settings34
Change the Default Password for the Admin User34
Configuration Methods36
Using Digi Remote Manager37
Access Digi Remote Manager37
Using the Web Interface37
Log out of the Web Interface38
Use the Local REST API to Configure the IX14 Device38
Use the GET Method to Return Device Configuration Information39
Use the POST Method to Modify Device Configuration Parameters and List Arrays41
Use the DELETE Method to Remove Items from a List Array41
Using the Command Line43
Access the Command Line Interface43
Log in to the Command Line Interface43
Exit the Command Line Interface44
Initial Configuration46
Configure Cellular Modem Apns47
Change the Default LAN Subnet51
Change the LAN Address Type52
Configure SIM PIN54
Configure System Settings54
Enable or Disable Bluetooth Service61
Interfaces65
Wireless Wide Area Networks (Wwans)66
Configure Surelink Active Recovery to Detect Modem Failures66
Configure the Device to Reboot When a Failure Is Detected76
Disable Surelink84
Using Cellular Modems in a Wireless WAN (WWAN)88
Configure a Wireless Wide Area Network (WWAN)105
Show WWAN Status and Statistics114
Delete a WWAN116
Local Area Networks (Lans)119
About Local Area Networks (Lans)120
Configure a LAN120
Show LAN Status and Statistics127
Delete a LAN129
DHCP Servers131
Create a Virtual LAN (VLAN) Route147
Show Surelink Status and Statistics149
Show Surelink Status for All Interfaces149
Show Surelink Status for a Specific Interface149
Show Surelink Status for All Ipsec Tunnels150
Show Surelink Status for a Specific Ipsec Tunnel150
Show Surelink Status for All Openvpn Clients151
Show Surelink Status for a Specific Openvpn Client151
Serial Port153
Default Serial Port Configuration153
Serial Mode Options153
View Serial Port Information153
Configure Login Mode153
Configure Remote Access Mode156
Configure Application Mode161
Configure UDP Serial Mode163
Configure Modbus Mode168
Show Serial Status and Statistics171
Log Serial Port Messages172
IX14 User Authentication174
User Authentication Methods174
Add a New Authentication Method176
Delete an Authentication Method178
Rearrange the Position of Authentication Methods180
Authentication Groups182
Change the Access Rights for a Predefined Group183
Add an Authentication Group185
Delete an Authentication Group189
Local Users191
Change a Local User's Password192
Configure a Local User194
Delete a Local User202
Terminal Access Controller Access-Control System Plus (TACACS+)205
TACACS+ User Configuration206
TACACS+ Server Failover and Fallback to Local Authentication207
Configure Your IX14 Device to Use a TACACS+ Server207
Remote Authentication Dial-In User Service (RADIUS)212
RADIUS User Configuration213
RADIUS Server Failover and Fallback to Local Configuration213
Configure Your IX14 Device to Use a RADIUS Server214
Ldap218
LDAP User Configuration219
LDAP Server Failover and Fallback to Local Configuration220
Configure Your IX14 Device to Use an LDAP Server220
Configure Serial Authentication225
Disable Shell Access227
Set the Idle Timeout for IX14 Users229
Example User Configuration232
Example 1: Administrator User with Local Authentication232
Example 2: RADIUS, TACACS+, and Local Authentication for One User234
Firewall241
Firewall Configuration242
Create a Custom Firewall Zone242
Configure the Firewall Zone for a Network Interface244
Delete a Custom Firewall Zone246
Port Forwarding Rules247
Configure Port Forwarding247
Delete a Port Forwarding Rule252
Packet Filtering255
Configure Packet Filtering255
Enable or Disable a Packet Filtering Rule259
Delete a Packet Filtering Rule261
Configure Custom Firewall Rules263
Configure Quality of Service Options264
Review Device Status277
Configure System Information278
Update System Firmware280
Manage Firmware Updates Using Digi Remote Manager280
Certificate Management for Firmware Images281
Downgrading281
Dual Boot Behavior285
Update Cellular Module Firmware286
Update Modem Firmware over the Air (OTA)287
Update Modem Firmware by Using a Local Firmware File288
Reboot Your IX14 Device289
Reboot Your Device Immediately289
Schedule Reboots of Your Device290
Erase Device Configuration and Reset to Factory Defaults292
Configure the IX14 Device to Use Custom Factory Default Settings295
Locate the Device by Using the Find Me Feature297
Configuration Files299
Save Configuration Changes299
Save Configuration to a File300
Restore the Device Configuration301
Schedule System Maintenance Tasks304
Disable Device Encryption309
Re-Enable Cryptography after It Has Been Disabled310
Create a Virtual LAN (VLAN) Route311
Configure the Speed of Your Ethernet Port313
Allow Remote Access for Web Administration and SSH317
Configure the Web Administration Service321
Configure SSH Access331
Use SSH with Key Authentication339
Generating SSH Key Pairs339
Configure Telnet Access342
Configure DNS347
Show DNS Server353
Simple Network Management Protocol (SNMP)354
SNMP Security354
Configure Simple Network Management Protocol (SNMP)354
Download Mibs359
Location Information360
Configure the Location Service361
Configure the Device to Use a User-Defined Static Location363
Configure the Device to Accept Location Messages from External Sources365
Forward Location Information to a Remote Host369
Configure Geofencing375
Show Location Information388
Modbus Gateway389
Configure the Modbus Gateway390
Show Modbus Gateway Status and Statistics403
System Time406
Configure the System Time406
Manually Set the System Date and Time410
Network Time Protocol410
Configure the Device as an NTP Server411
Show Status and Statistics of the NTP Server416
Configure a Multicast Route417
Enable Service Discovery (Mdns)419
Use the Iperf Service423
Example Performance Test Using Iperf3427
Configure the Ping Responder Service428
Example Performance Test Using Iperf3432
Upload a New LXC Container433
Configure a Container434
Starting and Stopping the Container437
Starting the Container437
Stopping the Container438
View the Status of Containers438
Show Status of All Containers439
Show Status of a Specific Container439
Schedule a Script to Run in the Container440
Create a Custom Container442
Create the Custom Container File442
Test the Custom Container File443
Configure Scripts to Run Automatically446
Task One: Upload the Application446
Task Two: Configure the Application to Run Automatically448
Configure Scripts to Run Manually452
Task One: Upload the Application453
Task Two: Configure the Application to Run Automatically454
Start a Manual Script458
Stop a Script that Is Currently Running459
Show Script Information460
Run a Python Application at the Shell Prompt461
Start an Interactive Python Session462
Digidevice Module464
Use Digidevice.cli to Execute CLI Commands465
Use Digidevice.datapoint to Upload Custom Datapoints to Digi Remote Manager466
Use Digidevice.config for Device Configuration469
Use Python to Respond to Digi Remote Manager SCI Requests471
Use Digidevice Runtime to Access the Runtime Database480
Use Python to Upload the Device Name to Digi Remote Manager482
Use Python to Access the Device Location Data484
Use Python to Set the Maintenance Window488
Use Python to Send and Receive SMS Messages490
Use Python to Access Serial Ports492
Use the Paho MQTT Python Library493
Central Management497
Digi Remote Manager Support498
Certificate-Based Enhanced Security498
Configure Digi Remote Manager498
Collect Device Health Data and Set the Sample Interval505
Enable Event Log Upload to Digi Remote Manager508
Log into Digi Remote Manager510
Use Digi Remote Manager to View and Manage Your Device511
Add a Device to Digi Remote Manager512
View Digi Remote Manager Connection Status512
Configure Multiple Devices Using Profiles513
Learn more514
Intelliflow516
Enable Intelliflow516
Use Intelliflow to Display Average CPU and RAM Usage519
Use Intelliflow to Display Top Data Usage Information520
Use Intelliflow to Display Data Usage by Host over Time522
Configure Netflow Probe523
Virtual Private Networks (VPN)528
Ipsec529
Ipsec Data Protection529
Ipsec Mode529
Ipsec Modes529
Internet Key Exchange (IKE) Settings529
Authentication530
Configure an Ipsec Tunnel530
Configure Ipsec Failover557
Configure Surelink Active Recovery for Ipsec560
Show Ipsec Status and Statistics567
Debug an Ipsec Configuration568
Configure a Simple Certificate Enrollment Protocol Client570
Example: SCEP Client Configuration with Fortinet SCEP Server575
Disable Hardware Cryptographic Acceleration579
Openvpn582
Configure an Openvpn Server583
Configure an Openvpn Authentication Group and User592
Configure an Openvpn Client by Using an .Ovpn File596
Configure an Openvpn Client Without Using an .Ovpn File599
Configure Surelink Active Recovery for Openvpn603
Show Openvpn Server Status and Statistics611
Show Openvpn Client Status and Statistics612
Generic Routing Encapsulation (GRE)614
Configuring a GRE Tunnel614
Show GRE Tunnels619
Example: GRE Tunnel over an Ipsec Tunnel620
L2Tp635
Configure a PPP-Over-L2TP Tunnel635
Configure Surelink Active Recovery for PPP-Over-L2TP645
L2TP with Ipsec653
Show L2TP Tunnel Status653
L2Tpv3 Ethernet655
Configure an L2Tpv3 Tunnel655
Show L2TPV3 Tunnel Status660
Nemo661
Configure a NEMO Tunnel661
Show NEMO Status667
Perform a Speedtest670
Generate a Support Report670
View System and Event Logs672
View System Logs672
View Event Logs674
Configure Syslog Servers676
Configure Options for the Event and System Logs679
Analyze Network Traffic684
Configure Packet Capture for the Network Analyzer685
Example Filters for Capturing Data Traffic694
Capture Packets from the Command Line695
Stop Capturing Packets696
Show Captured Traffic Data697
Save Captured Data Traffic to a File698
Download Captured Data to Your PC699
Clear Captured Data700
Use the Ping Command to Troubleshoot Network Connections702
Ping to Check Internet Connection702
Stop Ping Commands702
Use the Traceroute Command to Diagnose IP Routing Problems702
IP Routing705
Configure a Static Route706
Delete a Static Route709
Policy-Based Routing711
Configure a Routing Policy712
Routing Services719
Configure Routing Services720
Show the Routing Table723
Dynamic DNS725
Configure Dynamic DNS725
Virtual Router Redundancy Protocol (VRRP)731
Vrrp731
Configure VRRP732
Configure VRRP735
Example: VRRP/VRRP+ Configuration743
Configure Device One (Master Device)744
Configure Device Two (Backup Device)748
Show VRRP Status and Statistics754
File System758
The IX14 Local File System758
Display Directory Contents758
Create a Directory759
Display File Contents760
Copy a File or Directory760
Move or Rename a File or Directory761
Delete a File or Directory762
Upload and Download Files763
Upload and Download Files by Using the Webui763
Upload and Download Files by Using the Secure Copy Command764
Upload and Download Files Using SFTP765
Digi IX14 Regulatory and Safety Statements767
RF Exposure Statement767
Federal Communication (FCC) Part 15 Class B767
Radio Frequency Interference (RFI) (FCC 15.105)767
European Community - CE Mark Declaration of Conformity (Doc)767
Maximum Transmit Power for Radio Frequencies769
Innovation, Science, and Economic Development Canada (IC) Certifications769
Rohs Compliance Statement770
Special Safety Notes for Wireless Routers770
Product Disposal Instructions771
Command Line Interface774
Access the Command Line Interface774
Log in to the Command Line Interface774
Exit the Command Line Interface775
Execute a Command from the Web Interface775
Display Help for Commands and Parameters776
The Help Command776
The Question Mark (?) Command776
Display Help for Individual Commands777
Use the Tab Key or the Space Bar to Display Abbreviated Help779
Auto-Complete Commands and Parameters779
Available Commands780
Use the Scp Command781
Display Status and Statistics Using the Show Command782
Show Config782
Show System783
Show Network783
Device Configuration Using the Command Line Interface784
Execute Configuration Commands at the Root Admin CLI Prompt784
Display Help for the Config Command from the Root Admin CLI Prompt784
Configuration Mode786
Enable Configuration Mode786
Enter Configuration Commands in Configuration Mode786
Save Changes and Exit Configuration Mode787
Exit Configuration Mode Without Saving Changes787
Configuration Actions787
Display Command Line Help in Configuration Mode788
Move Within the Configuration Schema791
Manage Elements in Lists792
The Revert Command794
Enter Strings in Configuration Commands796
Example: Create a New User by Using the Command Line796
Command Line Reference799
Analyzer Clear800
Analyzer Save801
Analyzer Start801
Analyzer Stop801
Clear Dhcp-Lease Ip-Address801
Clear Dhcp-Lease Mac801
Container Create802
Container Delete802
Help802
Mkdir805
Modem at805
Modem At-Interactive805
Modem Firmware Check805
Modem Firmware List805
Modem Firmware Ota Check806
Modem Firmware Ota List806
Modem Firmware Ota Update806
Modem Firmware Update806
Modem Pin Change807
Modem Pin Disable807
Modem Pin Enable807
Modem Pin Status808
Modem Pin Unlock808
Modem Puk Status808
Modem Puk Unlock808
Modem Reset809
Modem Scan809
Modem Sim-Slot809
Monitoring809
Monitoring Metrics Upload810
More810
Ping810
Reboot812
Scp814
Show Analyzer814
Show Arp814
Show Cloud814
Show Config815
Show Containers815
Show Dhcp-Lease815
Show Dns815
Show Event815
Show Hotspot816
Show Ipsec816
Show L2Tp Lac816
Show L2Tp Lns816
Show L2Tpeth817
Show Location817
Show Log817
Show Manufacture817
Show Modbus-Gateway817
Show Modem818
Show Nemo818
Show Network818
Show Ntp818
Show Openvpn Client819
Show Openvpn Server819
Show Route819
Show Serial819
Show Scripts820
Show Surelink Interface820
Show Surelink Ipsec820
Show Surelink Openvpn820
Show System821
Show Usb821
Show Version821
Show Vrrp821
Show Web-Filter821
Speedtest822
Ssh822
System Backup822
System Disable-Cryptography823
System Duplicate-Firmware823
System Factory-Erase823
System Find-Me823
System Firmware Ota Check824
System Firmware Ota List824
System Firmware Ota Update824
System Firmware Update824
System Power Ignition Off_Delay824
System Restore825
System Script Start825
System Script Stop825
System Serial Clear825
System Serial Save826
System Serial Show826
System Serial Start826
System Serial Stop826
System Support-Report826
System Time Set827
System Time Sync827
System Time Test827
Telnet827
Traceroute828

Table of Contents

Related product manuals