VMWare-reporter
===============
Extract data easily from your VMWare clusters.
## Installation
VMWare-reporter package is published [on PyPI](https://pypi.org/project/vmware-reporter/):
```sh
pip install vmware-reporter
```
## Configuration
Create file `C:\Users\$USER\AppData\Local\vmware-reporter\vmware-reporter.conf` (`/home/$USER/.config/vmware-reporter/vmware-reporter.conf` on Linux). Example:
```ini
[vmware-reporter]
host = myvcenter.example.org
user = reporter@vsphere.local
password = ...
no_ssl_verify = True
```
## 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.client 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 dump
```
Complete help about command-line usage may be displayed by typing:
```sh
vmware-reporter --help
```
## 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\nExtract data easily from 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\n\r\n## Configuration\r\n\r\nCreate file `C:\\Users\\$USER\\AppData\\Local\\vmware-reporter\\vmware-reporter.conf` (`/home/$USER/.config/vmware-reporter/vmware-reporter.conf` on Linux). Example:\r\n\r\n```ini\r\n[vmware-reporter]\r\nhost = myvcenter.example.org\r\nuser = reporter@vsphere.local\r\npassword = ...\r\nno_ssl_verify = True\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.client 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 dump\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## 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": "Extract data easily from your VMWare clusters.",
"version": "0.2.0",
"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": "2e53205e9dc2200df0c81d67693fa2ac18e8aeef61351733122ab3eb7f2742fc",
"md5": "99c758b8d49465125d8b7fc0dc395189",
"sha256": "bcc84a7999668051f9ae1c5b11565d2c66f4d4499baba08fcb628caea40845e3"
},
"downloads": -1,
"filename": "vmware_reporter-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99c758b8d49465125d8b7fc0dc395189",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30713,
"upload_time": "2024-03-22T23:31:28",
"upload_time_iso_8601": "2024-03-22T23:31:28.601851Z",
"url": "https://files.pythonhosted.org/packages/2e/53/205e9dc2200df0c81d67693fa2ac18e8aeef61351733122ab3eb7f2742fc/vmware_reporter-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 23:31:28",
"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": "reporter-utils",
"specs": []
},
{
"name": "pyvmomi",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"lcname": "vmware-reporter"
}
JSON
