Configuration Reference

Parameters below are taken from scripts/auto_remediation.conf-template.template, the Interactive IU conf editor, and auto_remediation.sh validation. Do not add parameters that are not present in those sources. Site-specific live values are not documented here.

File Map

File Role
scripts/auto_remediation.conf Runtime SMTP, alerting, schedules, nodes, reports
scripts/auto_remediation.conf-template.template Shipped defaults and restore source
scripts/auto_remediation_config.yaml Node Manager and Cluster Manager check YAML
scripts/auto_remediation_config-template.yaml.template YAML template (ENABLE_IPV6 placeholder)
scripts/appviewx.conf Installer settings such as ENABLE_IPV6 and INSTALLATION_PATH

Auto Remediation.conf Parameters

Parameter Required Default (template) Allowed / notes
SMTP_SERVER Required for alerts and reload validation (empty) Hostname or IP
SMTP_PORT Required for reload validation (empty) Numeric port
SMTP_USER Optional (empty) Empty if authentication is not required
SMTP_FROM Required for alerts and reload validation (empty) From address
SMTP_TO Required for alerts and reload validation (empty) Comma-separated recipients
SMTP_ERROR_TO Optional (empty) Defaults to SMTP_TO when empty
SMTP_PASSWORD / SMTP_PASSWORD_ENCRYPTED Required for sending mail (empty) IU prompts SMTP_PASSWORD; stored encrypted. Never document plaintext.
SMTP_PASSWORD_KEY Derived (empty) Treat as secret
SMTP_CONFIG_SOURCE Derived (empty) manual or app_db
GROUP_BY Optional (IU allowed set) nodes nodes or issues
ALERT_MIN_COUNT Required (IU) 1 Positive integer; 1 sends any waiting alert
ALERT_EMAIL_SUBJECT Optional (empty) Empty = auto-generated subject
MONITORING_INTERVAL Required 60 Minutes
ALERT_CRON_SCHEDULE Required 0 4 * * * Five-field cron
ALERT_MANUAL_TRIGGER_ENABLED Required true for option 6 true true/false; unset defaults to true
COOLDOWN_PERIOD Required 1440 Minutes
COOLDOWN_OVERRIDES Optional (empty) plugin=minutes or plugin|module=minutes, comma-separated
AUTOFIX_ESCALATION_COUNT Required (IU) 3 Integer
AUTOFIX_ESCALATION_WINDOW_MINUTES Required (IU) 1440 Minutes
WEBHOOK_ENABLED Optional (IU boolean) false true/false (IU Yes/No)
WEBHOOK_URL Optional (empty) Used when WEBHOOK_ENABLED is true
CLUSTER_WATCHDOG_ENABLED Optional (IU boolean) false true/false
CLUSTER_WATCHDOG_CRON_SCHEDULE Required (IU) */15 * * * * Five-field cron
REPORT_CRON_SCHEDULE Required (IU) 0 5 * * 0 Five-field cron
REPORT_OUTPUT_DIR Required (IU) /tmp/auto-remediation-reports Writable directory
REPORT_FORMAT Optional (IU allowed set) html html or csv only
AUTO_REMEDIATION_MONITORING_NODES Required (IU); validated if set (empty) Worker hostnames only; comma-separated
AUTO_REMEDIATION_RQLITE_NODES Required (IU); odd count (empty) Odd number of worker hostnames (1, 3, 5, ...). Not reloadable.
RQLITE_DB_RETENTION_DAYS Required 30 Positive integer
Note: AUTO_REMEDIATION_MONITORING_NODES and AUTO_REMEDIATION_RQLITE_NODES must be worker nodes. Master and control-plane nodes are not permitted. Changing RQLite nodes is not supported via Reload Configuration.