Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

This integration helps the users to orchestrate VMware vCenter Server operations from the Universal Controller. It encourages collaboration by enabling automated deployment and management of Virtual machines on the EXSi hosts connected to the vCenter Server.

VMware vSphere is the virtualization platform which helps with transforming datacenters into aggregated computing infrastructure. The main components of vSphere includes ESXi and vCenter server. With this integration, the users can perform operations like list, create, delete, start, stop, suspend, resume Virtual machines and also list, create, delete Hosts and Datacenters.

• UAC communicates with VMware vCenter through the vSphere Python SDK libraries.

• Helps with automated deployment and management of virtual machine lifecycle.

• Helps with automated management of Datacenters in the vCenter server.

• Helps with automated management of Hosts in the vCenter server.

Software Requirements

This integration requires an Universal Agent and a Python runtime to execute the Universal Task against a instance.

Software Requirements for Universal Template and Universal Task

• Requires Python 3.6 or higher. Tested with the Universal Agent bundled Python distribution.

• Python modules required:

  • requests

  • vSphere Automation python client library

Software Requirements for Universal Agent

Either:

• Universal Agent for Windows x64 Version 6.9 and later with python options installed

• Universal Agent for Linux Version 6.9 and later with python options installed

Software Requirements for Universal Controller

• Universal Controller 6.9.0.0 or later is required.

Software Requirements for the Application to be Scheduled

This Universal Task has been tested with the following versions:

• vCenter Server Appliance v7.0 U2

Technical Considerations

This Universal Task uses the Python Module functions (vmware/vsphere-automation-sdk-python: Python samples, language bindings, and API reference documentation for vSphere, VMC, and NSX-T using the VMware REST API (github.com)) to makeREST API calls.

Key Features

Import the E-Mail Universal Template

To use this downloadable Universal Template, you first must perform the following steps:

1. This Universal Task requires the /wiki/spaces/UC71x/pages/5178443 feature. Check that the/wiki/spaces/UC71x/pages/5177877 system property has been set to true.

2. To import the Universal Template into your Controller, follow the instructions here.
3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Configure VMware vSphere Integration Universal Tasks

For this new Universal Task type, create a new task, and enter the task-specific details that were created in the Universal Template.

Field Descriptions for VMware vSphere Integration Universal Task

Examples for VMware vSphere Integration Universal Tasks

List VM

Start VM

Stop VM

Suspend VM

Resume VM

Create VM

Sample Configuration Script for Virtual Machine Creation

{
	"guest_OS": "xxxxx",
	"name": "xxxxx",
	"placement": {
		"datastore": "xxxxx",
		"folder": "xxxxx",
		"host": "xxxxx",
		"resource_pool": "xxxxx"
	},
	"boot_devices": [],
	"cdroms": [
	],
	"boot": {
		"delay": 0,
		"retry_delay": 10,
		"enter_setup_mode": false,
		"type": "BIOS",
		"retry": false
	},
	"cpu": {
		"cores_per_socket": 1,
		"count": 1,
		"hot_add_enabled": true,
		"hot_remove_enabled": true
	},
	"memory": {
		"hot_add_enabled": false,
		"size_MiB": 2048
	},
	"hardware_version": "VMX_17"
}

Clone VM

Delete VM

List Datacenter

Create Datacenter

Delete Datacenter

List Host

Create Host

Delete Host

Document References

This document references the following documents: