Skip to main content

Configuration

Agent.config File Configuration

The Agent.config is the VMWare Connector configuration file name. Before configuring your first job to run, you will need to update settings in the Agent.config file. After configuration, you can proceed with defining jobs. For more information, refer to [VMWare Job Definition](VMWare Job Definition).

All settings in the configuration file apply to the machine on which the file resides.

Connector

CONNECTORDescription
NAMEThe name of the connector.

This value should not be changed.
JOB_OUTPUT_DIRECTORYThe name of the directory where created files will be placed (e.g., c:\\<root dir>\\JobOutput\\).

Note: The backslash character (\) is a special Java character and, if used, should be entered twice (\\) (e.g., c:\\VMWare\\JobOutput\\). Alternatively, the slash (/) character can be used instead (e.g., c:/VMWare/JobOutput/). The directory name must be finished with a trailing \ or /.
DEBUGIf the Connector supports a debug mode, it can be used to set the connector into DEBUG mode.

Valid values are ON or OFF (default OFF).

VMWare Information

[VMWARE INFORMATION]Description
VMWARE_HOST_ADDRESSContains the address of the host supporting VMWare web services for the VMWare installation (Supports VCenter or ESXi 5.5).

Example: https://192.168.192.155/sdk
VMWARE_USERThe name of a user that has the required privileges to perform the requested operation on the virtual machine.

If a Windows user is used, then the user name must be preceded with the domain name and two backslashes (\\).

Example: domain\\user
VMWARE_USER_PASSWORDThe password associated with the user.

The password must be encrypted using the Password Encryption Tool available in the Enterprise Manager Password Update Menu.
VMWARE_DELETE_VIRTUAL_MACHINE_ENABLEDWhen set to TRUE and the VMWare User has set the appropriate privileges (VirtualMachine.Inventory.Delete), it will be possible to delete virtual machines from the VMWare inventory.

This setting should be used with caution since once the delete has been issued, the virtual machine cannot be recovered.
Example

The following is an example of the Agent.config file:

[CONNECTOR]
NAME=VMWare Connector
JOB_OUTPUT_DIRECTORY=c:\\VMWARE\\JobOutput
DEBUG=OFF

[VMWARE INFORMATION]
VMWARE_HOST_ADDRESS=https://192.168.192.155/sdk
VMWARE_USER=SMAEUROPE\\VUser
VMWARE_USER_PASSWORD=0744f7165dc3185a5da9cb67147218e3ee9d98c80be73810ee9
d98c80be73810
VMWARE_DELETE_VIRTUAL_MACHINE_ENABLED=False

Logging and Job Output

The default logging implemented by the connector consists of a maximum cycle of five log files. The log files contain information about the connector and any jobs run by the connector. The log files are located in the <installation root>\log directory.

Information is appended into the log files and any error messages, return codes can be viewed in these log files.