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

: Configuration Using XML, XML Configuration Record Document Type Definition

Page 16 highlights

4: Configuration Using XML The SGX 5150 IoT device gateway provides an XML interface that you can use to configure SGX 5150 IoT device gateways. Every configuration setting that can be issued from the gateway's Web Manager interface and CLI can be specified using XML. The SGX 5150 IoT device gateway can import and export configuration settings as an XML document known as an XML Configuration Record (XCR). An XCR can be imported or exported via the CLI, a Web browser, or FTP. An XCR can contain many configuration settings or just a few. For example, it might change all of the configurable parameters for a SGX 5150 IoT device gateway, or it may only change the baud rate for a single serial line. Using XCRs is a straightforward and flexible way to manage the configuration of multiple SGX 5150 IoT device gateways. XML Configuration Record Document Type Definition An XML document type definition (DTD) is a description of the structure and content of an XML document. It verifies that a document is valid. XCRs are exported using the DTD as shown in Figure 4-4 DTD for XCRs. Figure 4-4 DTD for XCRs ]> The SGX 5150 DTD rules state the following:  The XML document element is a element. This is the root element.  A must have one or more elements and can have a version attribute.  A must have one or more elements and can have name and instance attributes.  A element must have one or more elements and can have a name attribute.  A element can have only data and can have a name attribute.  The name attribute identifies a group, item, or value. It is always a quoted string.  The instance attribute identifies the specific option, like the serial port number. The "instance" attribute is always a quoted string. SGXTM 5150 IoT Device Gateway Command Reference 16

  • 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
16
TM
4:
Configuration Using XML
The SGX 5150 IoT device gateway provides an XML interface that you can use to configure SGX
5150 IoT device gateways. Every configuration setting that can be issued from the gateway’s Web
Manager interface and CLI can be specified using XML.
The SGX 5150 IoT device gateway can import and export configuration settings as an XML
document known as an XML Configuration Record (XCR). An XCR can be imported or exported
via the CLI, a Web browser, or FTP. An XCR can contain many configuration settings or just a few.
For example, it might change all of the configurable parameters for a SGX 5150 IoT device
gateway, or it may only change the baud rate for a single serial line. Using XCRs is a
straightforward and flexible way to manage the configuration of multiple SGX 5150 IoT device
gateways.
XML Configuration Record Document Type Definition
An XML document type definition (DTD) is a description of the structure and content of an XML
document. It verifies that a document is valid. XCRs are exported using the DTD as shown in
Figure 4-4 DTD for XCRs
.
Figure 4-4
DTD for XCRs
<!DOCTYPE configrecord [
<!ELEMENT configrecord (configgroup+)>
<!ELEMENT configgroup (configitem+,configgroup*)>
<!ELEMENT configitem (value+)>
<!ELEMENT value (#PCDATA)>
<!ATTLIST configrecord version CDATA #IMPLIED>
<!ATTLIST configgroup name CDATA #IMPLIED>
<!ATTLIST configgroup instance CDATA #IMPLIED>
<!ATTLIST configitem name CDATA #IMPLIED>
<!ATTLIST value name CDATA #IMPLIED>
]>
The SGX 5150 DTD rules state the following:
The XML document element is a
<configrecord>
element. This is the root element.
A
<configrecord>
must have one or more
<configgroup>
elements and can have a
version attribute.
A
<configgroup>
must have one or more
<configitem>
elements and can have name
and instance attributes.
A
<configitem>
element must have one or more
<value>
elements and can have a name
attribute.
A
<value>
element can have only data and can have a name attribute.
The name attribute identifies a group, item, or value. It is always a quoted string.
The instance attribute identifies the specific option, like the serial port number. The "instance"
attribute is always a quoted string.