VMWare Reporter
===============
Interact easily with your VMWare clusters.
## Installation
VMWare Reporter package is published [on PyPI](https://pypi.org/project/vmware-reporter/):
```sh
pip install vmware-reporter
```
Optionaly, use specifier `[excel]` to also install dependencies for reading and writing Excel files:
```sh
pip install vmware-reporter[excel]
```
## Configuration
Create file `C:\ProgramData\vmware-reporter\.env` (`/etc/vmware-reporter/.env` on Linux).
Example:
```ini
VMWARE_HOST = myvcenter.example.org
VMWARE_USER = reporter@vsphere.local
VMWARE_PASSWORD = ...
VMWARE_NO_SSL_VERIFY = False
```
Several scopes may be distinguished. Example for two scopes named `SCOPE1` and `SCOPE2`:
```ini
VMWARE_SCOPES = SCOPE1,SCOPE2
VMWARE_SCOPE1_HOST = myvcenter1.example.org
VMWARE_SCOPE1_USER = reporter@vsphere.local
VMWARE_SCOPE1_PASSWORD = ...
VMWARE_SCOPE2_HOST = myvcenter2.example.org
VMWARE_SCOPE2_USER = reporter@vsphere.local
VMWARE_SCOPE2_PASSWORD = ...
```
## Usage examples
See also [full documentation](https://ipamo.net/vmware-reporter) (including [API reference](https://ipamo.net/vmware-reporter/latest/api-reference.html)).
VMWare Reporter may be used as a library in your Python code:
```py
from vmware_reporter import VCenterClient
with VCenterClient() as vcenter:
for vm in vcenter.iterate_objs('vm'):
print(vm.name)
```
VMWare Reporter may also be invoked as a command-line application (the `vmware-reporter` executable is installed with the package). Examples:
- Export inventory of VMWare managed objects to a YAML file:
```sh
vmware-reporter inventory
```
- Export all available information about VMWare managed objects to JSON files:
```sh
vmware-reporter export
```
- Reconfigure VMs (mass operation): copy template [vm_reconfigure.xlsx](https://ipamo.net/vmware-reporter/latest/_static/templates/vm_reconfigure.xlsx) to `data/vm_reconfigure.xlsx`, fill-in this file, then:
```sh
vmware-reporter vm reconfigure
```
- If you use several scopes, put files in `data/SCOPE1/` instead of `data/` and specify scope on the command line. Example:
```sh
vmware-reporter -e SCOPE1 vm reconfigure
```
Complete help about command-line usage may be displayed by typing:
```sh
vmware-reporter --help
```
## Run every day (using a systemd timer)
Copy [vmware-reporter.service](https://ipamo.net/vmware-reporter/latest/_static/vmware-reporter.service), [vmware-reporter.timer](https://ipamo.net/vmware-reporter/latest/_static/vmware-reporter.timer) and [notify-email@.service](https://ipamo.net/vmware-reporter/latest/_static/notify-email@.service)
in `/etc/systemd/system` and adapt them to your configuration.
Run:
sudo systemctl daemon-reload
sudo systemctl enable vmware-reporter.timer
sudo systemctl start vmware-reporter.timer
## Credits
This library leverages [pyvmomi](https://github.com/vmware/pyvmomi), the vSphere API Python bindings provided by VMWare.
## Legal
This project is licensed under the terms of the [MIT license](https://raw.githubusercontent.com/ipamo/vmware-reporter/main/LICENSE.txt).
This project is not affiliated in any way with VMWare or Broadcom.
Raw data
{
"_id": null,
"home_page": null,
"name": "vmware-reporter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "vmware, vsphere, vm, reporter",
"author": null,
"author_email": "S\u00e9bastien Hocquet <dev@ipamo.net>",
"download_url": null,
"platform": null,
"description": "VMWare Reporter\r\n===============\r\n\r\nInteract easily with your VMWare clusters.\r\n\r\n\r\n## Installation\r\n\r\nVMWare Reporter package is published [on PyPI](https://pypi.org/project/vmware-reporter/):\r\n\r\n```sh\r\npip install vmware-reporter\r\n```\r\n\r\nOptionaly, use specifier `[excel]` to also install dependencies for reading and writing Excel files:\r\n\r\n```sh\r\npip install vmware-reporter[excel]\r\n```\r\n\r\n## Configuration\r\n\r\nCreate file `C:\\ProgramData\\vmware-reporter\\.env` (`/etc/vmware-reporter/.env` on Linux).\r\n\r\nExample:\r\n\r\n```ini\r\nVMWARE_HOST = myvcenter.example.org\r\nVMWARE_USER = reporter@vsphere.local\r\nVMWARE_PASSWORD = ...\r\nVMWARE_NO_SSL_VERIFY = False\r\n```\r\n\r\nSeveral scopes may be distinguished. Example for two scopes named `SCOPE1` and `SCOPE2`:\r\n\r\n```ini\r\nVMWARE_SCOPES = SCOPE1,SCOPE2\r\n\r\nVMWARE_SCOPE1_HOST = myvcenter1.example.org\r\nVMWARE_SCOPE1_USER = reporter@vsphere.local\r\nVMWARE_SCOPE1_PASSWORD = ...\r\n\r\nVMWARE_SCOPE2_HOST = myvcenter2.example.org\r\nVMWARE_SCOPE2_USER = reporter@vsphere.local\r\nVMWARE_SCOPE2_PASSWORD = ...\r\n```\r\n\r\n\r\n## Usage examples\r\n\r\nSee also [full documentation](https://ipamo.net/vmware-reporter) (including [API reference](https://ipamo.net/vmware-reporter/latest/api-reference.html)).\r\n\r\nVMWare Reporter may be used as a library in your Python code:\r\n\r\n```py\r\nfrom vmware_reporter import VCenterClient\r\nwith VCenterClient() as vcenter:\r\n for vm in vcenter.iterate_objs('vm'):\r\n print(vm.name)\r\n```\r\n\r\nVMWare Reporter may also be invoked as a command-line application (the `vmware-reporter` executable is installed with the package). Examples:\r\n\r\n- Export inventory of VMWare managed objects to a YAML file:\r\n\r\n```sh\r\nvmware-reporter inventory\r\n```\r\n\r\n- Export all available information about VMWare managed objects to JSON files:\r\n\r\n```sh\r\nvmware-reporter export\r\n```\r\n\r\n- Reconfigure VMs (mass operation): copy template [vm_reconfigure.xlsx](https://ipamo.net/vmware-reporter/latest/_static/templates/vm_reconfigure.xlsx) to `data/vm_reconfigure.xlsx`, fill-in this file, then:\r\n\r\n```sh\r\nvmware-reporter vm reconfigure\r\n```\r\n\r\n- If you use several scopes, put files in `data/SCOPE1/` instead of `data/` and specify scope on the command line. Example:\r\n\r\n```sh\r\nvmware-reporter -e SCOPE1 vm reconfigure\r\n```\r\n\r\nComplete help about command-line usage may be displayed by typing:\r\n\r\n```sh\r\nvmware-reporter --help\r\n```\r\n\r\n\r\n## Run every day (using a systemd timer)\r\n\r\nCopy [vmware-reporter.service](https://ipamo.net/vmware-reporter/latest/_static/vmware-reporter.service), [vmware-reporter.timer](https://ipamo.net/vmware-reporter/latest/_static/vmware-reporter.timer) and [notify-email@.service](https://ipamo.net/vmware-reporter/latest/_static/notify-email@.service)\r\nin `/etc/systemd/system` and adapt them to your configuration.\r\n\r\nRun:\r\n\r\n sudo systemctl daemon-reload\r\n sudo systemctl enable vmware-reporter.timer\r\n sudo systemctl start vmware-reporter.timer\r\n\r\n\r\n## Credits\r\n\r\nThis library leverages [pyvmomi](https://github.com/vmware/pyvmomi), the vSphere API Python bindings provided by VMWare.\r\n\r\n\r\n## Legal\r\n\r\nThis project is licensed under the terms of the [MIT license](https://raw.githubusercontent.com/ipamo/vmware-reporter/main/LICENSE.txt).\r\n\r\nThis project is not affiliated in any way with VMWare or Broadcom.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Interact easily with your VMWare clusters.",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/ipamo/vmware-reporter/issues",
"Homepage": "https://github.com/ipamo/vmware-reporter"
},
"split_keywords": [
"vmware",
" vsphere",
" vm",
" reporter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d789920368d1881a82db00c23079b6afc199a9220043f3abc6536dab908eea5e",
"md5": "484e478b3c8e95b315ea0669fe4ec60d",
"sha256": "665d82fdc9c933fd9ad2a7ac7fcf0aa9aa9d15c2cb1d53f75e125b0317ee1479"
},
"downloads": -1,
"filename": "vmware_reporter-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "484e478b3c8e95b315ea0669fe4ec60d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 57730,
"upload_time": "2024-12-19T19:39:53",
"upload_time_iso_8601": "2024-12-19T19:39:53.139863Z",
"url": "https://files.pythonhosted.org/packages/d7/89/920368d1881a82db00c23079b6afc199a9220043f3abc6536dab908eea5e/vmware_reporter-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 19:39:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ipamo",
"github_project": "vmware-reporter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "zut",
"specs": [
[
">=",
"1.1.5"
]
]
},
{
"name": "pyvmomi",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"lcname": "vmware-reporter"
}
JSON
