openserctl(8)

1openserctl(8)                       OpenSER                      openserctl(8)
2
3
4

NAME

6       openserctl - openser control tool
7

SYNOPSIS

9       openserctl command [ parameters ]
10
11

DESCRIPTION

13       openserctl  is  a  shell script to control OpenSER SIP server It can be
14       used to manage users, domains, aliases and other server options
15
16

FILES

18       /etc/openser/.openserctlrc
19       /usr/local/etc/openser/.openserctlrc
20       ~/.openserctlrc
21
22

COMMANDS

24       -h          Displays a short usage description, including all available
25                   options.
26
27       moni        show internal status
28
29       ps          show running processes
30
31       fifo        send raw FIFO commands
32
33       ping <uri>  ping a URI (OPTIONS)
34
35       cisco_restart <uri>
36                   restart a Cisco phone (NOTIFY)
37
38       SUBSCRIBER management:
39
40       add <username> <password> <email>
41                       add a new subscriber (*)
42
43       passwd <username> <passwd>
44                       change user's password (*)
45
46       rm <username>   delete a user (*)
47
48       mail <username> send an email to a user
49
50       alias show [<alias>]
51                       show aliases
52
53       alias rm <alias>
54                       remove an alias
55
56       alias add <alias> <uri>
57                       add an aliases
58
59       rpid add <username> <rpid>
60                       add rpid for a user (*)
61
62       rpid rm <username>
63                       set rpid to NULL for a user (*)
64
65       rpid show <username>
66                       show rpid of a user
67
68       alias_db show <alias>
69                       show alias details
70
71       alias_db list <sip-id>
72                       list aliases for uri
73
74       alias_db add <alias> <sip-id>
75                       add an alias (*)
76
77       alias_db rm <alias>
78                       remove an alias (*)
79
80       alias_db help   help message
81
82       speeddial show <speeddial-id>
83                       show speeddial details
84
85       speeddial list <sip-id>
86                       list speeddial for uri
87
88       speeddial add <sip-id> <sd-id> <new-uri> [<desc>]
89                       add a speedial (*)
90
91       speeddial rm <sip-id> <sd-id>
92                       remove a speeddial (*)
93
94       speeddial help  help message
95
96       AVP management:
97
98       avp  list  [-T  table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t
99       type]
100                       list AVPs
101
102       avp add [-T table] <sip-id|uuid> <attribute> <type> <value>
103                       add AVP (*)
104
105       avp rm [-T table] [-u <sip-id|uuid>]  [-a  attribute]  [-v  value]  [-t
106       type]
107                       remove AVP (*)
108
109       avp help        help message
110
111       ACL (Access Control Lists) management
112
113       acl show [<username>]
114                       show user membership
115
116       acl grant <username> <group>
117                       grant user membership (*)
118
119       acl revoke <username> [<group>]
120                       grant user membership(s) (*)
121
122
123       USRLOC (User Location) management
124
125       ul show [<username>]
126                       show in-RAM online users
127
128       ul rm <username> [<contact URI>]
129                       delete user's UsrLoc entries
130
131       ul add <username> <uri>
132                       introduce a permanent UrLoc entry
133
134       ul add <username> <uri> <expires>
135                       introduce a temporary UrLoc entry
136
137       showdb [<username>]
138                       show online users flushed in DB
139
140       DOMAIN management
141
142       domain show     show list of served domains
143
144       domain add <domainname>
145                       add a new served domain
146
147       domain rm <domainname>
148                       remove a served domain
149
150       LCR (Least Cost Routing) management
151
152       lcr show        show routes, gateways and groups
153
154       lcr reload      reload lcr gateways
155
156       lcr addgw_grp <grp_name>
157                       add gateway group, autocreate grp_id
158
159       lcr addgw_grp <grp_name> <grp_id>
160                       add gateway group with grp_id
161
162       lcr rmgw_grp <grp_id>
163                       delete the gw_grp
164
165       lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id>
166                       add a gateway
167
168       lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> <prefix>
169                       add a gateway with prefix
170
171       lcr  addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> <prefix>
172       <strip>
173                       add a gateway with prefix and strip
174
175       lcr rmgw <gw_name>
176                       delete a gateway
177
178       lcr addroute <prefix> <from> <grp_id> <prio>
179                       add a route
180
181       lcr rmroute <prefix> <from> <grp_id> <prio>
182                       delete a route
183
184

NOTES

186       Commands labeled with (*) will prompt for a  MySQL  password.   If  the
187       environment variable PW is set, the password will not be prompted.
188
189       IP  addresses  must  be  entered  in  dotted  quad  format e.g. 1.2.3.4
190       <uri_scheme> and <transport> must be entered in integer or  text,  e.g.
191       transport '2' is identical to transport 'tcp'.
192       scheme: 1=sip, 2=sips;   transport: 1=udp, 2=tcp, 3=tls
193       Examples:
194       lcr addgw_grp usa 1
195       lcr addgw level3 1.2.3.4 5080 sip tcp 1
196       lcr addroute +1 '' 1 1
197
198

AUTHORS

200       see /usr/share/doc/openser/AUTHORS
201
202