VMWare Step Plugins
Rundeck, Inc.

The resource model plugin gets the VMs from a VSphere ESXi server or VCenter Server as Rundeck Nodes.

VMWare Sphere Plugin

Resource Model Plugin

The resource model plugin gets the VMs from a VSphere ESXi server or VCenter Server as Rundeck Nodes.

Configuration:

Configuration Options

  • Custom Mapping:

Add custom mappings in the form attributeName.selector=vmAttribute or attributeName.default=value, separated by new line.

For example, to add a status attribute based on a VM's attribute, you can use status.selector=guest.guestState

To create an attribute based on concatenated fields, used comma to concatenated them: nodename.selector=vm.name,vm.dataCenter

Custom tags can be added based on VM's attributes, for example tags.selector=guest.guestState,guest.toolsStatus

Default values can be added using attributeName.default=format. Also, the default values can be used per osFamily value, for example: username.windows.default=Administrator, `username.linux.default=root

Example of a custom mapping:

username.default=rundeck
username.windows.default=Administrator
username.linux.default=root
node-executor.windows.default=WinRMPython
file-copier.windows.default=WinRMcpPython
winrm-password-storage-path.windows.default=keys/vwmare/windows.password
nodename.selector=vm.name,vm.dataCenter

In case you work on multiples datacenter environment, you can use the datacenter name as part of the node name, to avoid duplicate nodes from VMs that has the same name. For example, add this on the custom mapping: nodename.selector=vm.name,vm.dataCenter

  • Just Running VMs.: Filter by running vms
  • DataCenter: (Optional) filter by DataCenter. Leave it blank for all DataCenters
  • Display attribute with subgroups: Display node attribute with subgroups (format group.subgroup)
  • Attributes group: List attributes group to display of the VMs. Options are: Guest,Config,Runtime,Summary

Authentication Options

  • URL Server: URL of the Server, eg: https://vmware-server
  • Username: Login Username
  • Password: Username Password
  • Ignore SSL certificate: Connecting with the server ignoring the SSL certificate

Power Operations Workflow Node Step

Allows users to Power-Off/Power-On/Restart/Suspend/Stand-By a VM. This plugin is a workflow node step, so you need dispatch this step to the nodes that you want to apply the operation.

Configuration

  • Operation: "reboot", "poweron","poweroff","standby","suspend"

Authentication Options

  • URL Server: URL of the Server, eg: https://vmware-server
  • Username: Login Username
  • Password: Username Password
  • Ignore SSL certificate: Connecting with the server ignoring the SSL certificate

Clone VM Workflow Step

This workflow step plugin clones existing VMs.

Configuration

  • Source VM Name: VM Name that will be clone
  • New VM Name: Destination VM Name
  • DataCenter: DataCenter Name. If the DataCenter is not set, the VM will be searching on the root folder

Authentication Options

  • URL Server: URL of the Server, eg: https://vmware-server
  • Username: Login Username
  • Password: Username Password
  • Ignore SSL certificate: Connecting with the server ignoring the SSL certificate

Create VM Workflow Step

This workflow step plugin creates a new VM.

Configuration

  • Source VM Name: VM Name that will be clone
  • DataCenter Name: DataCenter name where the new VM will be created
  • VMWare Host: (Optional) If the host is not defined, it will take the first on the DataCenter
  • DataStore Name: (Optional) If DataStore, it will take one from the host
  • Network Name: Network name of the new VM
  • NIC Name: NIC Name of the new VM
  • Memory Size (MB): Memory Size of the new VM
  • Number CPU: Number CPU of the new VM
  • Guest OS ID: Guest OS ID of the new VM
  • Disk Type: Disk Type (persistent, independent_persistent)
  • Disk Size (MB): Size of the new disk (MB)
  • ISO file: (Optional) If this field is defined, the VM will mount this disk (format "[datastore] path")
  • Power ON: Power ON after the VM is created

Authentication Options

  • URL Server: URL of the Server, eg: https://vmware-server
  • Username: Login Username
  • Password: Username Password
  • Ignore SSL certificate: Connecting with the server ignoring the SSL certificate

Re-Config VM Workflow Step

This workflow step plugin re-config a VM.

Configuration

  • Source VM Name: VM Name that will be modify
  • DataCenter Name: DataCenter Name. If the DataCenter is not set, the VM will be searching on the root folder
  • Memory Size (MB): new Memory Size
  • Number CPU: new CPU number
  • Network Operation: Add or Remove network device
  • Network Name: Network Name to add or remove
  • Disk Operation: Add or Remove disk device
  • Disk Name: Disk Name to add or remove
  • Disk Type: Disk Type of the new disk
  • Disk Size: Disk Size (MB) of the new disk

Authentication Options

  • URL Server: URL of the Server, eg: https://vmware-server
  • Username: Login Username
  • Password: Username Password
  • Ignore SSL certificate: Connecting with the server ignoring the SSL certificate

TODO

  • For now , the connection with the VSphere server can be done skipping the certificate checks. Next steps is check how pass the certificate to the plugin