A.3. Server Commands

Server Commands help managing, testing and diagnosting Promptar Server’s operation. Some require the server to be running, others do not. See the following table for the description of the available commands:

command server state description

help

any

Prints out a simple list of the available commands.

server.lhs

any

Full syntax: server.lhs [ifaces]

 

Prints out the server license string, including network interface information, if given the ifaces flag. Used to generate licenses for the host.

server.stats

running

Prints out the running server statistics.

server.log

running

Full syntax: server.log <level>

 

Changes the logging level to one of error, warn, info or debug.

server.reload

running

Reloads the [data], [templates] and [rules] sections from the integration.conf configuration file. If any error is found, a message is printed out and no changes are applied.

pass.hash

any

Full syntax: pass.hash <password> [<rng-seed-number>]

 

Generates a salted user password hash to be used in users.conf.

The optional <rng-seed-number> can be used to ensure a given password results in the same salted hash.

pass.check

any

Full syntax: pass.check <password> <hash>

 

Checks the given <password> against <hash> and prints out valid or invalid. The exit code does not reflect the check result.

plugins.dump

running

Full syntax: plugins.dump [<tag-string>]

 

Used for diagnostic purposes, requests that each connector dumps its internal state to the respective log, including the optional <tag-string> if supplied.

calls.print

running

Prints out the currently active calls, if any.

Includes call ID, duration, state and members.

calls.new

running

Full syntax: calls.new <from> <to>

 

Creates a test call as if signalled by the PBX connector.

Test calls have test- prefixes in their IDs. <from> and <to> are peer addresses and, in general, will be phone numbers.

calls.state

running

Full syntax: calls.state <call-id> <new-state>

 

Simulates a call state change as if signalled by the PBX connector.

<new-state> can be one of ringing, talking or onHold.

calls.peer

running

Full syntax: calls.peer <call-id> <peer> <new-peer>

 

Simulates the call transfer termination, where <peer> is replaced by <new-peer> in the call.

calls.bridge

running

Full syntax: calls.bridge <call-id-1> <call-id-2> <peer-to-exclude>

 

Simulates the bridging of two calls, as if signalled by the PBX connector; calls are bridged when transfers are completed.

Calls must have a common member to be used as <peer-to-exclude> which, as the name suggests, will be excluded from the resulting call.

calls.end

running

Full syntax: calls.end <call-id>

 

Terminates a call as if signalled by the PBX connector.

NOTES: