Active Sensor Startup Options
This page describes the various startup configuration options for the eyeInspect Active Sensor.
To use the configuration options, edit the contents of /opt/active-sensor/.env by
uncommenting a configuration parameter and modifying its value. For example, if you were
to use the ICSP_CC_IP_SECONDARY parameter, it would change from
# ICSP_CC_IP_SECONDARY=""
to
ICSP_CC_IP_SECONDARY="<IP_ADDRESS>"
After editing the configuration options, restart the active-sensor container using the manage-containers.sh script:
sudo /opt/active-sensor/manage-containers.sh --rm sudo /opt/active-sensor/manage-containers.sh --up
When updating the configuration, the .env file may not contain all supported configuration options. If you do not find a required configuration option, you can take it from the sample env file located in the active sensor installation directory, at /opt/active-sensor/env.sample, and copy it to the .env file.
The sample env file lists all available configuration options.
The table below describes the active sensor configuration options:
| Option | Default Value | Description |
|---|---|---|
| Logging | ||
| DEBUG | False | Enable/disable the debug logging |
| Connection parameters | ||
| ICSP_CC_IP | “” | IP address of the Command Center |
| ICSP_CC_QUEUE_PORT | 9092 | Port of the Kafka listener on the Command Center host |
| ICSP_CC_IP_SECONDARY | “” | IP address of the secondary Command Center when using High Availability |
| ICSP_CC_QUEUE_PORT_SECONDARY | 9092 | Port of the Kafka listener on the secondary Command Center when using High Availability |
| FAILOVER_TIMEOUT_MINUTES | 5 | Timeout in minutes before switching between primary and secondary Command Center when using High Availability |
| Custom certificates | ||
| CA_FILE | “certs/icsp_ca.crt” | Custom CA Certificate to use for connecting to the Command Center |
| CERT_FILE | “certs/icsp_cert.pem” | Custom Certificate file to use for connecting to the Command Center |
| KEY_FILE | “certs/icsp_key.pem” | Custom Certificate Key to use for connecting to the Command Center |
| KEY_PASSPHRASE | “yourpass” | Passphrase for the custom Certificate Key |
| Retention | ||
| TASK_RENTEION_AFTER_FINISHED | 24 | Number of hours that finished query results are stored in the sensor’s database |
| Workers | ||
| WORKERS_SLOW_TASKS | 5 | Number of slow queries allowed to run in parallel for Discovery queries (Active IPs, Custom, OS/Ports OT Ports) |
| WORKERS_FAST_TASKS | 3 | Number of fast queries allowed to run in parallel (all other queries) |
| Discovery query parameters | ||
| OVERWRITE_SERVICE_DISCOVERY | True | Enable/disable service discovery for OS/Ports and OT Ports queries |
| OVERWRITE_AGGRESSIVENESS | 1 |
Aggressiveness of OS/Ports and OT Ports queries. Affects number of probes per second, parallel connections, timeouts. Range: 1 (polite) to 5 (aggressive) |
minute read