Administrator Guide: Shell

Table of contents

History

[2013/02/15]
  • Initial version based on SMP 4.8 admin guide

Overview

The SOP Shell enables you to test some important features of your SOP.

The SOP Shell can be accessed by one of the following means:

  • Attach a screen and keyboard to the SOP server
  • Connect via ssh to the SOP server (the IP address as given in the server configuration)

In both cases login as 'admin' (the default password is also 'admin')

ALERT! Some functions in the SOP Shell are only available if the corresponding module is installed (E.g. the menu entry 'High Availabililty' is only available if the high-availability module is installed)

Features

See below the most important features. For the full feature list refer to the Shell module documentation.

Test connectivity to SMP

If the SMP indicates that it doesn't have connectivity to your SOP, you can use Diagnostics > SMP Connection. This will run a series of tests. If any of these tests fail, see below for hints on what to do. 

Checking if SOPKEY is set...NOT OK
  • The SOP wasn't properly installed, try setting the SOPKEY (Configuration menu) 

Checking if eth0 is connected...NOT OK
  • Check that the LAN cable is connected to your switch 

Pinging default gateway (ip)...NOT OK
  • Check the SOP network config.
  • This may fail if your default gateway is e.g. a firewall that doesn't reply to pings. In that case ignore the error. 

Checking outbound DNS (smp-boot.escaux.com)...NOT OK
  • Check the DNS servers in the SOP network config
  • Check your firewall that it allows outgoing DNS requests
  • If this fails, the SOP will still be able to connect to the SMP but some functions won't work (e.g. voicemail to email, NTP synchronization, ...) 

Checking outbound HTTP to http://smp-boot.escaux.com...NOT OK
  • Check your firewall or router, it must allow outgoing HTTP without proxy. 

Obtaining SSH connection details...NOT OK
  • you have (incorrectly) changed your SOPKEY.
  • there is a temporary failure on the SMP
  • your SOP may not correctly provisioned on the SMP. 

Testing outbound TCP to 213.246.219.79:22...NOT OK
  • Check your firewall or router, it must allow outgoing SSH (TCP port 22). 

Testing SSH authentication...NOT OK
  • there is a temporary failure on the SMP
  • your SOP may not correctly provisioned on the SMP.

Note that this only checks that the SOP should be capable of making a connection with the SMP. It doesn't check if the connection with SMP is actually established! For that use "Subsystems > SMP Connection > View Log A". If you see the following the connection is established: 

Pseudo-terminal will not be allocated because stdin is not a terminal.

ALERT! If the connection to the SMP really does not work, the customer could temporarily establish a static port forwarding on its firewall to debug this.

(For redundancy, there are two connections to the SMP (A and B). It suffices that any the two is established.)

Shutdown and restart the SOP

If needed, you can stop the SOP by using the SOP Shell:

  • menu "System" - "Shutdown"
    • Attention : All telephony communications passing through the SOP will end
    • Wait about 1 minute for the server to shutdown.
  • To start the SOP after a shutdown, press the power button.

ALERT! Never power off the SOP without using the Shutdown function!

To simply restart the SOP:

  • menu "System" - "Reboot"
  • Attention : All telephony communications passing through the SOP will end
  • Wait about 5 minutes for the server to be rebooted.

To boot the standby partition:

  • menu "System" - "Reboot other Partition"
  • select the desired partition
    • To switch to the standby partition select the SOP partition other than the current
    • Do not choose the Maintenance partition, unless both SOP partitions fail to boot
  • Attention : All telephony communications passing through the SOP will end
  • Wait about 5 minutes for the server to be rebooted in the other partition.

Restoring network connectivity

In case you lost the connectivity to the SMP because you made an error in the network configuration, you can no longer correct it from the SMP...

To overcome this, you can temporary change the network configuration of the SOP using "Configuration > Network". You can either enter the network config manually (in case you don't have a DHCP server) or just let the SOP obtain the network config automatically from DHCP.

ALERT! After the connectivity with the SMP is restored you should correct the network settings on the SMP and reinstall the Network Module ! Otherwise most functionality (including telephony) may not work.

Ping

You may use the SOP-shell to ping some IP addresses and to check that there is :
  • no packet loss
  • not a too big jitter (variation in the delay)

This is available through the diagnostics menu / network / ping

Other resources

See the Shell module documentation
Copyright © Escaux SA