Administrate the Output Engine Services¶
The services of an Output Engine system can be administrated by PLOSSYS CLI.
Requirements¶
For the requirements for using PLOSSYS CLI, refer to PLOSSYS CLI.
Commands¶
Usage: plossys service [options] [command]
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
start [services...] start services
arguments:
services: the list of service names
use '-' for pipe
stop [options] [services...] stop services
arguments:
services: the list of service names
use '-' for pipe
status [services...] print status of services
arguments:
services: the list of service names
use '-' for pipe
help [command] display help for command
For all commands, pipe |
can be used with the output but needs to be escaped by -
, e. g. -|
.
help¶
help
displays the help for the command.
Usage: plossys service help [command]
start¶
start
starts the Output Engine services, either the whole PLOSSYS Output Engine, a specific service or a list of services.
Usage: plossys service start [services...]
Arguments:
services
: list of service names, optional
Examples:
-
plossys service start
Starts the Output Engine system.
-
plossys service start seal-rest
Starts the
seal-rest
service. -
plossys service start seal-rest seal-checkout
Starts the services
seal-rest
andseal-checkout
.
status¶
status
prints the status of the Output Engine services, either for the whole PLOSSYS Output Engine, a specific service or a list of services.
Usage: plossys service status [services...]
Arguments:
services
: list of service names, optional
Examples:
-
plossys service status
Checks the status of the complete Output Engine system.
-
plossys service status seal-rest
Checks the status of
seal-rest
service. -
plossys service status seal-rest seal-checkout
Checks the status of the services
seal-rest
andseal-checkout
.
stop¶
stop
stops the Output Engine services, either the whole PLOSSYS Output Engine, a specific service or a list of services.
Usage: plossys service stop [options] [services...]
Arguments:
services
: list of service names, optional
Options:
--full
: Stops all services including the infrastructure.--mongo <value>
: Url to local MongoDB (default:mongodb://localhost:27017/test
)
Examples:
-
plossys service stop
Stops all services belonging to PLOSSYS Output Engine. The third-party components such as MongoDB, Consul and NATS will be still running.
-
plossys service stop --full
Stops all services belonging to PLOSSYS Output Engine and the third-party components such as MongoDB, Consul and NATS.
-
plossys service stop seal-rest
Stops the
seal-rest
service. -
plossys service stop seal-rest seal-checkout
Stops the services
seal-rest
andseal-checkout
.