@stordata/vsphere-soapify

vsphere-soapify

This project is an attempt to implement the vSphere SDK in Javascript, performing remote calls through the vSphere SOAP interface. It uses node-soap to transform function calls into remote SOAP calls.

Resources

A number of resources should be read and understood before using this project, especially if you intend to contribute to the code:

• vSphere SDK reference
• node-soap and especially how to call client methods
• vShere Java SDK reference for a reference implementation of programming language bindings

Architecture

The general idea is to stay close to the VMware SDK in terms of:

• Project structure
• Objects (data objects, managed objects, enumerations, etc.) modeling
• Function names
• etc.

The primary goal of this library is to remove the complexity of the SDK itself (yes, PropertyCollector is hard by design !)

Managed objects

Managed objects provide feaures exposed as methods. As a SDK user, you obtain references to a managed object and then you call a method on the object to execute a remote call on the target vSphere server. Such a method call usually return a data object, as explain below.
Commonly used managed objects include, but aren't limited to:

• PropertyCollector
• ViewManager
• SessionManager
• ...

In the SDK, every method returns a Promise resolving with the resulting data object, or rejecting with an Error.

Data objects

Data objects are data structures holding pieces of information regarding the target vSpshere server. Some data objects can be complex, containing multiple levels of other nested data objects.
In the code of this library, every data object is modeled as a Javascript class.

Usage

Using the SDK is pretty easy:

'use strict';

const { Client } = require('@vsphere/soapify'),
      client = new Client('https://vsphere.target.url');
  
client
  .login('username', 'password')
  .then(() => client.getHosts(['name']))
  .then(hosts => console.log(hosts))
  .then(() => client.logout());

Releasing

This library is released on NPM. To release a new version:

• Be on master branch and fully rebased
• Tag the version to release

git tag v$(jq -r .version package.json)

• Increment version number in package.json
• Persist changes in lockfile

npm i

• Commit your changes

git commit -am"[ci skip] Bumped version to $(jq -r .version package.json)"

• Push everything

git push $(git config branch.master.remote) master --tags