You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/utils/kamctl/kamctl.ctlbase

101 lines
2.4 KiB

#
# $Id$
#
# control tool for maintaining Kamailio
#
#===================================================================
[ "${IMPCTLBASE}" = "yes" ] && return
export IMPCTLBASE="yes"
##### ----------------------------------------------- #####
### common variables and functions for CTL engines
#
# period in which stats are reprinted
if [ -z "$WATCH_PERIOD" ] ; then
WATCH_PERIOD=2
fi
#
##### ------------------------------------------------ #####
### usage functions
#
usage_cisco_restart() {
echo
mecho " -- command 'cisco_restart' - restart CISCO phone (NOTIFY)"
echo
cat <<EOF
cisco_restart <uri> ................ restart phone configured for <uri>
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_cisco_restart"
usage_online() {
echo
mecho " -- command 'online' - dump online users from memory"
echo
cat <<EOF
online ............................. display online users
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_online"
usage_kamailio_monitor() {
echo
mecho " -- command 'monitor' - show internal status"
echo
cat <<EOF
monitor ............................ show server's internal status
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_kamailio_monitor"
usage_ping() {
echo
mecho " -- command 'ping' - ping a SIP URI (OPTIONS)"
echo
cat <<EOF
ping <uri> ......................... ping <uri> with SIP OPTIONS
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_ping"
usage_usrloc() {
echo
mecho " -- command 'ul|alias' - manage user location or aliases"
echo
cat <<EOF
ul show [<username>]................ show in-RAM online users
ul show --brief..................... show in-RAM online users in short format
ul rm <username> [<contact URI>].... delete user's usrloc entries
ul add <username> <uri> ............ introduce a permanent usrloc entry
ul add <username> <uri> <expires> .. introduce a temporary usrloc entry
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_usrloc"
usage_ctlcommon() {
echo
mecho " -- command 'ps' - print details about running processes"
echo
cat <<EOF
ps ................................. details about running processes
EOF
echo
mecho " -- command 'uptime' - print uptime details"
echo
cat <<EOF
uptime ............................. print start time end elapsed seconds
EOF
echo
mecho " -- command 'stats' - print internal statistics"
echo
cat <<EOF
stats [group]....................... dump all or a group of internall statistics
EOF
}
USAGE_FUNCTIONS="$USAGE_FUNCTIONS usage_ctlcommon"