Contact UsContact Us

SphireOS Command Line Interface Reference Guide

This article is intended for IT support.

Warning

Do not utilize the commands in this guide without the assistance of a Linewize Support Engineer.

School Manager Command Line Interface

School Manager has a two-part Command Line Interface (CLI): SphireOS (a proprietary product of Linewize) and Bash. You may be familiar with Bash if you have used a Linux terminal. However, the implementation of Bash for School Manager is limited with the majority of standard Linux/Unix utilities removed. 

Accessing the CLI

Access to the CLI is local only and requires you to connect to the appliance with a keyboard and mouse. Alternatively, SSH access is available to School Manager, provided it has been preconfigured in Advanced Configuration via the cloud interface.

  1. On boot, the School Manager will provide a login prompt to the SphireOS CLI. 
  2. Press Enter to log in. 
  3. If you want to get straight to Bash, type system debug exec bash to switch across. 
  4. From Bash, type exit to switch back to SphireOS.

Warning: School Manager may get stuck in a start-up check mode if cloud connectivity is not available, where it will reboot every few minutes in an effort to establish a connection. If the device is in this state, you can break out of the start-up checks by entering Ctrl + Alt + Delete.


SphireOS Command Reference

Warning: do not utilize the commands in this guide without the assistance of a Linewize Support Engineer.

Show the available commands

?

Go up a level


Option 1:

..

Option 2:

exit


Launch the configuration wizard


config wizard

Check for updates


system update status

Update the School Manager


system update update

Lock SphireOS version to prevent rollback


system layout mark-active-success

Reboot the School Manager


system reboot

Shutdown the School Manager


system shutdown

Reset all settings 


Warning: there is no confirmation

config reset


Launch a Bash shell


system debug exec bash

 

Bash Command Reference

Warning: do not utilize the commands in this guide without the assistance of a Linewize Support Engineer.

Show the status of the network adapters


ip a

Clear an interface configuration


ip addr del [IP Address/Mask] dev [interface name]

Example: 

ip addr del 192.168.1.1/24 dev eth1

Show the current routes


ip r

Reset the routing table


ip r flush table main

Set a default route


ip r add default via [Gateway IP] dev [interface name]

Example: 

ip r add default via 172.20.0.1 dev eth3

Obtain the last few syslog messages


tail /var/log/syslog

Follow and retry syslog messages


tail -F /var/log/syslog
Note: continues to display log messages as they are available

Look for a word in the syslog


tail /var/log/syslog | grep [word] 

Example: 

tail /var/log/syslog | grep cloud 


Look for issues in the syslog


grep Fatal /var/log/syslog

Show the content of a URL


curl [URL]

Example: 

curl https://ifconfig.io/


Check you can ping Google


ping 8.8.8.8

Check you can ping Linewize


ping linewize.net

Check DNS


cat /etc/resolv.conf

Check you can go to google.com


Basic Check:

curl https://www.google.com

Verbose/Detailed Logging: 

curl https://www.google.com -vv

Check the path to Linewize


traceroute linewize.net

Check the date and time


date

Check the interfaces


ifstat --errors

Obtain command history


history

Obtain current connections


ss

Read the configuration of the device


cat /configuration/sphirewall.conf


Further Support

For further support on the installation of your School Manager appliance, please contact Linewize Support United States (844) 723-3932 | Australia 1300 687 052 | New Zealand 0800 445 206