1sipwitchctl(1) GNU Telephony sipwitchctl(1)
2
6 sipwitch - script control and manage GNU sipwitch server.
7
9 sipwitchctl command [arguments...]
10
12 The sipwitchctl 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 abort terminate running daemon with core for debugging.
22 activate ext ipaddr
24 register a static sip extension manually on a fixed address.
25 calls list active call sessions on the server.
27 check verify running daemon for deadlocks or other problems.
29 concurrency level
31 set concurrency level of the daemon. See pthread_setconcur‐
32 rency.
33 contact
36 return server contact address for autoconfig.
37 digest userid [realm [type]]
39 compute a sip digest for the server realm.
40 disable conf-id...
42 remove /etc/sipwitch.d configurations.
43 down stop and shutdown the running sipwitch daemon.
45 drop user|callid
47 drop specified calls either by a user or call id.
48 dump dump server configuration to stdout.
50 enable conf-id...
52 enable /etc/sipwitch.d configurations.
53 events display server events as received.
55 grant group
57 grants directory access to system group.
58 history [size]
60 set size or dump recent error log history.
61 ifdown iface
63 notify server interface went down.
64 ifup iface
66 notify server interface came up.
67 message ext ``Text''
69 send a short text message to a registered extension.
70 policy print access policy list and peering (published)
72 addresss.
73 period interval
75 dump periodic stats for specified minute interval, often
76 used for cron.
77 pstats dump server periodic statistics. See ``stats''.
79 registry
81 dump all user agent registrations to stdout.
82 realm [new-realm [digest-type]]
84 set or show the server realm.
85 release ext
87 deactivate an extension registered with the daemon.
88 reload load server configuration while live.
90 restart
92 force server restart.
93 siplog dump sip messages from when trace is enabled.
95 snapshot
97 create snapshot diagnostic file from daemon.
98 state id
100 set daemon to specified state id.
101 stats dump server call statistics.
103 status server mapped call status list.
105 trace on|off|clear
107 Set or clear server sip message tracing.
108 usercache
110 dump user cache.
111 verbose level
113 set daemon error logging verbosity.
114
116 Normally exit status is 0 if the request was successfully pro‐
117 cessed by the sipwitch service daemon. An exit status of 0x
118 indicates an error in the sipwitch utility, such as invalid
119 argument parsing. An error of 1x indicates some communication
120 failure with the server, and a error of 2x is related to errors
121 on server processed requests.
122
124 sipwitch was written by David Sugar <dyfet@gnutelephony.org>.
125
127 Report bugs to sipwitch-devel@gnu.org or bugs@gnutelephony.org.
128
130 Copyright © 2009-2014 David Sugar, Tycho Softworks.
131 This is free software; see the source for copying conditions.
132 There is NO warranty; not even for MERCHANTABILITY or FITNESS
133 FOR A PARTICULAR PURPOSE.
134GNU SIP Witch January 2009 sipwitchctl(1)