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

: About This Guide, Summaries, Conventions

Get Lantronix SGX 5150 IoT Device Gateway PDF manuals and user guides View all Lantronix SGX 5150 IoT Device Gateway manuals
Add to My Manuals
Save this manual to your list of manuals

Page 8 highlights

1: About This Guide This document describes how to configure the Lantronix® SGXTM 5150 IoT device gateway using the Command Line Interface (CLI) and/or Extensible Markup Language (XML). CLI provides an interactive mode for accessing the gateway configuration and management interface. It is most suited for system and network administrators comfortable with using similar interfaces on enterprise IT and networking products. It is also helpful as a quick tool for access via the product's serial ports or console/management ports. XML provides an extensible mode for software developers interfacing with the gateway and system integrators performing batch provisioning/ updates. Chapter Summaries This table lists and summarizes the content of each chapter. Chapter 2: Overview 3: Command Line Interface 4: Configuration Using XML 5: Configuration Using Web API 6: Commands and Levels Summary Gives an overview of CLI and XML. Lists commands and describes how to use CLI to configure the SGX 5150 IoT device gateway. Lists XML Configuration Record (XCR) groups and items and describes how to use XCRs to configure the SGX 5150 IoT device gateway. Lists Web API actions that can be used to export and import configuration, export status, take a status action, and manipulate the file system. Provides an index of the CLI command hierarchy with hyperlinks to the corresponding command details. Conventions The table below lists and describes the conventions used in this book. Convention Description Bold text Default parameters Italic text Required values for parameters. Square Brackets [ ] Optional parameters. Angle Brackets < > Possible values for parameters. Pipe | Choice of parameters. Warning Warning: Means that you are in a situation that could cause equipment damage or bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Note Note: Means take notice. Notes contain helpful suggestions, information, or references to material not covered in the publication. Caution Caution: Means you might do something that could result in faulty equipment operation or loss of data. SGXTM 5150 IoT Device Gateway Command Reference 8

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
SGX
5150 IoT Device Gateway Command Reference
8
TM
1:
About This Guide
This document describes how to configure the Lantronix® SGX
5150 IoT device gateway using
the Command Line Interface (CLI) and/or Extensible Markup Language (XML). CLI provides an
interactive mode for accessing the gateway configuration and management interface. It is most
suited for system and network administrators comfortable with using similar interfaces on
enterprise IT and networking products. It is also helpful as a quick tool for access via the product's
serial ports or console/management ports. XML provides an extensible mode for software
developers interfacing with the gateway and system integrators performing batch provisioning/
updates.
Chapter Summaries
This table lists and summarizes the content of each chapter.
Conventions
The table below lists and describes the conventions used in this book.
Chapter
Summary
2: Overview
Gives an overview of CLI and XML.
3: Command Line Interface
Lists commands and describes how to use CLI to configure the SGX 5150
IoT device gateway.
4: Configuration Using XML
Lists XML Configuration Record (XCR) groups and items and describes
how to use XCRs to configure the SGX 5150 IoT device gateway.
5: Configuration Using Web
API
Lists Web API actions that can be used to export and import
configuration, export status, take a status action, and manipulate the file
system.
6: Commands and Levels
Provides an index of the CLI command hierarchy with hyperlinks to the
corresponding command details.
Convention
Description
Bold text
Default parameters
Italic text
Required values for parameters.
Square Brackets [ ]
Optional parameters.
Angle Brackets < >
Possible values for parameters.
Pipe |
Choice of parameters.
Warning
Warning:
Means that you are in a situation that could cause equipment
damage or bodily injury. Before you work on any equipment, you must be
aware of the hazards involved with electrical circuitry and be familiar with
standard practices for preventing accidents.
Note
Note:
Means take notice. Notes contain helpful suggestions, information, or
references to material not covered in the publication.
Caution
Caution:
Means you might do something that could result in faulty
equipment operation or loss of data.
TM