VMWare Connector installation

What is it?

This page walks you through installing the VMWare Connector and registering it with either Enterprise Manager or Solution Manager. After you finish the steps on this page, OpCon jobs can run VMWare operations such as backup, clone, power operations, reconfiguration, and snapshots. For the full list of supported operations, refer to Installation overview.

At a glance

Step	What you do	Where
1	Confirm system requirements	This page
2	Install the connector	This page
3	Set up the connector in either Enterprise Manager or Solution Manager	This page
4	Update connector settings	Configuration
5	Define your first VMWare job	Enterprise Manager job definition or Solution Manager job definition

Requirements

Before you begin, ensure that the target machine meets the following requirements:

• A supported version of Windows with .NET Framework 4.5 installed.
• A supported version of the Windows Agent installed on the machine.

note

The VMWare Connector must have the address of the host supporting VMWare web services in the configuration file. You set this address after installation, in Configuration.

Java is included

You do not need to install Java. The connector package contains its own Java runtime, and both connector executables use it rather than any Java installed on the machine.

New installation

A new installation has two phases:

1. Install the connector on the target Windows machine. This step is the same for everyone.
2. Set up the connector in OpCon using either of the following paths. These paths are alternatives — choose the one that matches how you define jobs:
   • Enterprise Manager path — for sites that define jobs in Enterprise Manager.
   • Solution Manager path — for sites running OpCon 25.0.3 or greater that define jobs in Solution Manager.

Install the connector

To install the connector, complete the following steps:

1. Log in to the machine as a Local Administrator.

2. Go to https://files.smatechnologies.com to download the files.

3. Enter your username and password and select the Login button.

4. Go to Root Folder > Connectors and Add-ons > Connectors > VMWare.

5. Download the connector zip file, VMWareConnector-win.zip.

6. Extract the contents of the zip file into the directory where you want the connector to run.

   Example

   C:\Program Files\OpConxps\VMWare x64

There is no installation wizard. The connector runs from the directory you extract it into, so choose that directory before you extract rather than moving the files afterwards.

After you extract the zip file, the directory contains:

Item	What it is
vmware.exe	The connector. This is the program the OpCon job runs.
Encrypt.exe	The tool that encodes the VMWare password for Connector.config. Refer to Configuration.
Connector.config	The configuration file, which you update in Configuration.
java	The Java runtime the connector uses. Leave it in place.
emplugins	The Enterprise Manager sub-type plug-in, used in the Enterprise Manager path.
log	The log directory. Refer to Configuration for what the connector writes here.

Enterprise Manager path

Use this path if you define VMWare jobs in Enterprise Manager. It involves two procedures:

1. Configure the VMWarePath global property — tells OpCon where the connector is installed.
2. Install the Enterprise Manager sub-type — adds the VMWare job sub-type to Enterprise Manager.

Configure the VMWarePath global property

The VMWarePath global property tells Enterprise Manager where the VMWare Connector is installed.

note

If you have the VMWare Connector installed on multiple machines, define a unique global property for each connector.

To configure the VMWarePath global property in Enterprise Manager, complete the following steps:

1. Log in to Enterprise Manager on the Windows machine where Enterprise Manager is installed.

2. In the Navigation Panel, under the Administration topic, open Global Properties. The Global Properties screen is displayed.

3. Select the Add button on the Global Properties toolbar.

4. In the Name field, enter VMWarePath.

5. In the Documentation field, enter the documentation for the property.

6. In the Value field, enter the directory that contains vmware.exe on the Windows machine. Enter the directory only, without a file name and without a trailing backslash.

   Example

   C:\Program Files\OpConxps\VMWare x64

   note

   The sub-type builds the command line by appending \vmware.exe to this value, so the property holds the directory and the sub-type supplies the program name.

7. Select the Save button on the Global Properties toolbar. The global property is saved.

Install the Enterprise Manager sub-type

The Enterprise Manager sub-type is a plug-in package that adds a VMWare job definition screen to Enterprise Manager. Install it on every Enterprise Manager machine where you define VMWare jobs.

