ParaChat Admin Server Commands

Home >>> Web-Based Administration >>> Admin Server Commands
Overview


Using Your ParaChat Server's Admin Server To Execute Commands Remotely

You may telnet to your ParaChat Server's Admin Server to execute a variety of server commands (a list of commands is located below). To access and use the Admin Server, please follow these steps:

1. Use your favorite telnet application and telnet to your host machine.

    Using a dos window remotely:

      telnet <machine IP or domain name> <adminport>

      Example:

        telnet 192.168.1.1 7888

    Using a dos window locally:

      telnet localhost <adminport>

      Example:

        telnet localhost 7888

For example, if your machine is called "mymachine.com", and the Admin Server port is configured to 7778, the proper convention would be:

    telnet mymachine.com 7778
 NOTE:  As a security precaution, your ParaChat Server Admin Server port is set to 0 (zero) by default. If you intend on utilizing the Admin Server, we highly recommend changing the default password. Please note that any change to the pchatd.conf file requires that you restart the chat server for the change to be implemented. To specify the admin server port, and password, open the pchatd.conf file (..ParaChat/ParaChat570/config/pchatd.conf).

    In the #pchatd parameters section, you will see:

      pchatd.adminpasswd=<randomly set during install process>
      pchatd.adminport=0

      The admin port is disabled until you set it to a new port number. ( 0 = disabled )

2. Type your password (assume the password you set is "nickle"):

    passwd nickle
3. Your password is accepted:

    password: true
4. Execute admin server commands
    A list of server commands can be found below
 NOTE:  Typing an empty line at any time exits the admin server.
There is no "help" and nothing works until you type in a legal "passwd" command.
These designs are intentional, to protect against curious hackers. You may also consider using a firewall to protect this admin port.


Command
Function
passwd <adminpassword> Enter password for admin (must be first command)
echo string Prints the string 'string' (to test server)
status Dumps status information

Example:
Channel Manager: Number of Channels is 150
Auth Manager: Number of Logins is 975
Session Manager: Session count:975, max: 6500, min: 0

freemem Prints available memory
totalmem Lists the total memory used
garbage Forces asynchronous garbage collect (to reclaim memory)
readbanlist Read the server-wide list of banned users for this server
dumpthreads Prints a (very long!) list of all the active threads in the system
bcast <message> Broadcasts the 'message' server-wide
killroom <roomname> <reason> Kills a specific room and displays the reason
listlogs Gives a list of the root -> extended filenames being logged

Example:
slogs/connect.log -> slogs/connect.log.970907234829

rotate <rootfilename>

Rotates the log, creating a new log with the same root file name but a new time stamp extension

Example:
rotate slogs/connect.log
Returns the message below:
Log slogs/connect.log rotated. New log is slogs/connect.log.970908234555'

The earlier log file slogs/connect.log.970907234829 can now be removed or compressed as needed.


©1996 - 2006   M Square, Inc. |  Privacy Policy