pbs_notification_matcher_set
Create or update an alert routing rule for PBS notifications, using filters like severity, field, and calendar, with dry-run planning before execution.
Instructions
MUTATION: create-or-update a PBS notification matcher (alert routing rule). One safe read
of the matchers collection decides create (POST, name in body) vs update (PUT .../{name}) —
digest/delete only apply to the update branch. Dry-run by default (returns a PLAN);
confirm=True executes (synchronous — PBS returns null) and returns
{"status": "ok", "result": None}. No snapshot primitive — re-apply with this same tool to
restore after deletion. To remove a matcher use pbs_notification_matcher_delete. Needs
PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | How match-* filters combine: 'all' (default on PBS) or 'any'. | |
| name | Yes | Name of the notification matcher (alert routing rule) to create or update (2-32 chars, alnum start). | |
| delete | No | Update only: property names to clear (e.g. ['comment','target']). Ignored on create. | |
| digest | No | Optimistic-lock (update only): 64-char lowercase hex SHA-256 of the config PBS last returned. Ignored on create — PBS's own create schema has no digest field. | |
| target | No | Names of endpoints/targets to notify when this matcher fires. | |
| comment | No | Optional free-text comment stored with the matcher. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the create/update. | |
| disable | No | If True, disable this matcher without deleting it. | |
| match_field | No | Metadata field filters to match (see pbs_notification_matcher_fields for known names). | |
| invert_match | No | If True, invert the whole filter's match result. | |
| match_calendar | No | Calendar-event time-window filters to match. | |
| match_severity | No | Severity levels to match (e.g. ['error','warning']). | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |