Stm-admin: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:stm-admin}} | |||
Navigation: [[Documentation]] / [[Methods]] / [[String Method]] / [[STM:Utilities]] / [[stm-admin]] | Navigation: [[Documentation]] / [[Methods]] / [[String Method]] / [[STM:Utilities]] / [[stm-admin]] | ||
---- | ---- | ||
{{STMUtils}} | {{STMUtils}} | ||
'''Name''' | <div style="text-align: center">stm-admin: version 5.271.40980cf (2020-03-02 15:18)</div>'''Name''' | ||
stm-admin | <span style="margin-left: 15px;">stm-admin</span> | ||
'''Synopsis''' | '''Synopsis''' | ||
<span style="color: maroon;">stm-admin</span> <span style="color: blue;">[OPTIONS]</span> [--] <span style="color: purple;">stm://server[:port]/command</span> | <span style="color: maroon; margin-left: 15px;">stm-admin</span> <span style="color: blue;">[OPTIONS]</span> [--] <span style="color: purple;">stm://server[:port]/command</span> | ||
'''Description''' | '''Description''' | ||
The utility that controls the behaviour and state of the server implementing the string method. | <p style="text-indent: 1em; text-align: justify;">The utility that controls the behaviour and state of the server implementing the string method.</p> | ||
'''Arguments''' | '''Arguments''' | ||
{| style="margin-left: 2em; width: | {| style="margin-left: 2em; width: 95%;" | ||
|- style="vertical-align: top; background-color: #e6e6e6;" | |- style="vertical-align: top; background-color: #e6e6e6;" | ||
| info | | <span style="color: purple;">stm://server[:port]/command</span><br/><div style="margin-left: 30px;">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:<br />info = print information about registered clients<br />flush = save the accumulated STM path on the server side<br />get?file=output.path = get the accumulated STM path and save it locally to the file output.path <br />release?id=bead_id = unregister a client bound to the bead<br />terminate = terminate server at the end of STM cycle<br />shutdown = stop server execution<br />errors = prints errors from the server stack</div> | ||
</ | |||
|} | |} | ||
| Line 39: | Line 26: | ||
{| style="margin-left: 2em; width: 95%;" | {| style="margin-left: 2em; width: 95%;" | ||
|- style="vertical-align: top; background-color: #e6e6e6;" | |- style="vertical-align: top; background-color: #e6e6e6;" | ||
|<span style="color: blue;">-s, --serverkey FILE</span><br/>< | |<span style="color: blue;">-s, --serverkey FILE</span><br/><div style="margin-left: 30px;">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.</div><span style="color:purple; margin-left: 30px;">(Default: server.key)</span> | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<span style="color: blue;">-p, --password FILE</span><br/>< | |<span style="color: blue;">-p, --password FILE</span><br/><div style="margin-left: 30px;">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.</div> | ||
|- style="vertical-align: top; background-color: #e6e6e6;" | |- style="vertical-align: top; background-color: #e6e6e6;" | ||
|<span style="color: blue;">-v, --verbose</span><br/>< | |<span style="color: blue;">-v, --verbose</span><br/><div style="margin-left: 30px;">Increase output verbosity.</div> | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<span style="color: blue;">--version</span><br/>< | |<span style="color: blue;">--version</span><br/><div style="margin-left: 30px;">Output version information and exit.</div> | ||
|- style="vertical-align: top; background-color: #e6e6e6;" | |- style="vertical-align: top; background-color: #e6e6e6;" | ||
|<span style="color: blue;">-h, --help</span><br/>< | |<span style="color: blue;">-h, --help</span><br/><div style="margin-left: 30px;">Display this help and exit.</div> | ||
|} | |} | ||
Revision as of 17:10, 6 March 2020
Navigation: Documentation / Methods / String Method / STM:Utilities / stm-admin
STM Utilities
stm-admin: version 5.271.40980cf (2020-03-02 15:18)
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.
|