# pybenproxmox
[](https://pypi.org/project/pybenproxmox/)
-3.10+-red.svg)
## Introduction
PyBEN Proxmox repository is an easy to use python utility class for Proxmox server solution
## Installation
> python -m pip install pybenproxmox
## Use
### Cli module activation
Run for a full help printout:
```bash
python -m pybenproxmox -h
```
Example for use of global variables to get all vms:
- pybenproxmox is the name of the module
- pprint is a function to print the returned dict nicely in console
- get_vms is a function to return all vms (or request a specific one)
```bash
set PROXMOX_HOST='1.1.1.1'
set PROXMOX_USER='root'
set PROXMOX_PASS='1234'
python -m pybenproxmox pprint get_vms
```
Example for passing variables directly:
- pybenproxmox is the name of the module
- get_vms is a function to return all vms (or request a specific one)
```bash
python -m pybenproxmox host=1.1.1.1 user=root password=1234 get_vms vm_id=123
```
### Python import ProxmoxCls class
```python
from pybenproxmox import ProxmoxCls
prox = ProxmoxCls(host='1.1.1.1', user='root', password='1234')
print(prox.get_vms())
```
Some of the included functions:
- get_vms: Returns a full list of vms, or list with matching vms by id or name
- clone_vms
- migrate_vm_to_node
- delete_vm
- start_vm
- stop_vm
- snapshot handling
- and more ...
Raw data
{
"_id": null,
"home_page": null,
"name": "pybenproxmox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Ben Moskovitch <darkflameben@gmail.com>",
"keywords": "python, proxmox, utils, utilities, automation, automation-tools",
"author": "Ben Moskovitch",
"author_email": "Ben Moskovitch <darkflameben@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/46/92/35f4a633fe9885e676318157ee32c6d4d028fda755b0139604e812266ea4/pybenproxmox-1.1.3.tar.gz",
"platform": null,
"description": "# pybenproxmox\r\n\r\n\r\n[](https://pypi.org/project/pybenproxmox/)\r\n\r\n-3.10+-red.svg)\r\n\r\n\r\n## Introduction\r\nPyBEN Proxmox repository is an easy to use python utility class for Proxmox server solution\r\n\r\n## Installation\r\n> python -m pip install pybenproxmox\r\n\r\n## Use\r\n\r\n### Cli module activation\r\n\r\nRun for a full help printout:\r\n```bash\r\npython -m pybenproxmox -h\r\n```\r\n\r\nExample for use of global variables to get all vms:\r\n - pybenproxmox is the name of the module\r\n - pprint is a function to print the returned dict nicely in console\r\n - get_vms is a function to return all vms (or request a specific one)\r\n```bash\r\nset PROXMOX_HOST='1.1.1.1'\r\nset PROXMOX_USER='root'\r\nset PROXMOX_PASS='1234'\r\n\r\npython -m pybenproxmox pprint get_vms\r\n```\r\n\r\nExample for passing variables directly:\r\n - pybenproxmox is the name of the module\r\n - get_vms is a function to return all vms (or request a specific one)\r\n```bash\r\npython -m pybenproxmox host=1.1.1.1 user=root password=1234 get_vms vm_id=123\r\n```\r\n\r\n### Python import ProxmoxCls class\r\n```python\r\nfrom pybenproxmox import ProxmoxCls\r\n\r\nprox = ProxmoxCls(host='1.1.1.1', user='root', password='1234')\r\nprint(prox.get_vms())\r\n```\r\nSome of the included functions:\r\n - get_vms: Returns a full list of vms, or list with matching vms by id or name\r\n - clone_vms\r\n - migrate_vm_to_node\r\n - delete_vm\r\n - start_vm\r\n - stop_vm\r\n - snapshot handling\r\n - and more ...\r\n",
"bugtrack_url": null,
"license": null,
"summary": "PyBEN Proxmox repository is an easy to use python utility class for Proxmox server solution",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://github.com/DarkFlameBEN/pybenproxmox.git"
},
"split_keywords": [
"python",
" proxmox",
" utils",
" utilities",
" automation",
" automation-tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dce3ccde8d53d38d36cd65999ac63b106dc7da520c97e7f7571c0b1686f0df89",
"md5": "941fa6cb4cdb66c89ca2a9ca5af60d51",
"sha256": "81c6871a45954ef7665e377bfaec56d6c529ef4fdba9488fd293c29d8dab1103"
},
"downloads": -1,
"filename": "pybenproxmox-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "941fa6cb4cdb66c89ca2a9ca5af60d51",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10501,
"upload_time": "2025-07-28T08:49:17",
"upload_time_iso_8601": "2025-07-28T08:49:17.482084Z",
"url": "https://files.pythonhosted.org/packages/dc/e3/ccde8d53d38d36cd65999ac63b106dc7da520c97e7f7571c0b1686f0df89/pybenproxmox-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "469235f4a633fe9885e676318157ee32c6d4d028fda755b0139604e812266ea4",
"md5": "d483dcb6e2fa86d5aadd3a144b784587",
"sha256": "3def92e4c8b34520d26f09b2960ddce7299d049ddc66b3aa3ff83c96bfc6bb16"
},
"downloads": -1,
"filename": "pybenproxmox-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d483dcb6e2fa86d5aadd3a144b784587",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11095,
"upload_time": "2025-07-28T08:49:18",
"upload_time_iso_8601": "2025-07-28T08:49:18.765372Z",
"url": "https://files.pythonhosted.org/packages/46/92/35f4a633fe9885e676318157ee32c6d4d028fda755b0139604e812266ea4/pybenproxmox-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 08:49:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DarkFlameBEN",
"github_project": "pybenproxmox",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pybenproxmox"
}
JSON
