.\" $Id: openserctl.8 2184 2007-05-10 05:46:43Z juhe $ .TH openserctl 8 21.06.2006 openser "OpenSER" .\" Process with .\" groff -man -Tascii openserctl.8 .\" .SH NAME openserctl \- openser control tool .SH SYNOPSIS .B openserctl .BI command [ .BI parameters ] .SH DESCRIPTION .B openserctl is a shell script to control .B OpenSER SIP server It can be used to manage users, domains, aliases and other server options .SH FILES .bL .I /etc/openser/.openserctlrc .br .I /usr/local/etc/openser/.openserctlrc .br .I ~/.openserctlrc .br .SH COMMANDS .TP 12 .B \-h Displays a short usage description, including all available options. .TP .B moni show internal status .TP .B ps show running processes .TP .B fifo send raw FIFO commands .TP .B ping ping a URI (OPTIONS) .TP .B cisco_restart restart a Cisco phone (NOTIFY) .TP 16 .I SUBSCRIBER management: .TP .B add add a new subscriber (*) .TP .B passwd change user's password (*) .TP .B rm delete a user (*) .TP .B mail send an email to a user .TP .B alias show [] show aliases .TP .B alias rm remove an alias .TP .B alias add add an aliases .TP .B rpid add add rpid for a user (*) .TP .B rpid rm set rpid to NULL for a user (*) .TP .B rpid show show rpid of a user .TP .B alias_db show show alias details .TP .B alias_db list list aliases for uri .TP .B alias_db add

add an alias (*) .TP .B alias_db rm remove an alias (*) .TP .B alias_db help help message .TP .B speeddial show show speeddial details .TP .B speeddial list list speeddial for uri .TP .B speeddial add

[] add a speedial (*) .TP .B speeddial rm

remove a speeddial (*) .TP .B speeddial help help message .TP 16 .I AVP management: .TP .B avp list [-T table] [-u ] \ [-a attribute] [-v value] [-t type] list AVPs .TP .B avp add [-T table] \ add AVP (*) .TP .B avp rm [-T table] [-u ] \ [-a attribute] [-v value] [-t type] remove AVP (*) .TP .B avp help help message .TP 16 .I ACL (Access Control Lists) management .TP .B acl show [] show user membership .TP .B acl grant grant user membership (*) .TP .B acl revoke [] grant user membership(s) (*) .TP 16 .I USRLOC (User Location) management .TP .B ul show [] show in-RAM online users .TP .B ul rm [] delete user's UsrLoc entries .TP .B ul add introduce a permanent UrLoc entry .TP .B ul add introduce a temporary UrLoc entry .TP .B showdb [] show online users flushed in DB .TP 16 .I DOMAIN management .TP .B domain show show list of served domains .TP .B domain add add a new served domain .TP .B domain rm remove a served domain .TP 16 .I LCR (Least Cost Routing) management .TP .B lcr show show routes, gateways and groups .TP .B lcr reload reload lcr gateways .TP .B lcr addgw_grp add gateway group, autocreate grp_id .TP .B lcr addgw_grp add gateway group with grp_id .TP .B lcr rmgw_grp delete the gw_grp .TP .B lcr addgw add a gateway .TP .B lcr addgw add a gateway with prefix .TP .B lcr addgw \ add a gateway with prefix and strip .TP .B lcr rmgw delete a gateway .TP .B lcr addroute add a route .TP .B lcr rmroute delete a route .SH NOTES .PP Commands labeled with (*) will prompt for a MySQL password. If the environment variable PW is set, the password will not be prompted. .PP IP addresses must be entered in dotted quad format e.g. 1.2.3.4 and must be entered in integer or text, e.g. transport '2' is identical to transport 'tcp'. .br scheme: 1=sip, 2=sips; transport: 1=udp, 2=tcp, 3=tls .br Examples: .br lcr addgw_grp usa 1 .br lcr addgw level3 1.2.3.4 5080 sip tcp 1 .br lcr addroute +1 '' 1 1 .SH AUTHORS see .B /usr/share/doc/openser/AUTHORS .SH SEE ALSO .BR openser(8), openser.cfg(5) .PP Full documentation on openser is available at .I http://www.openser.org/. .PP Mailing lists: .nf users@openser.org - openser user community .nf devel@openser.org - openser development, new features and unstable version