opensipsctl(8)

1opensipsctl(8)                     OpenSIPS                     opensipsctl(8)
2
3
4

NAME

6       opensipsctl - opensips control tool
7

SYNOPSIS

9       opensipsctl command [ parameters ]
10
11

DESCRIPTION

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
16

FILES

18       /etc/opensips/.opensipsctlrc
19       /usr/local/etc/opensips/.opensipsctlrc
20       ~/.opensipsctlrc
21

COMMANDS

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       speeddial show <speeddial-id>
59                       show speeddial details
60       speeddial list <sip-id>
61                       list speeddial for uri
62       speeddial add <sip-id> <sd-id> <new-uri> [<desc>]
63                       add a speedial (*)
64       speeddial rm <sip-id> <sd-id>
65                       remove a speeddial (*)
66       speeddial help  help message
67       AVP management:
68       avp  list  [-T  table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t
69       type]
70                       list AVPs
71       avp add [-T table] <sip-id|uuid> <attribute> <type> <value>
72                       add AVP (*)
73       avp rm [-T table] [-u <sip-id|uuid>]  [-a  attribute]  [-v  value]  [-t
74       type]
75                       remove AVP (*)
76       avp help        help message
77       ACL (Access Control Lists) management
78       acl show [<username>]
79                       show user membership
80       acl grant <username> <group>
81                       grant user membership (*)
82       acl revoke <username> [<group>]
83                       grant user membership(s) (*)
84
85       USRLOC (User Location) management
86       ul show [<username>]
87                       show in-RAM online users
88       ul rm <username> [<contact URI>]
89                       delete user's UsrLoc entries
90       ul add <username> <uri>
91                       introduce a permanent UrLoc entry
92       ul add <username> <uri> <expires>
93                       introduce a temporary UrLoc entry
94       showdb [<username>]
95                       show online users flushed in DB
96       DOMAIN management
97       domain show     show list of served domains
98       domain add <domainname>
99                       add a new served domain
100       domain rm <domainname>
101                       remove a served domain
102

NOTES

104       Commands  labeled  with  (*)  will prompt for a MySQL password.  If the
105       environment variable PW is set, the password will not be prompted.
106       IP addresses must be entered in dotted quad format e.g. 1.2.3.4
107

AUTHORS

109       see /usr/share/doc/opensips/AUTHORS
110