Lantronix EMG 8500 - Edge Management Gateway EMG User Guide - Page 176

ConsoleFlow, Services, EMG™ Edge Management Gateway User Guide, Provisioning Manager User Guide

Page 176 highlights

8: Services ConsoleFlow ConsoleFlow is a cloud or on-premise portal for the centralized management of multiple Lantronix ITM devices. A browser based interface (including mobile phone app support) allows an administrator to view status, send commands, view logs and charts and update firmware. Each Lantronix device can communicate with the cloud server or on-premise server, sending status updates and responding to commands sent by the server. An EMG gateway requires a unique Device ID to communicate with the ConsoleFlow portal. The ID is viewable in the ConsoleFlow settings. If a device is not already pre-configured with the ID, the ID must be provisioned using Lantronix Provisioning Manager (LPM). See the Lantronix Provisioning Manager User Guide at https://www.lantronix.com/products/lantronix-provisioningmanager/. The ConsoleFlow client follows a sequence of steps to connect to the ConsoleFlow server, send status updates, check for firmware and configuration updates, and respond to commands from the server. This series of steps is the same each time the client starts - at EMG boot, or if the client is enabled. Any changes to the ConsoleFlow Device ID, Registration settings or Messaging settings require the ConsoleFlow client to be disabled and re-enabled for the changes to take effect. 1. Registration The client will attempt to register to the Registration Host using the Project Tag and Device ID. If registration fails, the client will wait 30 seconds and retry. The client will retry until it is successful, or the client is disabled. Registration may fail if the Project Tag is invalid, the Device ID is invalid, the Registration Host name cannot be resolved, or the Registration Host is not reachable. Once registration is successful, Status of Client will display Registered with the date and time of registration. Note that the Registered date/time displayed in the EMG status may be different from the registered date/time shown in the ConsoleFlow web UI. The EMG registered date/time is the most recent date and time that the EMG registered with the ConsoleFlow server. The registered date and time shown in the ConsoleFlow web UI is the first time that the EMG ever registered with the ConsoleFlow server. 2. Telemetry After registration, the client will connect to the Telemetry Host (the hostname is provided during registration) and perform a telemetry handshake. This handshake may request that the client publish a set of statistics at regular intervals. If a telemetry handshake is successful, Status of Client will display Telemetry Handshake with the date and time of the handshake. Each time telemetry statistics are published, Status of Client will display Telemetry Statistics with the date and time the statistics were sent. 3. Messages and Status Updates After the telemetry handshake, the client will connect to the Messaging Host to receive messages and publish status updates. If the connection fails, the client will wait 5 seconds and retry. The connection may fail if the Messaging Host name cannot be resolved, or the Messaging Host is not reachable. Once the connection is successful, Status of Client will display Messaging connected with the date and time the connection was established. The client publishes status update messages (changes to device attributes) at the interval defined by Interval between Status Updates. Each time a status update is published, Status of Client will display Status with the date and time the status was sent. The client also accepts command messages from the ConsoleFlow server to perform actions, such as reboot or shutdown. Each time a message is received, Status of Client will display Message received with the date and time the message was received. 4. Firmware and Configuration Updates EMG™ Edge Management Gateway User Guide 176

  • 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
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418
  • 419
  • 420
  • 421
  • 422
  • 423
  • 424
  • 425
  • 426
  • 427
  • 428
  • 429
  • 430
  • 431
  • 432
  • 433
  • 434
  • 435
  • 436
  • 437
  • 438
  • 439
  • 440
  • 441
  • 442
  • 443
  • 444
  • 445
  • 446
  • 447
  • 448
  • 449
  • 450
  • 451
  • 452
  • 453
  • 454
  • 455
  • 456
  • 457
  • 458
  • 459
  • 460
  • 461
  • 462
  • 463
  • 464
  • 465
  • 466
  • 467
  • 468
  • 469
  • 470
  • 471
  • 472
  • 473
  • 474
  • 475
  • 476
  • 477
  • 478
  • 479
  • 480
  • 481
  • 482
  • 483
  • 484
  • 485
  • 486
  • 487
  • 488
  • 489
  • 490
  • 491
  • 492
  • 493
  • 494
  • 495

8: Services
EMG™ Edge Management Gateway User Guide
176
ConsoleFlow
ConsoleFlow is a cloud or on-premise portal for the centralized management of multiple Lantronix
ITM devices. A browser based interface (including mobile phone app support) allows an
administrator to view status, send commands, view logs and charts and update firmware. Each
Lantronix device can communicate with the cloud server or on-premise server, sending status
updates and responding to commands sent by the server.
An EMG gateway requires a unique Device ID to communicate with the ConsoleFlow portal. The
ID is viewable in the ConsoleFlow settings. If a device is not already pre-configured with the ID, the
ID must be provisioned using Lantronix Provisioning Manager (LPM). See the Lantronix
Provisioning Manager User Guide
at
manager/
.
The ConsoleFlow client follows a sequence of steps to connect to the ConsoleFlow server, send
status updates, check for firmware and configuration updates, and respond to commands from the
server. This series of steps is the same each time the client starts - at EMG boot, or if the client is
enabled. Any changes to the ConsoleFlow Device ID, Registration settings or Messaging settings
require the ConsoleFlow client to be disabled and re-enabled for the changes to take effect.
1.
Registration
The client will attempt to register to the
Registration Host
using the Project Tag and Device
ID. If registration fails, the client will wait 30 seconds and retry. The client will retry until it is
successful, or the client is disabled. Registration may fail if the Project Tag is invalid, the
Device ID is invalid, the Registration Host name cannot be resolved, or the Registration Host
is not reachable. Once registration is successful,
Status of Client
will display
Registered
with
the date and time of registration. Note that the Registered date/time displayed in the EMG
status may be different from the registered date/time shown in the ConsoleFlow web UI. The
EMG registered date/time is the most recent date and time that the EMG registered with the
ConsoleFlow server. The registered date and time shown in the ConsoleFlow web UI is the
first time that the EMG ever registered with the ConsoleFlow server.
2.
Telemetry
After registration, the client will connect to the Telemetry Host (the hostname is provided
during registration) and perform a telemetry handshake. This handshake may request that the
client publish a set of statistics at regular intervals. If a telemetry handshake is successful,
Status of Client
will display
Telemetry Handshake
with the date and time of the handshake.
Each time telemetry statistics are published,
Status of Client
will display
Telemetry
Statistics
with the date and time the statistics were sent.
3.
Messages and Status Updates
After the telemetry handshake, the client will connect to the
Messaging Host
to receive
messages and publish status updates. If the connection fails, the client will wait 5 seconds and
retry. The connection may fail if the Messaging Host name cannot be resolved, or the
Messaging Host is not reachable. Once the connection is successful, Status of Client will
display Messaging connected with the date and time the connection was established.
The client publishes status update messages (changes to device attributes) at the interval
defined by Interval between Status Updates. Each time a status update is published,
Status
of Client
will display
Status
with the date and time the status was sent. The client also
accepts command messages from the ConsoleFlow server to perform actions, such as reboot
or shutdown. Each time a message is received,
Status of Client
will display
Message
received
with the date and time the message was received.
4.
Firmware and Configuration Updates