To install the Enterprise Manager sub-type, complete the following steps:

1. Log in to the machine where Enterprise Manager is installed.

2. In Windows Explorer, go to the EnterpriseManager folder.

   Example

   C:\Program Files\OpConxps\EnterpriseManager x64

3. Confirm that the dropins folder exists. If it does not exist, right-click in the EnterpriseManager folder, select New > Folder, and name the folder dropins.

4. Go to the location where you installed the VMWare Connector.

   Example

   C:\Program Files\OpConxps\VMWare x64

5. Open the EMPlugins folder and copy the jar file.

   Example

   com.sma.ui.core.jobdetails.vmware_1.0.0.yyyymmddhhss.jar

6. Paste the jar file into the EnterpriseManager\dropins folder on the Enterprise Manager machine.

   Example

   C:\Program Files\OpConxps\EnterpriseManager x64\dropins\com.sma.ui.core.jobdetails.vmware_1.0.0.yyyymmddhhss.jar

To verify that the sub-type is installed, complete the following steps:

1. Log in to Enterprise Manager.
2. In the Navigation Panel, under the Administration topic, open Job Master. The Job Master screen is displayed.
3. In the Schedule list, select a schedule.
4. Select the Add button on the Job Master toolbar.
5. Under Job Properties in the Job Details frame, in the Job Type list, select Windows.
6. In the Job Sub-Type list, confirm that VMWare is available, and select it.

Next: Update connector settings in Configuration, then define your first job in Enterprise Manager job definition.

Solution Manager path

Use this path if you define VMWare jobs in Solution Manager. It is available with OpCon 25.0.3 or greater through the ACS framework.

The Solution Manager path involves four procedures, in this order:

1. Install the Solution Manager sub-type — copies the ACS plug-in into your OpCon and Relay installations.
2. Create the script type and runner — registers the ACSVMWare script type and a script runner in Solution Manager.
3. Create the Connector.config script — stores your connector configuration centrally in OpCon.
4. Create the VMWare agent definition — creates the agent that ties the configuration script to the connector.

note

All interactions with the Solution Manager sub-type are completed in Solution Manager.

Install the Solution Manager sub-type

To install the Solution Manager sub-type, complete the following steps:

1. Download the ACSVMWare zip file from the FTP site under OpCon Releases > Integrations > VMWARE.

2. Extract the ACSVMWare directory and copy it into the \SAM\plugins directory for the OpCon and Relay installations.

3. Restart the affected services:

   Installation	Action
   OpCon	Stop and restart the SMA OpCon RestAPI and SMA OpCon Service Manager services.
   Relay	Stop and restart the Relay Service.

Create the script type and runner

When you use the Solution Manager sub-type, you must register an ACSVMWare script type and a matching script runner. These let Solution Manager identify and run the connector configuration script.

Create the script type

To create the script type, complete the following steps:

1. In Solution Manager, select Library.
2. Select Scripts.
3. In the upper-right corner, select Script Types.
4. Select the +Add button.
5. In the Name field, enter ACSVMWare.
6. In the File Extension field, enter txt.
7. In the Description field, enter Used for ACSVMWare Integration.
8. Select the Save button. The script type is saved.

Create the script runner

To create the script runner, complete the following steps:

1. In Solution Manager, select Library.
2. Select Scripts.
3. In the upper-right corner, select Script Runners.
4. Select the +Add button.
5. In the Name field, enter ACSVMWare.
6. In the OS field, select VMWare from the list.
7. In the Type field, select ACSVMWare from the list.
8. In the Command field, enter cmd.exe /c.
9. Select the Save button. The script runner is saved.

Create the Connector.config script

The Connector.config script holds the connector configuration centrally in OpCon, so you do not need to maintain a per-machine file.

note

Before you create the script, prepare the contents of your Connector.config file. For the field reference, refer to Configuration.

To create the Connector.config script, complete the following steps:

