Gem Version Build Status Dependency Status Inline docs

This is the official Chef test-kitchen plugin for VMware REST API. This plugin gives kitchen the ability to create, bootstrap, and test VMware vms.

This is a test-kitchen plugin that allows interaction with vSphere using the vSphere Automation SDK.

Please refer to the CHANGELOG for version history and known issues.


  • Chef 13.0 higher
  • Ruby 2.3.3 or higher


This driver has a dependency. It requires the vSphere Automation SDK be installed. The steps to do that are as follows:

Using ChefDK, simply install the Gem:

chef gem install kitchen-vcenter

If you're using bundler, simply add Chef and kitchen-vcenter to your Gemfile:

gem 'chef'
gem 'kitchen-vcenter'


A sample .kitchen.yml file, details are below.

  name: vcenter
  vcenter_username: <%= ENV['VCENTER_USER'] || "[email protected]" %>
  vcenter_password: <%= ENV['VCENTER_PASSWORD'] || "[email protected]!" %>
  vcenter_disable_ssl_verify: true
    datacenter: "Datacenter"

  - name: ubuntu-1604
      template: ubuntu16-template
  - name: centos-7
      template: centos7-template

Required parameters:

The following parameters should be set in the main driver_config section as they are common to all platforms.

  • vcenter_username - Name to use when connecting to the vSphere environment
  • vcenter_password - Password associated with the specified user
  • vcenter_host - Host against which logins should be attempted
  • vcenter_disable_ssl_verify - Whether or not to disable SSL verification checks. Good when using self signed certificates. Default: false

The following parameters should be set in the driver_config for the individual platform.

  • template - Template or virtual machine to use when cloning the new machine
  • datacenter - Name of the datacenter to use to deploy into

Optional Parameters

The following optional parameters should be used in the driver_config for the platform.

  • targethost - Host on which the new virtual machine should be created. If not specified then the first host in the cluster is used.
  • folder - Folder into which the new machine should be stored. If specified the folder must already exist.
  • resource_pool - Name of the resource pool to use when creating the machine. If specified the resource pool must already exist


For information on contributing to this project see


  • Report issues/questions/feature requests on [GitHub Issues][issues]

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Run the tests and rubocop, bundle exec rake spec and bundle exec rake rubocop
  4. Commit your changes (git commit -am 'Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request


Author:: Russell Seymour ([email protected])

Author:: JJ Asghar ([email protected])

Copyright:: Copyright (c) 2017 Chef Software, Inc.

License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.