Sensors

The sensors command group manages Suricata sensor nodes, automated provisioning, metrics polling, and version upgrades.

---

Available actions

Action	Description
list	Show all registered sensors and their active Suricata versions.
provision	Provision and configure Suricata on a remote sensor using Ansible.
metrics	Poll instantaneous system and performance metrics from a sensor.
upgrade	Upgrade Suricata on a sensor.
versions	List available Suricata versions and releases.

---

List sensors

suricatavel sensors list

Displays a status table of all sensors, active configurations, Suricata engine versions, and connectivity states.

---

Provision a sensor

The provision command automates Suricata installation and network interface tuning on a sensor host via Ansible.

Parameters

• target (required): Sensor name or hostname as registered in Suricatavel.
• --ip: IPv4 address of the sensor.
• --port: SSH management port (default: 22).
• --password: SSH password (if not using SSH key authentication).
• --force: Force reprovisioning even if the node is already configured.

Examples

# Provision localhost as a local sensor
suricatavel sensors provision localhost

# Provision a remote sensor with IP and custom SSH port
suricatavel sensors provision sensor-01 --ip=10.0.0.10 --port=2222

---

Poll metrics

Fetch real-time CPU, memory, and packet capture counters:

# Poll a specific sensor
suricatavel sensors metrics sensor-01

# Poll all active sensors
suricatavel sensors metrics all

---

Upgrade Suricata on a sensor

Upgrades Suricata to the target version configured for the sensor:

suricatavel sensors upgrade sensor-01

---

List Suricata versions

List supported Suricata releases available for deployment:

suricatavel sensors versions