theapsgroup / steampipe-plugin-vsphere

Use SQL to instantly query vSphere VMs, networks and more. Open source CLI. No DB required.

vSphere plugin for Steampipe

Use SQL to query information about your vSphere resources.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install theapsgroup/vsphere

Configure the plugin using the configuration file:

vi ~/.steampipe/vsphere.spc

Or environment variables:

export VSPHERE_SERVER=10.20.30.40
export VSPHERE_USER=bob
export VSPHERE_PASSWORD=s0m3p@ss

Start Steampipe:

steampipe query

Run a query:

select
  name,
  num_cpu,
  ip_address
from
  vsphere_vm;

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

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:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/vsphere.spc

Try it!

steampipe query
> .inspect vsphere

Further reading:

• Writing plugins
• Writing your first table

Contributing

All contributions are subject to the Apache 2.0 open source license.

Credits

A Go library for interacting with VMware vSphere APIs govmomi (licensed separately using this Apache License)