epadmin-systemservice
epadmin systemservice target — Manages installation of a StreamBase application to run as a system service on Microsoft Windows.
DESCRIPTION
Important
This command is supported only on the Microsoft Windows platform.
Manages installation of a StreamBase application to run as a system service on Windows. Use of these commands assumes familiarity with Windows services concepts and general architecture. Once an application is installed with these commands, use native Windows tools to manage the service. See Configuring Apps as a Windows Service in the Installation Guide for further information.
The systemservice target has two commands:
epadmin install systemservice
Use the install systemservice command to install a StreamBase application to run as a Windows service.
Consider the following epadmin install systemservice examples:
epadmin install systemservice --name="streamwin" --nodedirectory=/Users/sbuser/Nodes --nodename=A.sbuser --application=/Users/sbuser/projects/streamwin/target/streamwin-app.zip --displayname=StreamWin --startup=automatic --nodedeploy=/Users/sbuser/projects/streamwin/src/main/configuration/node.conf --substitutionfile=/Users/sbuser/projects/streamwin/src/main/resources/streamwin.properties epadmin install systemservice --name="streamwin" --nodedirectory=/Users/sbuser/Nodes --nodename=A.sbuser --username=.\sbuser --password=WayS3cr3t --application=/Users/sbuser/projects/streamwin/target/streamwin-app.zip
The following table describes the install systemservice command parameters.
| Command Parameter | Description | Required? |
|---|---|---|
application
|
Absolute path to the application archive file to run. | No. No default value. If not specified, a node is started without an application. |
displayname
|
Service display name. This name shows in Windows service management tools. | No. The default value is the name parameter value. |
name
|
Service name. | Yes. |
nodedeploy
|
Absolute path to a node deploy configuration file, if required. (This can
only be specified if the application parameter
is also specified.)
|
No. No default value. |
nodedirectory
|
Absolute path of the parent directory that contains the node installation
directory. The node installation directory becomes nodedirectory\nodename.
|
Yes. |
nodename
|
Fully qualified node service name, such as A.sbuser.
|
Yes. |
password
|
User account password. Windows built-in accounts such as LocalService, NetworkService,
or LocalSystem may not require a password but
may require running the epadmin command with Windows Admin
rights. For a standard Windows username, if this parameter is not used, a
password prompt is displayed.
|
No. No default value. |
startup
|
Specifies the service startup behavior. Valid values are one of
automatic, delayed, and manual.
|
No. The default value is manual.
|
substitutionfile
|
Absolute path to a substitution variable file, if required. (This can only
be specified if the application parameter is
also specified.)
|
No. No default value. |
username
|
The user account to run this service. This parameter must be specified as
.\username. The
NT_AUTHORITY domain name must be used for the
built-in LocalService and NetworkService accounts.
|
No. The default value is the LocalSystem account. |
epadmin remove systemservice
Remove an installed Windows system service. All user data stored in the node directory is lost when a service is removed. It is a best practice to replicate any important data to another node to avoid data loss before removing a service.
For example:
epadmin remove systemservice --name="streamwin"
| Command Parameter | Description | Required? |
|---|---|---|
| name | The exact Windows service name is specified with the epadmin install systemservice command. | Yes. |