name: ups
version: "1.0.0"
description: "UPS monitoring via NUT (Network UPS Tools) with Ansible shutdown automation"
author: "FabledScryer"
license: "MIT"
min_app_version: "0.1.0"
repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/ups"
tags:
  - ups
  - power
  - nut

config:
  # ── Managed NUT (run NUT inside this container) ────────────────────────────
  # Enable to have FabledScryer manage the NUT daemon for you — no separate NUT
  # install required.  Connects to your UPS over the network (SNMP or XML/HTTP).
  # Changes take effect on the next container restart.
  nut_managed: false
  nut_ups_host: ""             # IP/hostname of UPS management card (required when nut_managed=true)
  nut_driver: "snmp-ups"       # snmp-ups (most UPS brands) or netxml-ups (Eaton XML/HTTP)
  nut_snmp_community: "public" # SNMP community string (snmp-ups only)
  nut_snmp_version: "v1"       # v1 or v2c (snmp-ups only)
  # ── NUT connection ─────────────────────────────────────────────────────────
  # When nut_managed=true these default to localhost (the managed instance).
  # Point at an external NUT server if nut_managed=false.
  nut_host: "localhost"
  nut_port: 3493
  ups_name: "ups"
  nut_username: ""            # leave blank if NUT is configured without auth
  nut_password: ""
  poll_interval_seconds: 30
  # ── Ansible shutdown automation ────────────────────────────────────────────
  shutdown_after_seconds: 300  # seconds on battery before triggering shutdown (0 = disabled)
  shutdown_source: ""          # Ansible source name containing the shutdown playbook
  shutdown_playbook: ""        # relative path within source, e.g. "shutdown.yml"
  shutdown_inventory: "hosts"  # inventory filename within source root