.\" $Id: osipsconsole.8 5891 2009-11-22 12:53:09Z alerios $ .TH osipsconsole 8 22.11.2009 opensips-console "OpenSIPS" .\" Process with .\" groff -man -Tascii osipsconsole.8 .\" .SH NAME osipsconsole \- utility for provisioning OpenSIPS .SH SYNOPSIS .B osipsconsole .B osipsconsole .BI command [ .BI parameters ] .SH DESCRIPTION .B osipsconsole is a console like utility for provisioning .B OpenSIPS SIP server. It can be used to manage users, domains, aliases and other server options. If command arguments are passed it will work in non-interactive mode, and behave as old opensipsctl and opensipsdbctl tools. If no arguments are passed, it behaves as a console - you will get a prompt, and can run the available commands, with embedded help and command history -. .SH FILES .PD 0 .I /etc/opensips/osipsconsolerc .br .I ~/.osipsconsolerc .br .SH COMMANDS .TP 12 .B help Displays a short usage description, including all available options. .TP 16 .I Command 'online' - dump online users from memory .TP 12 .B online display online users .TP 16 .I Command 'monitor' - show internal status .TP 12 .B monitor show server's internal status .TP 16 .I Command 'ping' - ping a SIP URI (OPTIONS) .TP 12 .B ping ping with SIP OPTIONS .TP 16 .I Command 'ul|alias' - manage user location or aliases .TP 12 .B ul show [] show in-RAM online users .TP .B ul show --brief show in-RAM online users in short format .TP .B ul rm [] delete user's usrloc entries .TP .B ul add introduce a permanent usrloc entry .TP .B ul add introduce a temporary usrloc entry .TP 16 .I Command 'start|stop|restart' .TP 12 .B restart restart OpenSIPS .TP .B start start OpenSIPS .TP .B stop stop OpenSIPS .TP 16 .I Command 'tls' .TP 12 .B tls rootCA [] creates new rootCA .TP .B tls userCERT [] creates user certificate default is /usr/local/etc/opensips/tls .TP 16 .I Command 'acl' - manage access control lists (acl) .TP 12 .B acl show [] show user membership .TP .B acl grant grant user membership (*) .TP .B acl revoke [] revoke user membership(s) (*) .TP 16 .I Command 'cr' - manage carrierroute tables .TP 12 .B cr show show tables .TP .B cr reload reload tables .TP .B cr dump show in memory tables .TP .B cr addrt add a tree .TP .B cr rmrt rm a tree .TP cr addcarrier [] [] [] [] [] [] [] add a carrier .TP .B cr rmcarrier rm a carrier .TP 16 .I Command 'rpid' - manage Remote-Party-ID (RPID) .TP 12 .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 16 .I Command 'add|passwd|rm' - manage subscribers .TP 12 .B add add a new subscriber (*) .TP .B passwd change user's password (*) .TP .B rm delete a user (*) .TP 16 .I Command 'add|dump|reload|rm|show' - manage address .TP 12 .B address show show db content .TP .B address dump show cache content .TP .B address reload reload db table into cache .TP .B address add [] [] add a new entry .B address rm remove all entries for the given grp ip mask and port .TP 16 .I Command 'dispatcher' - manage dispatcher .TP 12 .B dispatcher show show dispatcher gateways .TP .B dispatcher reload reload dispatcher gateways .TP .B dispatcher dump show in memory dispatcher gateways .TP .B dispatcher addgw add gateway .TP .B dispatcher rmgw delete gateway .TP 16 .I Command 'db' - database operations .TP 12 .B db exec execute SQL query .TP .B db roexec execute read-only SQL query .TP .B db run execute SQL query from $id variable .TP .B db rorun execute read-only SQL query from $id variable .TP .B db show display table content .TP 16 .I Command 'speeddial' - manage speed dials (short numbers) .TP 12 .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 Command 'avp' - manage AVPs .TP 12 .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 Command 'alias_db' - manage database aliases .TP 12 .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 16 .I Command 'domain' - manage local domains .TP 12 .B domain reload reload domains from disk .TP .B domain show show current domains in memory .TP .B domain showdb show domains in the database .TP .B domain add add the domain to the database .TP .B domain rm delete the domain from the database .TP 16 .I Command 'fifo' .TP 12 .B fifo send raw FIFO command .TP 16 .I Command 'dialplan' - manage dialplans .TP 12 .B dialplan show show dialplan tables .TP .B dialplan reload reload dialplan tables .TP .B dialplan addrule add a rule .TP .B dialplan rm removes the entire dialplan table .TP .B dialplan rmdpid removes all the given dpid entries .TP .B dialplan rmrule removes all the given dpid/prio entries .TP 16 .I Command 'unixsock' .TP 12 .B unixsock send raw unixsock command .TP 16 .I Command 'droute' .TP 12 .B dr gateway add [] [] [] [] adds new route .TP .B dr gateway rm removes route .TP .B dr gateway list lists route(s) .TP .B dr gateway list lists route(s) .TP .B dr gateway list lists all routes .TP .B dr gateway h droute help .TP .B dr rules add [][] [][][][] adds new rule(s) .TP .B dr rules rm removes rules .TP .B dr rules list lists rules(s) .TP .B dr rules list lists rules(s) .TP .B dr rules list lists rules(s) .TP .B dr rules h dr rules help .TP .B dr h dr help .TP 16 .I Databases management: .TP 12 .B db create .TP creates a new database .B db presence adds the presence related tables .TP .B db extra adds the extra tables .TP .B db migrate migrates DB from 1.5 to 1.6 .TP .B db drop !entirely deletes tables! .TP .B db reinit !entirely deletes and than re-creates tables! .TP .B db backup dumps current database to file .TP .B db restore restores tables from a file .TP .B db copy creates a new db from an existing one .TP 16 .I Berkeley DB tables management: .TP 12 .B bdb | db_berkeley list lists the underlying db files in DB_PATH .TP .B bdb | db_berkeley cat db_dump the underlying db file to STDOUT .TP .B bdb | db_berkeley swap installs db.new by db -> db.old; db.new -> db .TP .B bdb | db_berkeley append appends data to an existing db;output DB_PATH/db.new .TP .B bdb | db_berkeley newappend appends data to a new instance of db; output DB_PATH/db.new .TP .B bdb | db_berkeley export exports table data to plain-txt files in dump_dir .TP .B bdb | db_berkeley import imports plain-txt table data and creates new db tables in db_path .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 .SH AUTHORS see .B /usr/share/doc/opensips/AUTHORS .PP This manual page was written by Alejandro Rios P. , based on opensipsctl manpage by Bogdan-Andrei Iancu , for the Debian project (and may be used by others). .SH SEE ALSO .BR opensips(8), opensips.cfg(5), opensipsctl(8), osipsconfig(8) .PP Full documentation on opensips is available at .I http://www.opensips.org/. .PP Mailing lists: .nf users@lists.opensips.org - opensips user community .nf devel@lists.opensips.org - opensips development, new features and unstable version