SBN APSL
SBN APSL
SBN APSL feeds alarms that have been assigned to the APSL terminal into the Action Plan Executor automatically, so an action plan starts without an operator having to pick the alarm up first.
Overview
SBN APSL is a worker on the SBN alarm queue. It does not decide which alarms get an action plan — that decision is made upstream, when an alarm is routed to the APSL terminal (the same way an alarm can be routed to any operator terminal). SBN APSL simply pulls the next alarm assigned to its terminal, takes it, fetches the incident context, validates the script, and hands it to the Action Plan Executor to run. It also carries out the SBN-side steps a plan asks for (acknowledge, log, dispatch) by calling SBN.
- Runs: When configured. One or more per host.
- Required: Only if you run action plans automatically from the queue. The Action Plan Executor must also be running.
- Depends on: NATS, the Action Plan Executor, and SBN.
How an alarm reaches SBN APSL
An alarm is routed to the APSL terminal upstream by SBN, when its standard message is flagged for scripting (an @AP<script> marker). The terminal that script alarms are routed to is set by the apslterm SBN option (default APSL). SBN APSL reads that option to learn which terminal to poll, then asks SBN for the next alarm sitting on it.
Taking an alarm is exactly‑once: if two SBN APSL instances poll at the same moment, only one takes a given alarm. A taken alarm whose plan never starts (for example the instance restarts in the gap between taking and running) is released automatically after a short reclaim window, so it is never left stuck.
Runs as an operator
SBN APSL signs in to SBN as an operator and is bound by that operator's rights, exactly like a person working the queue. It only sees and takes alarms for the branches and dealers its access profile allows, and it can only take, acknowledge, log and dispatch if that operator is permitted to. To scope or switch off automatic handling for a branch or dealer, change the operator profile SBN APSL signs in with — there is no separate per‑account APSL switch.
Configuration
SBN APSL is configured under the sbnapsl namespace.
Setting | Default | Description |
|---|---|---|
| false | Turn on automatic polling and taking of alarms from the APSL terminal. |
| (from | Override the terminal to poll. Normally left unset — the terminal comes from the |
| 5000 | How often to poll when there is nothing to take. |
| 1000 | How long to pause after starting a plan before polling again. |
The reclaim window for an unstarted take is an SBN option (apsrclm, default 30 seconds), set on the SBN side rather than in SBN Media.
After changing settings in sbn-media.local.yaml, apply them with ./sbn-media config reload.
FAQ
What turns the auto-queue on?
sbnapsl.takeIncidents set to true, and the SBN operator that SBN APSL signs in as must hold the rights (and branch/dealer access) for the alarms you want handled. There is no installation number to set — SBN APSL pulls whatever is routed to the APSL terminal.
How does an alarm get to the APSL terminal?
SBN routes it there when the alarm's standard message is flagged for scripting. SBN APSL does not choose which alarms are eligible; it only pulls what has already been routed to its terminal.
What actually runs the plan?
The Action Plan Executor. SBN APSL finds and takes the alarm and hands it over.
Do I need it?
Only for automatic action-plan handling straight from the queue.
Related pages
- SBN Media Overview (
SBN-Media/overview) - Installing and Configuring SBN Media (
SBN-Media/installation) - Action Plan Executor (
SBN-Media/Automation/apsl-executor) - Watchdog (
SBN-Media/Platform/watchdog)