The Information tab of the device screen shows the high-level device information, such as serial number, name and approval status.
Note that this screen allows a user to update the Device Type (see Settings) and Name.
Device Health is also displayed on this screen, and shows a status of Healthy, Minor Issues or Major Issues.
The recent (last 24 hours) history of the device health is also shown for reference.
If a device has any problems that cause the Device Health to be Minor Issues or Major Issues, these will be shown on the Information tab as follows:
In some cases, it may be possible to resolve the problem by clicking the icon. For example, in the case of a package issue, the following resolutions are offered:
The Packages tab of the device screen shows the packages and versions that have been deployed (or have had attempted deployment) to the chosen device.
A state of Compliant indicates the requested version has been installed and correctly reported. A state of Failed indicates that the software reported does match the expected version.
For packages that have been configured with Process Monitoring (see Package Creation), this page also indicates whether the software package is Running or Stopped:
For packages that have been configured with Start and/or Stop commands (see Package Creation), it is also possible to Start and Stop packages, using icons at the right end of the row.
Note: The Running state is refreshed periodically and may take up to 60 seconds to update after issuing the start/stop command.
The Telemetry tab of the device screen shows the raw data being transmitted from the selected device.
Whilst SquareOne is not intended to be a data visualization product, up to 3 telemetry items can selected and quickly visualised on this screen. For more information on telemetry, see Telemetry Overview.
The Screen Share tab of the device screen allows remote access to a device’s desktop environment.
A connection is automatically attempted when this tab is active. Note that multiple concurrent connections may or may not be possible, depending on the configuration of the VNC server. Disconnect the session by navigating away from this tab or closing the browser window/tab.
The screen share can be made full screen by using the icon in the bottom-right of the window.
Note that by default the screen share connects through TCP port 5900. If an alternative port is required, this can be configured in the device type configuration, as described in Settings.
The Terminal tab of the device screen allows remote access to a suitable terminal shell (e.g. PowerShell for Windows, bash for Linux).
A connection is automatically attempted when this tab is active. Note that multiple concurrent connections are possible. Disconnect the session by navigating away from this tab or closing the browser window/tab.
The terminal can be made full screen by using the icon in the bottom-right of the window
The Command tab of the device screen allows individual commands to be sent to the device (see Command Examples).
Commands sent via this mechanism will return with a time out in the user interface after 60 seconds. However, the command will be allowed to execute on the device for up to 5 minutes, and during that time, further commands sent through this screen are also likely to time out.
If a command does take longer than 5 minutes to return, the command interface will reset, and this should allow commands to be issued successfully.
The Activity Log tab of the device screen shows an audit log of all logged events applicable to the selected device, including package deployments, remote commands, etc.
Clicking on a line in this view brings up some more information about the event:
The Management tab of the device screen provides options to manage a device:
Approval Status allows a partially registered device to be manually approved into the system, or a registered device to be revoked.
Deregister Device provides options for removing a device from the system.
Deregistering a device prevents the device from connecting to the SquareOne Server in the future, so the device and server will not be able to send any further messages to each other. It may take around 10 minutes for the deregistration to complete.
Provided that the device has not also been banned, the device can later be re-registered using the same (or different) registration certificate and private key, see Re-registering a Device.
When selecting Deregister Device, the following options are provided on the confirmation screen:
- Delete: Delete device The device will also be deleted from the cloud database, and so will no longer appear in SquareOne Companion.
- Ban device from re-registering: The device will be deregistered (as described above). The device will also be added to the ‘banned assets’ list. This means that the device will not be able to re-register using the same registration certificate and private key. The certificates will be deleted from the device when it attempts to re-register.