Skip to content
Suricatavel Logo Suricatavel Logo Suricatavel

Other commands

In addition to resource groups, suricatavel provides dedicated system administration commands.

update

Section titled “update”

Updates Suricatavel to the latest package release, applying migrations and restarting workers:

Terminal window
suricatavel update

Options

Section titled “Options”
  • --backup: Create a full PostgreSQL database backup before upgrading (backups are skipped by default).
  • --skip-cleanup: Keep all previous database backups after upgrade.
  • --no-rollback: Disable automatic database rollback if an upgrade step fails.
  • --no-tui: Run in plain text mode without interactive terminal formatting.
  • --force: Run without interactive confirmation prompts.

deploy

Section titled “deploy”

Executes post-deployment routines (migrations, cache warmup, supervisor worker restarts):

Terminal window
suricatavel deploy --migrate

Options

Section titled “Options”
  • --migrate: Run pending database migrations automatically.

consume

Section titled “consume”

Starts high-throughput event consumption from Apache Kafka brokers:

Terminal window
suricatavel consume --topics=events,heartbeats --timeout=0 --debug

Options

Section titled “Options”
  • --topics: Comma-separated list of Kafka topics to consume (default: configured events topic).
  • --timeout: Consumer poll timeout in seconds (0 for continuous daemon mode).
  • --debug: Enable verbose diagnostic logging for broker connections.

read-eve

Section titled “read-eve”

Processes events directly from a local eve.json file for batch or offline ingestion:

Terminal window
suricatavel read-eve /var/log/suricata/eve.json --memory-limit=90

Options

Section titled “Options”
  • file: Path to the input eve.json file.
  • --memory-limit: Maximum memory percentage threshold allowed for batch processing (default: 90).

mitre

Section titled “mitre”

Imports and correlates MITRE ATT&CK techniques:

Terminal window
# Import enterprise ATT&CK matrix from default or custom STIX 2.1 source
suricatavel mitre import


# Import from a custom STIX 2.1 file or URL
suricatavel mitre import --source=/opt/enterprise-attack.json

status

Section titled “status”

Displays a status dashboard covering Supervisor workers, queue backlogs, database connections, and system health:

Terminal window
suricatavel status

boot

Section titled “boot”

Initializes application schemas and provisions the default administrator account during initial deployment:

Terminal window
suricatavel boot

version

Section titled “version”

Displays the current installed version of Suricatavel:

Terminal window
suricatavel version