npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vates/node-vsphere-soap

v2.1.1

Published

interface to vSphere SOAP/WSDL from node for interfacing with vCenter or ESXi, forked from node-vsphere-soap

Downloads

104

Readme

forked from https://github.com/reedog117/node-vsphere-soap

node-vsphere-soap

Join the chat at https://gitter.im/reedog117/node-vsphere-soap

This is a Node.js module to connect to VMware vCenter servers and/or ESXi hosts and perform operations using the vSphere Web Services API. If you're feeling really adventurous, you can use this module to port vSphere operations from other languages (such as the Perl, Python, and Go libraries that exist) and have fully native Node.js code controlling your VMware virtual infrastructure!

This is very much in alpha.

Authors

Version

0.0.2-5

Installation

$ npm install node-vsphere-soap --save

Sample Code

To connect to a vCenter server:

var nvs = require('node-vsphere-soap');
var vc = new nvs.Client(host, user, password, sslVerify);
vc.once('ready', function() {
  // perform work here
});
vc.once('error', function(err) {
  // handle error here
});

Arguments

  • host = hostname or IP of vCenter/ESX/ESXi server
  • user = username
  • password = password
  • sslVerify = true|false - set to false if you have self-signed/unverified certificates

Events

  • ready = emits when session authenticated with server
  • error = emits when there's an error
    • err contains the error

Client instance variables

  • serviceContent - ServiceContent object retrieved by RetrieveServiceContent API call
  • userName - username of authenticated user
  • fullName - full name of authenticated user

To run a command:

var vcCmd = vc.runCommand( commandToRun, arguments );
vcCmd.once('result', function( result, raw, soapHeader) {
  // handle results
});
vcCmd.once('error', function( err) {
  // handle errors
});

Arguments

  • commandToRun = Method from the vSphere API
  • arguments = JSON document containing arguments to send

Events

  • result = emits when session authenticated with server
    • result contains the JSON-formatted result from the server
    • raw contains the raw SOAP XML response from the server
    • soapHeader contains any soapHeaders from the server
  • error = emits when there's an error
    • err contains the error

Make sure you check out tests/vsphere-soap.test.js for examples on how to create commands to run

Development

node-vsphere-soap uses a number of open source projects to work properly:

  • node.js - evented I/O for the backend
  • node-soap - SOAP client for Node.js
  • soap-cookie - cookie authentication for the node-soap module
  • lodash - for quickly manipulating JSON
  • lab - testing engine
  • code - assertion engine used with lab

Want to contribute? Great!

Todo's

  • Write More Tests
  • Create Travis CI test harness with a fake vCenter Instance
  • Add Code Comments

Testing

I have been testing on a Mac with node v0.10.36 and both ESXi and vCenter 5.5.

To edit tests, edit the file test/vsphere-soap.test.js

To point the module at your own vCenter/ESXi host, edit config-test.stub.js and save it as config-test.js

To run test scripts:

$ npm test

License

MIT