1sipwitch(1)                      GNU Telephony                     sipwitch(1)
2
3
4

NAME

6       sipwitch - script control and manage GNU sipwitch server.
7

SYNOPSIS

9       sipwitch command [arguments...]
10

DESCRIPTION

12       The  sipwitch  command  allows  one to interact with a running sipwitch
13       daemon instance on the current machine.  This can  be  used  to  create
14       management  shell scripts or to perform basic service operations, using
15       the sipwitch fifo control interface.  Normally this  command  would  be
16       used only by root or someone in an admin group that the sipwitch daemon
17       is running under.  If the sipwitch daemon is  started  by  an  ordinary
18       user,  the  command can be used by the same user to control that daemon
19       instance.
20
21       abort  terminate running daemon with core for debugging.
22
23       activate ext ipaddr
24              register a static sip extension manually on a fixed address.
25
26       calls  list active call sessions on the server.
27
28       check  verify running daemon for deadlocks or other problems.
29
30       concurrency level
31              set concurrency level of  the  daemon.   See  pthread_setconcur‐
32              rency.
33
34       down   stop and shutdown the running sipwitch daemon.
35
36       drop user|callid
37              drop specified calls either by a user or call id.
38
39       dump   dump server configuration to stdout.
40
41       history [size]
42              set size or dump recent error log history.
43
44       ifdown iface
45              notify server interface went down.
46
47       ifup iface
48              notify server interface came up.
49
50       message ext ``Text''
51              send a short text message to a registered extension.
52
53       period interval
54              dump  periodic  stats  for specified minute interval, often used
55              for cron.
56
57       pstats dump server periodic statistics.  See ``stats''.
58
59       registry
60              dump all user agent registrations to stdout.
61
62       release ext
63              deactivate an extension registered with the daemon.
64
65       reload load server configuration while live.
66
67       restart
68              force server restart.
69
70       siplog dump sip messages from when trace is enabled.
71
72       snapshot
73              create snapshot diagnostic file from daemon.
74
75       state id
76              set daemon to specified state id.
77
78       stats  dump server call statistics.
79
80       status server mapped call status list.
81
82       trace on|off|clear
83              Set or clear server sip message tracing.
84
85       verbose level
86              set daemon error logging verbosity.
87

EXIT STATUS

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

AUTHOR

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

REPORTING BUGS

99       Report bugs to sipwitch-devel@gnu.org.
100

102       Copyright © 2009 David Sugar, Tycho Softworks.
103       This is free software; see the source for copying conditions.  There is
104       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
105       PURPOSE.
106
107
108
109
110GNU SIP Witch                    January 2009                      sipwitch(1)
Impressum