Proxmox Backup Server (PBS) Monitoring Tools
This project provides tools that use Proxmox Backup Server (PBS) API with Proxmoxer, in order to get status informations, like backups that have failed.
- :material-license: FreeBSD License
- :fontawesome-brands-python: Python >= 3.11 is required
- :fontawesome-solid-link: https://pypi.org/
- :fontawesome-solid-at: Author : Sigilence Technologies
Tools
Usage
Available commands
You have to be authenticated in order to use this tool.
To set up authentication, create a auth.yaml file that looks like that:
host: <the_pbs_host>
user: <username@pbs>
token_name: <TOKEN_NAME>
token_value: <TOKEN_VALUE>
And replace placeholders by your credentials and host of the Proxmox Backup Server you'll need to reach.
The token has to have at least the Backup.Audit role/privilege.
Now, to use pbs_monitoring_tools, you'll have to use this command line
python3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> [arguments...]
python3 -m pbs_monitoring_tools --help
python3 -m pbs_monitoring_tools --version
Arguments
There is a few arguments that you can use:
python3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --datastores --namespaces-to-ignore --max-depth --max-age --filling-remaining-days --quiet
All the command lines arguments are optional.
--datastores
If not provided, tools will consider that you want to run through all datastores. Otherwise, you can specify a datastores list, like that:
python3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --datastores="datastore1,datastore2"
--namespaces-to-ignore
If not provided, tools will consider that you don't want to exclude any namespace. Otherwise, you can specify which namespaces you want to ignore:
python3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --namespaces-to-ignore="namespace1,namespace2"
--max-depth
If not provided, tools default to maximum depth value allowed by API. Otherwise, you can specify a value between 0 and 7 (should be an integer value).
--max-snapshot-age-hours
If not provided, tools default to 72 hours (3 days) as value from which we consider that a snapshot is too old. You'll need to use hours as value (should be an integer value).
--filling-remaining-days
If not provided, tools default to 30 days. You'll need to use days as value (should be an integer value).
--debug
If provided, enable debug level logs.
--quiet
--no-errors
If provided, print nothing if snapshots check does not raise errors. Otherwise, print a message to tell that no errours were found.
Metadata
Release files for pbs-monitoring-tools 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pbs_monitoring_tools-0.3.1.tar.gz | 8.9 kB | Without provenance | Details for pbs_monitoring_tools-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pbs_monitoring_tools-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for pbs_monitoring_tools-0.3.1-py3-none-any.whl |
Total release size: 16.8 kB
Release files / pbs_monitoring_tools-0.3.1.tar.gz
| Download URL | pbs_monitoring_tools-0.3.1.tar.gz |
|---|---|
| Size | 8.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3454ca2b53b7287e180ef69020afb3b14f03386d09f7082861503fcc83197695
|
|
BLAKE2b-256 checksum How to use checksums |
755e878aa50e76861040b96854e675bd611b2faecfd6b6657d990c13d664788d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.2
|
Release files / pbs_monitoring_tools-0.3.1-py3-none-any.whl
| Download URL | pbs_monitoring_tools-0.3.1-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e1f3783c925bdce150c5c1ac122c29de75b751a08b48c7d9db217779d36cf18c
|
|
BLAKE2b-256 checksum How to use checksums |
09277fd15d7bd9ca417c8d2323a773beb51cb90af00d26553539b7374f1dddbd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.2
|
Security for pbs-monitoring-tools 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.