Man Linux: Main Page and Category List

NAME

       sipwitch - script control and manage GNU sipwitch server.

SYNOPSIS

       sipwitch command [arguments...]

DESCRIPTION

       The  sipwitch  command  allows  one to interact with a running sipwitch
       daemon instance on the current machine.  This can  be  used  to  create
       management  shell scripts or to perform basic service operations, using
       the sipwitch fifo control interface.  Normally this  command  would  be
       used only by root or someone in an admin group that the sipwitch daemon
       is running under.  If the sipwitch daemon is  started  by  an  ordinary
       user,  the  command can be used by the same user to control that daemon
       instance.

       abort  terminate running daemon with core for debugging.

       activate ext ipaddr
              register a static sip extension manually on a fixed address.

       calls  list active call sessions on the server.

       check  verify running daemon for deadlocks or other problems.

       concurrency level
              set    concurrency     level     of     the     daemon.      See
              pthread_setconcurrency.

       down   stop and shutdown the running sipwitch daemon.

       drop user|callid
              drop specified calls either by a user or call id.

       dump   dump server configuration to stdout.

       history [size]
              set size or dump recent error log history.

       ifdown iface
              notify server interface went down.

       ifup iface
              notify server interface came up.

       message ext ``Text''
              send a short text message to a registered extension.

       period interval
              dump  periodic  stats  for specified minute interval, often used
              for cron.

       pstats dump server periodic statistics.  See ``stats''.

       registry
              dump all user agent registrations to stdout.

       release ext
              deactivate an extension registered with the daemon.

       reload load server configuration while live.

       restart
              force server restart.

       siplog dump sip messages from when trace is enabled.

       snapshot
              create snapshot diagnostic file from daemon.

       state id
              set daemon to specified state id.

       stats  dump server call statistics.

       status server mapped call status list.

       trace on|off|clear
              Set or clear server sip message tracing.

       verbose level
              set daemon error logging verbosity.

EXIT STATUS

       Normally exit status is 0 if the request was successfully processed  by
       the sipwitch service daemon.  An exit status of 1 indicates the request
       timed out and 2 indicates  the  server  is  offline.   If  the  request
       failed,  then  a 3 is returned.  A 255 (-1) indicates a syntax error in
       the command request or arguments.

AUTHOR

       sipwitch was written by David Sugar <dyfet@gnutelephony.org>.

REPORTING BUGS

       Report bugs to sipwitch-devel@gnu.org.

COPYRIGHT

       Copyright (C) 2009 David Sugar, Tycho Softworks.
       This is free software; see the source for copying conditions.  There is
       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE.