Root Console¶
The root console is a live root shell on the gateway, opened in your browser. The session is time-limited and ends automatically after inactivity or the maximum duration.
Who can open it¶
The Console button appears only if you may open a console on this device:
- a platform administrator,
- an Organization Owner of the organization that owns the device,
- a Support or Support Admin holder on that organization or on this device,
- someone granted console access on this one device.
An Organization Member can view and change the configuration but cannot open a console. A device still in the holding zone accepts a console only from a platform administrator.
Opening a console¶
- Open the device Overview.
- Click Console. If the gateway is offline the button is disabled and shows Gateway is offline.
- The console opens in a new browser tab. The status goes from Connecting… to Connected.
If the console cannot reach the device, it shows No response from the device. It may be offline, or it lost its connection to the platform. Check that it is powered on and online. If the platform refuses the session, the console shows the refusal it received.
Using the terminal¶
| Action | Keys |
|---|---|
| Copy | Cmd+Shift+C or Ctrl+Shift+C |
| Paste | Cmd+Shift+V or Ctrl+Shift+V, or right-click |
| Scroll back | Mouse wheel |
Changes made by hand do not stay
The portal does not see what you change in the shell. The next configuration you apply replaces it.
Ending a session¶
Click Close, or close the tab. To start again, click Reconnect.
When a session ends, the console says why:
| Message | Meaning |
|---|---|
| Session reached its one-hour limit. Open the console again to continue. | The session hit its maximum duration |
| Connection lost. Open the console again to reconnect. | The connection dropped |
| Session ended: {reason} | The device closed the shell, for example after inactivity or when the shell exited |
| The relay refused a message from this console. | The connection was closed because of a message it could not accept |
Session history¶
Every session is recorded. Click Session history in the console's top bar to see it:
| Column | Meaning |
|---|---|
| User | Who opened the session |
| Started | When it began |
| Duration | How long it lasted, or live if it is still open |
| End reason | Why it ended |
With no sessions yet, the panel shows No console sessions recorded yet.