KAOSv 2.12.0

kv.addCommand - Add command

1. Command name STRING
2. Command description STRING
3. Handler function name STRING
4. Do not require root for execute BOOLEAN OPTIONAL

Example:

kv.AddCommand "check" "Check config value" "myCheckFunc" true

kv.AddCommand "kill" "Kill connections" "myKillFunc"

kv.addHandler - Add handler for start/stop/restart/status command

1. Command name STRING
2. Handler STRING
3. Type of handler (pre/post/default) STRING

kv.addCommandAlias - Add alias for command

1. Command name STRING
2. Alias name STRING

Example:

kv.addCommandAlias "test" "check"

kv.addCommandArgs - Add some vars for command showed in info

1. Command STRING
*. Vars STRING

Example:

kv.addCommandArgs "stop" "force"

kv.disableOutputRedirect - Disable automatic output redirection

1. Handler name STRING
2. Type of handler (pre/post/default) STRING

kv.readSysconfig - Eval values from sysconfig

1. Name of sysconfig file STRING OPTIONAL

kv.run - Exec command

*. Command STRING

Code: 0 - ok, 1 - not ok

Example:

local status=$(kv.run "/bin/echo" "1234" "ABCD")

if [[ $status -eq 0 ]] ; then

  return $ACTION_OK

else

  return $ACTION_ERROR

fi

kv.runAs - Exec command as some user

1. User STRING
*. Command

Code: 0 - ok, 1 - not ok

Example:

kv.runAs "someuser" "/bin/echo" "1234" "ABCD"

if [[ $? -eq 0 ]] ; then

  return $ACTION_OK

else

  return $ACTION_ERROR

fi

kv.daemonize - Daemonize process

1. Binary STRING
*. Command arguments

Code: 0 - ok, 1 - not ok

Example:

kv.daemonize "/usr/bin/daemon" "-d" "-p 80" "-v"

if [[ $? -eq 0 ]] ; then

  return $ACTION_OK

else

  return $ACTION_ERROR

fi

kv.start - Execute default start handler

*. Any arguments

Code: 0 - ok, 1 - not ok

kv.stop - Execute default stop handler

*. Any arguments

Code: 0 - ok, 1 - not ok

kv.restart - Execute default restart handler

*. Any arguments

Code: 0 - ok, 1 - not ok

kv.status - Execute default status handler

*. Any arguments

Code: 0 - ok, 1 - not ok

kv.usage - Execute default usage handler

*. Any arguments

Code: 0 - ok, 1 - not ok

kv.requireRoot - Require root privileges, if user is not a root, exit with error status

kv.statusIs - Return 0 if service in defined status

1. Status NUMBER OPTIONAL

Code: 0 - ok, 1 - not ok

kv.getStatus - Get status for service

Echo: Status code NUMBER

kv.getPid - Get or find pid

Echo: Pid NUMBER

Example:

local pid=$(kv.getPid)

kv.sendSignal $pid

kv.findPid - Find pid for service

1. Search pattern STRING OPTIONAL

Echo: Pid NUMBER

Example:

local pid=$(kv.findPid "service -c /etc/config.conf")

kv.showProcessMessage - Show message about action in progress

1. Message STRING

Example:

kv.showProcessMessage "Generating data"

kv.showStatusMessage $ACTION_OK

kv.showStatusMessage - Show status of previus action

1. Status code NUMBER

Example:

kv.showProcessMessage "Generating data"

kv.showStatusMessage $ACTION_OK

kv.getStartStatus - Get status of starting service

1. Path to pid file STRING OPTIONAL
2. Don't check process status BOOLEAN OPTIONAL

Code: 0 - ok, 1 - not ok

Example:

if ! kv.getStartStatus ; then

  kv.error "Can't start service"

fi

kv.getStopStatus - Get status of stopping service

1. Pid NUMBER OPTIONAL

Code: 0 - ok, 1 - not ok

Example:

