1opensipsctl(8) OpenSIPS opensipsctl(8)
2
6 opensipsctl - opensips control tool
7
9 opensipsctl command [ parameters ]
10
13 opensipsctl is a shell script to control OpenSIPS SIP server It can be
14 used to manage users, domains, aliases and other server options
15
18 /etc/opensips/.opensipsctlrc
19 /usr/local/etc/opensips/.opensipsctlrc
20 ~/.opensipsctlrc
21
23 -h Displays a short usage description, including all available
24 options.
25 moni show internal status
26 ps show running processes
27 fifo send raw FIFO commands
28 ping <uri> ping a URI (OPTIONS)
29 cisco_restart <uri>
30 restart a Cisco phone (NOTIFY)
31 SUBSCRIBER management:
32 add <username> <password>
33 add a new subscriber (*)
34 passwd <username> <passwd>
35 change user's password (*)
36 rm <username> delete a user (*)
37 alias show [<alias>]
38 show aliases
39 alias rm <alias>
40 remove an alias
41 alias add <alias> <uri>
42 add an aliases
43 rpid add <username> <rpid>
44 add rpid for a user (*)
45 rpid rm <username>
46 set rpid to NULL for a user (*)
47 rpid show <username>
48 show rpid of a user
49 alias_db show <alias>
50 show alias details
51 alias_db list <sip-id>
52 list aliases for uri
53 alias_db add <alias> <sip-id>
54 add an alias (*)
55 alias_db rm <alias>
56 remove an alias (*)
57 alias_db help help message
58 dispatcher show show dispatcher gateways
59 dispatcher reload
60 reload dispatcher gateways
61 dispatcher dump show in memory dispatcher gateways
62 dispatcher addgw <setid> <destination> <socket> <flags> <weight>
63 <attrs> [description]
64 add gateway
65 dispatcher rmgw <id>
66 delete gateway
67 speeddial show <speeddial-id>
68 show speeddial details
69 speeddial list <sip-id>
70 list speeddial for uri
71 speeddial add <sip-id> <sd-id> <new-uri> [<desc>]
72 add a speedial (*)
73 speeddial rm <sip-id> <sd-id>
74 remove a speeddial (*)
75 speeddial help help message
76 AVP management:
77 avp list [-T table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t
78 type]
79 list AVPs
80 avp add [-T table] <sip-id|uuid> <attribute> <type> <value>
81 add AVP (*)
82 avp rm [-T table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t
83 type]
84 remove AVP (*)
85 avp help help message
86 ACL (Access Control Lists) management
87 acl show [<username>]
88 show user membership
89 acl grant <username> <group>
90 grant user membership (*)
91 acl revoke <username> [<group>]
92 grant user membership(s) (*)
93 USRLOC (User Location) management
95 ul show [<username>]
96 show in-RAM online users
97 ul rm <username> [<contact URI>]
98 delete user's UsrLoc entries
99 ul add <username> <uri>
100 introduce a permanent UrLoc entry
101 ul add <username> <uri> <expires>
102 introduce a temporary UrLoc entry
103 showdb [<username>]
104 show online users flushed in DB
105 DOMAIN management
106 domain show show list of served domains
107 domain add <domainname>
108 add a new served domain
109 domain rm <domainname>
110 remove a served domain
111
113 Commands labeled with (*) will prompt for a MySQL password. If the
114 environment variable PW is set, the password will not be prompted.
115 IP addresses must be entered in dotted quad format e.g. 1.2.3.4
116
118 see /usr/share/doc/opensips/AUTHORS
119
121 opensips(8),[22mopensips.cfg(5)
122 Full documentation on opensips is available at http://www.open‐
123 sips.org/.
124 Mailing lists:
125 users@opensips.org - opensips user community
126 devel@opensips.org - opensips development, new features and unstable version
127opensips 21.06.2006 opensipsctl(8)