The seq.exe executable (Windows) and datalust/seq container (Docker) have an extensive command line for performing administration tasks.
Seq Server Command-Line
Usage
Syntax (Windows):
seq <command> [<args>]
Syntax (Docker):
docker run --rm -it -v $HOST_PATH_TO_SEQ:/data datalust/seq <command> [<args>]
Available commands are:
| Command | Description |
|---|---|
auth |
Change authentication provider |
backup |
Write a backup of the Seq configuration and metadata |
bind-ssl |
Bind an installed SSL certificate to an HTTPS port served by Seq |
browse |
Open a web browser at the address configured for the Seq instance |
config |
View and set fields in the Seq.json file; run with no arguments to list all fields |
help |
Show information about available commands |
install |
Install the Seq server as a Windows service |
list |
List Seq instances installed on the machine |
migrate |
Move all event data to the FLARE storage engine |
restart |
Restart the Windows service |
restore |
Restore from a backup of the Seq configuration and metadata |
run |
Host the server in the current process |
show-key |
Print the master encryption key used to protect sensitive fields and backup files |
start |
Start the Windows service |
status |
Show the status of the Seq service |
stop |
Stop the Windows service |
uninstall |
Uninstall the Seq Windows service |
unlock |
Reset a user's password |
version |
Print the current executable version |
Type seq help <command> for detailed help.
Commands
auth
Change authentication provider.
| Option | Description |
|---|---|
--basic |
Switch to basic username/password authentication; must be specified in conjunction with name and new credentials for an administrative account |
-u, --username=VALUE |
The name of the user account |
-p, --password=VALUE |
The password for the user account |
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
backup
Write a backup of the Seq configuration and metadata.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
-p, --path=VALUE |
The folder path where the backup file should be stored (default: current directory) |
bind-ssl
Bind an installed SSL certificate to an HTTPS port served by Seq. Windows only.
| Option | Description |
|---|---|
--port=VALUE |
The port on which the Seq server is listening (default is 443) |
--thumbprint=VALUE |
The thumbprint of the SSL certificate to bind; this can be found with the Manage computer certificates program |
--hostname=VALUE |
If SNI is used, the specific host name to bind to (default is to bind to all hostnames via the IP address) |
browse
Open a web browser at the address configured for the Seq instance.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
config
View and set fields in the Seq.json file; run with no arguments to list all fields.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
-k, --key=VALUE |
The field, for example api.listenUris |
-v, --value=VALUE |
The field value, comma-separated if multiple values are accepted; if not specified, the command will print the current value |
-c, --clear |
Clear the field |
--create |
Create the config file if none exists |
help
Show information about available commands.
Example:
seq help config
install
Install the Seq server as a Windows service. Windows only.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
-l, --listen=VALUE |
Set the URL(s) to listen on; the default is 'http://localhost:5341' |
--ram-target=VALUE |
Sets the system memory consumption target that Seq will use to determine utilization, in percent. The default is 90. |
-u, --username=VALUE |
The name of a Windows account to run the service under; if not specified the Local System account will be used |
-p, --password=VALUE |
The password for the Windows account to run the service under |
--setup |
Install and start the service only if it does not exist; otherwise reconfigure the binary location |
list
List Seq instances installed on the machine.
migrate
Move all event data to the FLARE storage engine.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
restart
Restart the Windows service. Windows only.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
restore
Restore from a backup of the Seq configuration and metadata.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
-k, --master-key=VALUE |
The base-64 encoded master encryption key (enclose in double quotes to escape embedded equals signs) |
-b, --backup=VALUE |
The .seqbac file to restore from; this must have been created with the exact Seq version in use |
--confirm |
Assume y for any confirmations |
run
Host the server in the current process.
| Option | Description |
|---|---|
--nologo |
|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
show-key
Print the master encryption key used to protect sensitive fields and backup files.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
--generate |
Generate and print a new key to use with another Seq instance |
start
Start the Windows service. Windows only.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
status
Show the status of the Seq service.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
stop
Stop the Windows service. Windows only.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
uninstall
Uninstall the Seq Windows service. Windows only.
| Option | Description |
|---|---|
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
unlock
Reset a user's password.
| Option | Description |
|---|---|
-u, --username=VALUE |
The name of the user account |
-p, --password=VALUE |
The password for the user account |
-n, --name=VALUE |
If multiple Seq instances are in use, the name of the instance |
-s, --storage=VALUE |
Specify the folder where data for this instance is stored; C:\ProgramData\Seq(\Instance[Name]) is used by default. |
--require-change |
Require a password change next time the user logs in |
version
Print the current executable version.
Updated 6 months ago