if kv.getStopStatus $pid ; then

  return $ACTION_OK

else

  kv.killProcess $pid

  return $ACTION_FORCED

fi

kv.killProcess - Kill service process

1. Pid NUMBER OPTIONAL

kv.isProcExist - Return 0 if process with specified pid exist

1. Pid NUMBER

Code: 0 - ok, 1 - not ok

Example:

if kv.isProcExist 12345 ; then

  kv.error "Process with pid 12345 is not exist"

fi

kv.hasUser - Return 0 if user exists on the system

1. Username STRING

Code: 0 - ok, 1 - not ok

Example:

if ! kv.hasUser "serviceuser" ; then

  kv.error "User serviceuser is not exist!"

fi

kv.isBoundPort - Check that port is bound (occupied by another process)

1. Port NUMBER

Code: 0 - ok, 1 - not ok

Example:

if kv.isBoundPort 8080 ; then

  kv.error "Port 8080 is bound"

fi

kv.isServiceWorks - Check that service is works

1. Service name STRING

Code: 0 - ok, 1 - not ok

Example:

if kv.isServiceWorks "nginx" ; then

  kv.error "Service nginx is works"

fi

kv.isInstalled - Return 0 if specified apps installed on the system

1. Apps (List)

Code: 0 - ok, 1 - not ok

Example:

if ! kv.isInstalled "java" "nc" ; then

  kv.error "Java and netcat is not installed"

fi

kv.sendSignal - Send signal to service

1. Signal STRING
2. Pid NUMBER OPTIONAL

Code: 0 - ok, 1 - not ok

Example:

if ! kv.sendSignal $SIGNAL_QUIT ; then

  kv.error "Can't send signal"

fi

kv.setOOMScoreAdj - Set the adjustment level for the Out of memory (OOM) killer

1. Adjustment level NUMBER OPTIONAL
2. Process pid NUMBER OPTIONAL

Example:

kv.setOOMScoreAdj "-1000" "12345"

kv.setOOMScoreAdj "$OOM_DISABLE"

kv.checkSELinux - Check SE Linux

Code: 0 - ok, 1 - not ok

kv.isRoot - Check is user root

Code: 0 - ok, 1 - not ok

Example:

if ! kv.isRoot ; then

  kv.error "This action require root privileges!"

fi

kv.createLock - Create lock file

kv.removeLock - Remove lock file

kv.hasLock - Return 0 if lock file exist

Code: 0 - ok, 1 - not ok

Example:

if kv.hasLock ; then

  echo "Lock file exist!"

fi

kv.createPid - Create pid file

1. Pid NUMBER

Example:

kv.createPid 12345

kv.removePid - Remove pid file

kv.exit - Exit from the script

1. Error code NUMBER OPTIONAL

Example:

kv.exit

kv.exit 1

kv.disableColors - Disable all colors in output

kv.error - Show error message

1. Message STRING
2. Error code NUMBER OPTIONAL

Example:

kv.error "My error message"

kv.error "My error message" 10

kv.warn - Show warning message

1. Message STRING

Example:

kv.warn "My warning message"

kv.show - Show message

1. Message STRING
2. Color STRING OPTIONAL

Example:

show "Signal sended"

show "Can't do some action" $RED

kv.showm - Show message without new line symbol

1. Message STRING
2. Color STRING OPTIONAL

kv.version - Show version of kaosv

Echo: Version STRING

kv.restoreSEContext - Restore SELinux context

*. Files

Example:

kv.restoreSEContext "/path/to/file"

kv.readProperty - Read property from file

1. File STRING
2. Property name STRING
3. Delimiter STRING OPTIONAL

Echo: Property value STRING

Example:

local port=$(kv.readProperty "/path/to/my.conf" "port")

local host=$(kv.readProperty "/path/to/my.conf" "host" ":")

kv.log - Add message to logfile or logger

1. Message STRING

Example:

kv.log "My very important message"