stm-admin

Navigation: Documentation / Utilities / stm-admin

---

stm-admin: version 6.380.1d87074 (2021-07-26 16:36)

Name

stm-admin

Synopsis

stm-admin [OPTIONS] [--] stm://server[:port]/command

Description

The utility that controls the behaviour and state of the server implementing the string method.

Arguments

stm://server[:port]/command It provides the action specification. The server is either the DNS name or IP address of the server or word 'serverkey' or 'key'. In the later case, the information about the server is read from the server key file. The port number, on which the server is listen, may be optionally provided. Finally, the command is administration task, which can be one of the following: info = print information about registered clients flush = save the accumulated STM path on the server side get?file=output.path = get the accumulated STM path and save it locally to the file output.path release?id=bead_id = unregister a client bound to the bead terminate = terminate server at the end of STM cycle shutdown = stop server execution errors = prints errors from the server stack

Options

-s, --serverkey FILE Name of file containing the server key. The server key contains the server name, port, and password. This option is mutually exclusive with 'password' option. (Default: server.key)

-p, --password FILE Name of file containing the server magic word. If the pasword is not provided via this option or via the server key then it is read interactively from the keyboard. This option is mutually exclusive with 'serverkey' option.

-v, --verbose Increase output verbosity.

--version Output version information and exit.

-h, --help Display this help and exit.