Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/monitors/apcupssnmp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
apcupssnmp - APC UPS status via NMC
^^^^^^^^^^^^^^^^^^^^^^^^

Connects directly to an APC UPS with an NMC (Network Management Card) installed, using SNMP.

Currently only supports SNMP v1


.. confval:: host

:type: string
:required: true

The hostname or IP address of the UPS

.. confval:: community

:type: string
:required: false
:default: ``public``

The SNMP Community name to use when connecting to the UPS.

.. conval:: maxloadpct

:type: int
:required: false
:default: ``80``

The Load Percentage of the UPS to be OK. A value over 100 will never trigger this warning.

.. conval:: battpctwarn

:type: int
:required: false
:default: ``20``

The minimum Battery Percentage warning, above this number the battery is deemed OK. Monitor will fail if battery is under 20%. Useful to ensure the monitor stays in a failed state until the battery has recovered enough after a power outage.

.. conval:: runtimemin

:type: int
:required: false
:default: ``10``

The minimum allowed runtime of the UPS, defaults to 10 (10 minutes). This default is used to allow enough time to trigger shutdown of systems.

.. conval:: textdelimeter

:type: string
:required: false
:default: ``,``

The text to use to seperate each item in the Details when returned from the test. Defaults to using a comma ','.
Useful if you want to use this text in another system, or make it easier to read
18 changes: 16 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ paramiko = ">=2.7.2,<4.0.0"
pyaarlo = ">=0.8.0.19,<0.9.0.0"
icmplib = "^3.0.3"
packaging = "^26.2"
snmp = "^1.2.1"

[tool.poetry.group.dev.dependencies]
boto3-stubs = {extras = ["sns"], version = "^1.43.10"}
Expand Down
2 changes: 2 additions & 0 deletions simplemonitor/Monitors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Monitors for SimpleMonitor
"""

from .apcupssnmp import MonitorAPCUPSSNMP
from .arlo import MonitorArloCamera
from .compound import CompoundMonitor, RemoteHostsMonitor
from .file import MonitorBackup
Expand Down Expand Up @@ -44,6 +45,7 @@
from .unifi import MonitorUnifiFailover, MonitorUnifiFailoverWatchdog

__all__ = [
"MonitorAPCUPSSNMP",
"MonitorMQTT",
"CompoundMonitor",
"MonitorApcupsd",
Expand Down
Loading
Loading