1. In Solution Manager, select Library.
2. Select Scripts.
3. In the upper-right corner, select Scripts.
4. Select the +Add button.
5. In the Name field, enter a name for the script. Continuous suggests using the proposed agent name with _config appended.
6. In the Type field, select ACSVMWare from the list.
7. Assign the required roles.
8. In the Script field, paste the contents of the Connector.config file you prepared.
9. Select the Save button. The script is saved.

Create the VMWare agent definition

The agent definition ties together the connector, the configuration script, and the VMWare host that the connector talks to.

To create the VMWare agent definition in Solution Manager, complete the following steps:

1. In Solution Manager, select Library.
2. Select Agents.
3. Select the +Add button.
4. In the Name field, enter the name of the agent.
5. In the Type field, select VMWare from the list.
6. Configure the General Settings:
   1. Select General Settings.
   2. In the NetCom field, enter <Default> or a NetCom or Relay name.
7. In the VMWare Settings section, enter the required information.
8. In the Client Information section, complete the following fields:
   1. In the Directory field, enter the installation directory of the VMWare Connector.
   2. In the Name field, enter vmware.exe (the default value).
   3. In the Config File Name field, enter Connector.config (the default value).
9. In the Config Script section, complete the following fields:
   1. In the Script Runner field, select ACSVMWare from the list.
   2. In the Script field, select the configuration script you previously created from the list.
10. Select the Save button. The agent is saved.
11. Select Communication Settings and verify that the Requires XML Escape Sequences: User-Defined field is set to True. If it is not, change the field and save the definition.

Next: Define your first job in Solution Manager job definition.

Upgrade installation

To upgrade the VMWare Connector, extract the new zip file into the same directory as the previous installation. For the download and extract steps, refer to New installation.

caution

Back up Connector.config first

The zip file contains a Connector.config file, so extracting it over an existing installation replaces the one you configured, including the encoded password. Copy your Connector.config somewhere else before you extract, then put it back afterwards.

Silent mode

To install the VMWare Connector in silent mode, refer to the Silent Mode section in the OpCon Installation online help.

FAQs

Do I need to install Java separately?

No. The connector package contains its own Java runtime in a java directory, and both executables use it. Installing or upgrading Java on the machine does not affect the connector.

What's in the installation directory after install?

Two executables, vmware.exe and Encrypt.exe; a Connector.config file; and three directories — java for the bundled Java runtime, emplugins for the Enterprise Manager sub-type, and log.

Do I need to set up both the Enterprise Manager sub-type and the Solution Manager sub-type?

No. The two sub-types are alternative paths. Set up the one that matches how your team defines jobs. If you define jobs in Enterprise Manager, follow the Enterprise Manager path. If you define jobs in Solution Manager and you run OpCon 25.0.3 or greater, follow the Solution Manager path.

Will an upgrade overwrite my configuration?

Yes, if you extract over the existing directory without preparing for it. The zip file contains a Connector.config file, so it replaces the one you configured. Copy your Connector.config somewhere else first, then put it back after extracting.

Why does my Windows path get rejected?

Some systems do not allow long file names. Use the 8.3 file name format (for example, C:\Progra~1\OpConxps\) instead of the long path.

Glossary

Term	Definition
VMWare Connector	An OpCon connector that submits job requests to VMWare web services from an OpCon schedule.
Windows Agent	The OpCon agent installed on a Windows machine. The connector requires a supported Windows Agent on the host machine.
Connector.config	The VMWare Connector configuration file, extracted from the connector zip file.
ACS	The framework included in OpCon 25.0.3 or greater that provides the sub-type mechanism supporting the VMWare Connector in Solution Manager.
vCenter	The VMWare server providing the VMWare web services interface. The connector supports vCenter or ESXi 5.5.
ESXi	The VMWare hypervisor providing the VMWare web services interface. The connector supports vCenter or ESXi 5.5.
Enterprise Manager	The legacy Windows desktop interface for OpCon. Hosts the VMWare job sub-type plug-in.
Solution Manager	The browser-based interface for OpCon. Hosts the VMWare job type through the ACS framework.