Manage Media Server with AdminCLI console tool

The Media Server is the server that runs the Debian Linux-based part of the Zylinc solution. The Media Server answers calls to queues, plays music on hold, makes interactive voice response menus work, etc. The Media Server also hosts the Administration Portal in a Tomcat service that runs on the Linux operating system.

The Media Server was previously known as ZyCall Switch Server.

You can use the command line-based management console tool AdminCLI to manage the Media Server. The AdminCLI tool is especially useful for the tasks listed in the following.

Note that the Media Server also has a web-based management console tool, the qAdmin tool, which we recommend for other tasks. See Manage Media Server with web-based qAdmin tool.

The Media Server console (AdminCLI) is useful when you need to:

  • Install a new Media Server

  • View the version of the Media Server and the version of various software components of the Media Server

  • View a system summary, for example network configuration

  • Work with SIP logging to troubleshoot problems that relate to voice queue calls

  • Collect log files for a Zylinc support issue

  • Monitor the Media Server

  • Change passwords

  • Ping from the Media Server

  • Check open network port on other servers as seen from the Media Server

  • Change network routing table

To use Media Server console (AdminCLI), you can connect to the console of the virtual server.

  • Log in as admin with the Unix password that you specified when you installed the Media Server.

Alternatively, you can use any SSH telnet client, for example Putty, to remotely connect to Media Server console (AdminCLI).

  • To install and set up putty, see Prepare the environment

  • For an example that shows how to connect and use the h command to show a list of all available AdminCLIcommands, see Install ISO image on Media Server

  • To view AdminCLI commands in a web browser:

    1. In a web browser, open an URL similar to http://<mediaserver>:8080/cgi-bin/zyqadmin.pl
    2. Log in as Admin with the Media Server tomcat password
    3. In the menu box, select Help (AdminCLI)

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type tools ping

  3. Type the host name or IP address, for example: winappserver

You cab use AdminCLI to check if a port on another host responds, as seen from the Media Server's perspective. This is useful when you need to test if a firewall or network routing issue prevents the Media Server from connecting to specific ports on other hosts.

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type tools hostport

  3. Type the hostname or IP address, for example: winappserver

  4. Type the destination port number, for example: 1433

  5. You can now see if the specified port on the specified host appears to be open or closed, as seen from the Media Server

To view current DTMF mode:

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type dtmf_mode

  3. You can now see the current DTMF mode

To change Media Server DTMF mode between for example RFC2833, in-band, SIP-info, or auto:

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type dtmf_mode

  3. Type the number of the mode that you want

  4. Type a to save and apply your change

This is useful if the Administration Portal runs slowly or becomes unresponsive.

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type 5tomcatmem

  3. You can now view the current max memory setting

  4. Type hm

  5. Enter a new value for max memory

  6. Type a to save and apply your change

When you have just installed Zylinc in a new environment, and need to carry out a reboot test, it's a good idea to restart the Media Server to make sure that your Zylinc system is able to restart correctly.

It's also a good idea to restart the Media Server when you've made advanced changes to the system configuration, for example if you change hostname, IP address, or DNS domain for a SQL Server, Zylinc Windows Application Server, or the Media Server itself, or if you change database names, instances, ports, or database connection user names or passwords.

In very rare cases, a restart of the Media Server may bring an unresponsive system back to a normal running state.

To restart the Media Server:

  1. Log in to Media Server console (AdminCLI) as admin.

  2. Type tomcat reboot

  3. Type y when you see the text: Warning: This will reboot the system. Are you sure you want to continue (y/*)?

If the Administration Portal becomes unresponsive, or runs slowly, restart the Tomcat service on Media Server. Asterisk will keep running, and no calls will be disconnected. Only active users of the Administration Portal will be affected.

To restart Tomcat on Media Server:

  1. Log in to the Media Server console (AdminCLI) as admin.

  2. Type tomcat restart

  3. Type y when you see the text: Warning: This will restart the Tomcat server. Are you sure you want to continue (y/*)?

If you use a virtualization environment from VMWare, it's a good idea to install VMWare tools on Media Server.

VMWare tools will enhance the performance of the Media Server and improve management of the virtual server.

To install VMWare tools on Media Server:

The Media Server will reboot during the installation, so you should install VMWare tools in a service window, when no users or calls are active.

  1. Log in to the Media Server console (AdminCLI) as admin

  2. Type system vmware to go the VMWare section of the shell

  3. You can see a numbered list of different VMWare tools versions on the screen

  4. Type the number of the version of VMWare tools that you want to install

  5. Type i to initiate the installation

  6. Type y to confirm that the server will restart