Lantronix SGX 5150 IoT Device Gateway SGX 5150 Command Reference - Page 4

SGX

5150 IoT Device Gateway Command Reference

4

TM

Table of Contents

Intellectual Property ________________________________________________________2

Warranty _________________________________________________________________2

Contacts _________________________________________________________________2

Disclaimer ________________________________________________________________2

Open Source Software ______________________________________________________3

Revision History

___________________________________________________________3

Table of Contents __________________________________________________________4

List of Figures _____________________________________________________________6

List of Tables ______________________________________________________________7

1: About This Guide

8

Chapter Summaries ________________________________________________________8

Conventions ______________________________________________________________8

Additional Documentation ____________________________________________________9

2: Overview

10

XML Architecture and Control ________________________________________________10

Command Line Interface ____________________________________________________10

Web API ________________________________________________________________10

3: Command Line Interface

11

Configuration Using Telnet __________________________________________________11

Configuration Using the Serial Lines ___________________________________________11

Navigating the CLI Hierarchy ________________________________________________12

Using Keyboard Shortcuts and CLI ____________________________________________13

Understanding the CLI Level Hierarchy ________________________________________13

4: Configuration Using XML

16

XML Configuration Record Document Type Definition _____________________________16

Quick Tour of XML Syntax __________________________________________________17

Record, Group, Item, and Value Tags

_________________________________________18

Importing and Exporting an XML Configuration File _______________________________20

Best Practices ____________________________________________________________20

XML Configuration Groups __________________________________________________21

XML Status Record Groups and Items _________________________________________44

5: Configuration Using Web API

58

Overview ________________________________________________________________58

Lantronix SGX 5150 IoT Device Gateway SGX 5150 Command Reference - Page 4

Table of Contents, About This Guide, Overview, Command Line Interface, Configuration Using XML

Page 4 highlights

Section	Page
PremierWave® 2050 SGX 5150 IoT Device Gateway Command Reference	1
Intellectual Property	2
Warranty	2
Contacts	2
Disclaimer	2
Open Source Software	3
Revision History	3
Table of Contents	4
List of Figures	6
List of Tables	7
1: About This Guide	8
Chapter Summaries	8
Conventions	8
Additional Documentation	9
2: Overview	10
XML Architecture and Control	10
Command Line Interface	10
Web API	10
3: Command Line Interface	11
Configuration Using Telnet	11
Configuration Using the Serial Lines	11
Serial Command Mode	11
Serial Recovery	11
To configure the SGX 5150 IoT device gateway locally using a serial port:	12
Navigating the CLI Hierarchy	12
Using Keyboard Shortcuts and CLI	13
Understanding the CLI Level Hierarchy	13
4: Configuration Using XML	16
XML Configuration Record Document Type Definition	16
Quick Tour of XML Syntax	17
Declaration	17
Element Start and End Tags	17
Element Attributes	17
Record, Group, Item, and Value Tags	18
Importing and Exporting an XML Configuration File	20
Best Practices	20
Exporting	20
Importing	20
XML Configuration Groups	21
XML Status Record Groups and Items	44
5: Configuration Using Web API	58
Overview	58
Device Actions API	58
File System API	58
Device Actions API	58
Export Status Group	58
Parameters:	58
CURL example:	58
Javascript example:	59
Export Configuration Group	59
Parameters:	59
CURL example:	59
Javascript example:	59
Import Configuration Group	59
Parameters:	59
CURL example (configuration is saved in a local file config.xml):	59
CURL example (configuration as part of command):	60
HTTP example:	60
Take Status Action	60
Parameters:	60
Actions Definitions	60
group \	61
group \	61
group \	61
group \	61
group \	62
group \	63
group \	63
File System Web API	63
HTTP GET	64
HTTP PUT	64
HTTP MKCOL	65
HTTP DELETE	66