https://github.com/theapsgroup/steampipe-plugin-vsphere
Use SQL to instantly query vSphere VMs, networks and more. Open source CLI. No DB required.
https://github.com/theapsgroup/steampipe-plugin-vsphere
golang postgresql postgresql-fdw sql steampipe steampipe-plugin vsphere
Last synced: about 2 months ago
JSON representation
Use SQL to instantly query vSphere VMs, networks and more. Open source CLI. No DB required.
- Host: GitHub
- URL: https://github.com/theapsgroup/steampipe-plugin-vsphere
- Owner: theapsgroup
- License: apache-2.0
- Created: 2021-08-10T14:59:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T20:50:04.000Z (about 1 year ago)
- Last Synced: 2025-03-13T21:36:48.266Z (about 1 year ago)
- Topics: golang, postgresql, postgresql-fdw, sql, steampipe, steampipe-plugin, vsphere
- Language: Go
- Homepage: https://hub.steampipe.io/plugins/theapsgroup/vsphere
- Size: 10.4 MB
- Stars: 6
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vSphere plugin for Steampipe
Use SQL to query information about your vSphere resources.
- **[Get started →](https://hub.steampipe.io/plugins/theapsgroup/vsphere)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/theapsgroup/vsphere/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/theapsgroup/steampipe-plugin-vsphere/issues)
## Quick start
Install the plugin with [Steampipe](https://steampipe.io/downloads):
```shell
steampipe plugin install theapsgroup/vsphere
```
[Configure the plugin](https://hub.steampipe.io/plugins/theapsgroup/vsphere#configuration) using the configuration file:
```shell
vi ~/.steampipe/vsphere.spc
```
Or environment variables:
```shell
export VSPHERE_SERVER=10.20.30.40
export VSPHERE_USER=bob
export VSPHERE_PASSWORD=s0m3p@ss
```
Start Steampipe:
```shell
steampipe query
```
Run a query:
```sql
select
name,
num_cpu,
ip_address
from
vsphere_vm;
```
## Developing
Prerequisites:
* [Steampipe](https://steampipe.io/downloads)
* [Golang](https://golang.org/doc/install)
Clone:
```sh
git clone https://github.com/theapsgroup/steampipe-plugin-vsphere.git
cd steampipe-plugin-vsphere
```
Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:
```sh
make
```
Configure the plugin:
```sh
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/vsphere.spc
```
Try it!
```shell
steampipe query
> .inspect vsphere
```
Further reading:
* [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
* [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
## Contributing
All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-plugin-github/blob/main/LICENSE).
## Credits
A Go library for interacting with VMware vSphere APIs [govmomi](https://github.com/vmware/govmomi) (licensed separately using this [Apache License](https://github.com/vmware/govmomi/blob/master/LICENSE.txt))