| Name | pbs-monitoring-tools JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | This project provides tools that use Proxmox Backup Server (PBS) API with Proxmoxer package. |
| upload_time | 2025-07-23 14:38:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
<!-- more -->
<div class="grid cards" markdown>
- :material-license: __FreeBSD__ License
- :fontawesome-brands-python: __Python__ >= 3.11 is required
- :fontawesome-solid-link: [https://pypi.org/](https://pypi.org/project/pbs-monitoring-tools/)
- :fontawesome-solid-at: __Author__ : [Sigilence Technologies](https://pypi.org/user/Sigilence/)
</div>
## 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:
```yaml
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
```shell
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:
```shell
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:
```shell
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:
```shell
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "pbs-monitoring-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Sigilence Technologies <contact@sigilence.com>",
"download_url": "https://files.pythonhosted.org/packages/75/5e/878aa50e76861040b96854e675bd611b2faecfd6b6657d990c13d664788d/pbs_monitoring_tools-0.3.1.tar.gz",
"platform": null,
"description": "# Proxmox Backup Server (PBS) Monitoring Tools\n\nThis project provides tools that use Proxmox Backup Server (PBS) API with Proxmoxer, in order to get status informations, like backups that have failed.\n\n<!-- more -->\n\n<div class=\"grid cards\" markdown>\n\n- :material-license: __FreeBSD__ License\n- :fontawesome-brands-python: __Python__ >= 3.11 is required\n- :fontawesome-solid-link: [https://pypi.org/](https://pypi.org/project/pbs-monitoring-tools/)\n- :fontawesome-solid-at: __Author__ : [Sigilence Technologies](https://pypi.org/user/Sigilence/)\n\n</div>\n\n## Tools\n\n### Usage\n\n### Available commands\n\nYou have to be authenticated in order to use this tool.\n\nTo set up authentication, create a `auth.yaml` file that looks like that:\n\n```yaml\nhost: <the_pbs_host>\nuser: <username@pbs>\ntoken_name: <TOKEN_NAME>\ntoken_value: <TOKEN_VALUE>\n```\n\nAnd replace placeholders by your credentials and host of the Proxmox Backup Server you'll need to reach.\n\nThe token has to have at least the `Backup.Audit` role/privilege.\n\nNow, to use `pbs_monitoring_tools`, you'll have to use this command line\n\n```shell\npython3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> [arguments...]\npython3 -m pbs_monitoring_tools --help\npython3 -m pbs_monitoring_tools --version\n```\n\n### Arguments\n\nThere is a few arguments that you can use:\n\n```shell\npython3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --datastores --namespaces-to-ignore --max-depth --max-age --filling-remaining-days --quiet\n```\n\nAll the command lines arguments are optional.\n\n\n#### --datastores\n\nIf not provided, tools will consider that you want to run through all datastores. Otherwise, you can specify a datastores list, like that:\n\n```shell\npython3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --datastores=\"datastore1,datastore2\"\n```\n\n#### --namespaces-to-ignore\n\nIf not provided, tools will consider that you don't want to exclude any namespace. Otherwise, you can specify which namespaces you want to ignore:\n\n```shell\npython3 -m pbs_monitoring_tools --auth-file ../<auth-file.yml> --namespaces-to-ignore=\"namespace1,namespace2\"\n```\n\n#### --max-depth\n\nIf 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).\n\n#### --max-snapshot-age-hours\n\nIf 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).\n\n#### --filling-remaining-days\n\nIf not provided, tools default to 30 days. You'll need to use days as value (should be an integer value).\n\n#### --debug\n\nIf provided, enable `debug` level logs.\n\n#### --quiet\n\n#### --no-errors\n\nIf provided, print nothing if snapshots check does not raise errors. Otherwise, print a message to tell that no errours were found.\n",
"bugtrack_url": null,
"license": null,
"summary": "This project provides tools that use Proxmox Backup Server (PBS) API with Proxmoxer package.",
"version": "0.3.1",
"project_urls": {
"Our Website": "https://www.sigilence-technologies.com/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "09277fd15d7bd9ca417c8d2323a773beb51cb90af00d26553539b7374f1dddbd",
"md5": "aaf937680b77637ed32fecee68dc6101",
"sha256": "e1f3783c925bdce150c5c1ac122c29de75b751a08b48c7d9db217779d36cf18c"
},
"downloads": -1,
"filename": "pbs_monitoring_tools-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aaf937680b77637ed32fecee68dc6101",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7962,
"upload_time": "2025-07-23T14:38:20",
"upload_time_iso_8601": "2025-07-23T14:38:20.662356Z",
"url": "https://files.pythonhosted.org/packages/09/27/7fd15d7bd9ca417c8d2323a773beb51cb90af00d26553539b7374f1dddbd/pbs_monitoring_tools-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "755e878aa50e76861040b96854e675bd611b2faecfd6b6657d990c13d664788d",
"md5": "873985882b2fd175190773bfb6d4192d",
"sha256": "3454ca2b53b7287e180ef69020afb3b14f03386d09f7082861503fcc83197695"
},
"downloads": -1,
"filename": "pbs_monitoring_tools-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "873985882b2fd175190773bfb6d4192d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8853,
"upload_time": "2025-07-23T14:38:21",
"upload_time_iso_8601": "2025-07-23T14:38:21.993391Z",
"url": "https://files.pythonhosted.org/packages/75/5e/878aa50e76861040b96854e675bd611b2faecfd6b6657d990c13d664788d/pbs_monitoring_tools-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 14:38:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pbs-monitoring-tools"
}
