- Abstract
- Intended Audience
- What’s in the SDK?
- Quick Start Guide for JavaScript Samples Using NodeJS
- Submitting samples
- Resource Maintenance
- Repository Administrator Resources
- VMware Resources
The VMware vSphere Automation SDK for REST enables programmatic access to vSphere. The SDK includes JavaScript samples to demonstrate how to invoke APIs for Tagging and Virtual Machine Operations as well as Postman examples.
All samples support vCenter 6.5. Tagging samples also support vCenter 6.0.
The VMware vSphere Automation SDK for REST is intended for the following audiences:
- Developers who create clients that connect to the vAPI endpoint to use VMware vSphere Automation SDK for REST Services.
The VMware vSphere Automation SDK for REST provides a client SDK that contains samples that demonstrate how to use the vSphere Automation REST API and sample code. The following table contains a brief description of the contents of the vSphere Automation SDK for REST.
Directory structure (under VMware-vSphere-Automation-SDK-REST):
| Directory | Contents |
|---|---|
| samples/javascript/tagging | Javascript samples that demonstrate how to construct REST API requests for Tagging. |
| samples/javascript/vcenter | Javascript samples that demonstrate how to construct REST API requests for Virtual Machine Operations |
| samples/postman | Postman samples that demonstrate how to construct REST API requests for Virtual Machine Operations. |
These steps will walk you through getting the NodeJS-based JavaScript samples running.
If you don't already have NodeJS installed you will need to download and install it from here. Additionally, the samples leverage various Open Source NodeJS which must be installed using the Node Package Manager (npm) which you can install from here.
To run the JavaScript samples you must first install the required node packages referenced in javascript/vcenter/package.json using npm file as follows:
cd samples/javascript/vcenter
npm install
You may also use the ./build.sh script included at the root of the SDK. This script will run npm install on both tagging and vcenter samples so as well as execute any tests specified in the respective package.json files.
For a complete list of included samples refer to the "scripts" section of the javascript/vcenter/package.json file. To run a sample use npm as follows:
npm run <sample_name>
Ex:
npm run host-connect
For a list of samples run:
npm run
Before you start working with this project, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
The following information must be included in the README.md or in the sample docstring in case a README already exists in same folder.
- Author Name
- This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
- Date
- Date the sample was originally written
- Minimal/High Level Description
- What does the sample do?
- Any KNOWN limitations or dependencies
The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource.
- vSphere version against which the sample was developed/tested
- SDK version against which the sample was developed/tested
- Additional Version information for any dependencies against which the sample was developed/tested
- Follow the GitHub process
- Please use one branch per sample or change-set
- Please use one commit and pull request per sample
- Please post the sample output along with the pull request
- If you include a license with your sample, use the project license
Ownership of any and all submitted samples are maintained by the submitter.
Any bugs or other issues should be filed within GitHub by way of the repository’s Issue Tracker.
Any community member can resolve issues within the repository, however only the board member can approve the update. Once approved, assuming the resolution involves a pull request, only a board member will be able to merge and close the request.
It is highly recommended to add any and all submitted samples to the VMware Sample Exchange: https://code.vmware.com/samples
Sample Exchange can be allowed to access your GitHub resources, by way of a linking process, where they can be indexed and searched by the community. There are VMware social media accounts which will advertise resources posted to the site and there's no additional accounts needed, as the VMware Sample Exchange uses MyVMware credentials.
Board members are volunteers from the SDK community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.
Members:
- Steve Trefethen (VMware)
- Alan Renouf (VMware)
Items added to the repository, including items from the Board members, require 2 votes from the board members before being added to the repository. The approving members will have ideally downloaded and tested the item. When two “Approved for Merge” comments are added from board members, the pull can then be committed to the repository.