Command line tool to describe VMware vCloud Director entities
Ruby Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs/examples
lib/vcloud
scripts
spec
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Jenkinsfile
LICENSE
README.md
Rakefile
jenkins.sh
jenkins_tests.sh
rbenv_version.sh
vcloud-walker.gemspec

README.md

VCloud Walker

Vcloud-walker is a command line tool, to describe different VMware vCloud Director 5.1 entities. It uses Fog under the hood.

Installation

Add this line to your application's Gemfile:

gem 'vcloud-walker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vcloud-walker

Usage

To find usage, run vcloud-walk.

You can perform following operations with walker.

Walk vdcs:

vcloud-walk vdcs

describes all vdcs within given organization. This includes vapp, vm and network information.

Walk catalogs:

vcloud-walk catalogs

describes all catalogs and catalog items within given organization.

Walk organization networks:

 vcloud-walk networks

describes all organization networks.

Walk edgegateways:

vcloud-walk edgegateways

describes all edgegateway for given organization. Each edgegateway includes configuration for firewall, load balancer and nat services.

Walk entire organization:

 vcloud-walk organization

describes the entire organization, which includes edgegateway, catalogs, networks and vdcs within an organization.

Credentials

Please see the vcloud-tools usage documentation.

Output

Walker can output data in JSON or YAML format. The default output format is JSON. You can use command line option --yaml for yaml output.

Find sample json output in docs/examples directory.

The vCloud API

vCloud Tools currently use version 5.1 of the vCloud API. Version 5.5 may work but is not currently supported. You should be able to access the 5.1 API in a 5.5 environment, and this is currently supported.

The default version is defined in Fog.

If you want to be sure you are pinning to 5.1, or use 5.5, you can set the API version to use in your fog file, e.g.

vcloud_director_api_version: 5.1

Debugging

export EXCON_DEBUG=true - this will print out the API requests and responses.

export DEBUG=true - this will show you the stack trace when there is an exception instead of just the message.

Testing

Run the default suite of tests (e.g. lint, unit, features):

bundle exec rake

There are also integration tests. These are slower and require a real environment. See the vCloud Tools website for details of how to set up and run the integration tests.

Contributing

Please see CONTRIBUTING.md.