Consoleflow - Lantronix 100-120 VAC SLB User Manual

ConsoleFlow

ConsoleFlow is a cloud or on-premise portal for the centralized management of multiple SLB or
SLC8000 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 for an
SLC 8000 or SLB. Each SLC or SLB can communicate with the cloud server or on-premise server,
sending status updates, responding to commands sent by the server.
The online user guide for the ConsoleFlow server browser based interface is available at
https://docs.lantronix.com/products/consoleflow/web/.
An SLB device 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 Provisioning Manager
User Guide at https://www.lantronix.com/resources/product-index/.
The ConsoleFlow client follows a sequence of steps to connect to the cloud or on-premise
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 SLB boot, or if the client is enabled.
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 SLC or
SLB status may be different from the registered date/time shown in the ConsoleFlow web UI.
The SLC or SLB registered date/time is the most recent date and time that the SLC or SLB
registered with the ConsoleFlow server. The registered date and time shown in the
ConsoleFlow web UI is the first time that the SLC or SLB 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.
SLB™ Branch Office Manager User Guide
7: Services
106