openserctl(8) - Linux man page

Name

openserctl - openser control tool

Synopsis

openserctl command [ parameters ]

Description

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

Files

/etc/openser/.openserctlrc
/usr/local/etc/openser/.openserctlrc
~/.openserctlrc

Commands

-h
Displays a short usage description, including all available options.
moni
show internal status
ps
show running processes
fifo
send raw FIFO commands
ping <uri>
ping a URI (OPTIONS)
cisco_restart <uri>: restart a Cisco phone (NOTIFY)
SUBSCRIBER management:
add <username> <password> <email>

add a new subscriber (*)

passwd <username> <passwd>

change user's password (*)

rm <username>
delete a user (*)
mail <username>
send an email to a user
alias show [<alias>]

show aliases

alias rm <alias>

remove an alias

alias add <alias> <uri>

add an aliases

rpid add <username> <rpid>

add rpid for a user (*)

rpid rm <username>

set rpid to NULL for a user (*)

rpid show <username>

show rpid of a user

alias_db show <alias>

show alias details

alias_db list <sip-id>

list aliases for uri

alias_db add <alias> <sip-id>

add an alias (*)

alias_db rm <alias>

remove an alias (*)

alias_db help
help message
speeddial show <speeddial-id>

show speeddial details

speeddial list <sip-id>

list speeddial for uri

speeddial add <sip-id> <sd-id> <new-uri> [<desc>]

add a speedial (*)

speeddial rm <sip-id> <sd-id>

remove a speeddial (*)

speeddial help
help message
AVP management:
avp list [-T table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t type]

list AVPs

avp add [-T table] <sip-id|uuid> <attribute> <type> <value>

add AVP (*)

avp rm [-T table] [-u <sip-id|uuid>] [-a attribute] [-v value] [-t type]

remove AVP (*)

avp help
help message
ACL (Access Control Lists) management
acl show [<username>]

show user membership

acl grant <username> <group>

grant user membership (*)

acl revoke <username> [<group>]

grant user membership(s) (*)

USRLOC (User Location) management
ul show [<username>]

show in-RAM online users

ul rm <username> [<contact URI>]

delete user's UsrLoc entries

ul add <username> <uri>

introduce a permanent UrLoc entry

ul add <username> <uri> <expires>

introduce a temporary UrLoc entry

showdb [<username>]

show online users flushed in DB

DOMAIN management
domain show
show list of served domains
domain add <domainname>

add a new served domain

domain rm <domainname>

remove a served domain

LCR (Least Cost Routing) management
lcr show
show routes, gateways and groups
lcr reload
reload lcr gateways
lcr addgw_grp <grp_name>

add gateway group, autocreate grp_id

lcr addgw_grp <grp_name> <grp_id>

add gateway group with grp_id

lcr rmgw_grp <grp_id>

delete the gw_grp

lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id>

add a gateway

lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> <prefix>

add a gateway with prefix

lcr addgw <gw_name> <ip> <port> <scheme> <transport> <grp_id> <prefix> <strip>

add a gateway with prefix and strip

lcr rmgw <gw_name>

delete a gateway

lcr addroute <prefix> <from> <grp_id> <prio>

add a route

lcr rmroute <prefix> <from> <grp_id> <prio>

delete a route

Notes

Commands labeled with (*) will prompt for a MySQL password. If the environment variable PW is set, the password will not be prompted.

IP addresses must be entered in dotted quad format e.g. 1.2.3.4 <uri_scheme> and <transport> must be entered in integer or text, e.g. transport '2' is identical to transport 'tcp'.
scheme: 1=sip, 2=sips; transport: 1=udp, 2=tcp, 3=tls
Examples:
lcr addgw_grp usa 1
lcr addgw level3 1.2.3.4 5080 sip tcp 1
lcr addroute +1 '' 1 1

Authors

see /usr/share/doc/openser/AUTHORS

Referenced By

openserunix(8)