Fork me on GitHub

pimatic-vsphere by Thorsten Reichelt (thost96) | github | npm

pimatic-vsphere

npm version dependencies status

A pimatic plugin to control virtual machines on remote vmware vsphere host.

Plugin Configuration

{
      "plugin": "vsphere",
      "host": "192.168.1.1",
      "password": "password"
}

The plugin has the following configuration properties:

Property Default Type Description
host - String Hostname or IP address of the vSphere Host
user root String vsphere host admin user
password - String Password for the user specified
keyFile - String Path to ssh key file for private key auth (password is also required!)
ssl false Boolean verify ssl certificate, default false
debug false Boolean Debug mode. Writes debug messages to the pimatic log, if set to true

Device Configuration

Please use the autodiscovery funtion on the devices page. This will display your virtual machines and fill all needed information automatically.

This manual configuration can be done, if nessesary:

vSphereControl

The vSphereControl displays the powerState of the virtual machine and three buttons for PowerOn, PowerOff and Restart.

{
        "id": "vpshere",
        "class": "vSphereControl",
        "name": "VM 11",
        "vmid": "11"
}
Property Default Type Description
state - String virtual machine power state. Will be created automatically
vmid - String virtual machine identifier used for power actions
interval 60000 Number The time interval in milliseconds at which the powerState is updated

ToDo

  • Add virtual machine performance monitoring device
  • Add vsphere control device
  • Add function for getting license info

History

See Release History.

License

Copyright (c) 2016, Thorsten Reichelt and contributors. All rights reserved.

License: GPL-2.0.

Plugin Config Options

vsphere config options
OptionDescriptionDefault
host
string
vsphere / esxi ip address or hostname
user
string
vsphere root user
"root"
password
string
password for specified user
keyFile
string
path to ssh key file
""
ssl
boolean
sslVerify
false
debug
boolean
debug output
false

Device Config Options

WMI Device config schemas

vSphereControl

vSphereControl config options
OptionDescriptionDefault
state
string
virtual machine power state
vmid
number
virtual machine id
interval
number
interval for refreshing virtual machine states
60000
pimatic-vsphere is written by Thorsten Reichelt (thost96)