Configure connections to VM managers in your infrastructure to ensure that the VM Manager Tool can gather data that is needed to calculate consumption of license metrics in your virtual environment. To configure the connection to a VM manager that is managed by a distributed or disconnected VM Manager Tool, create a configuration file, and specify the web address of the VM manager, its type, and credentials that are required to access it. To edit the connection, edit the relevant configuration file.
Before you begin
- The following procedure applies to VM managers that are managed by the distributed or disconnected VM Manager Tool. For VM managers that are managed by local or central VM Manager Tool, see: Adding VM managers in local and central mode.
- VM managers to which you configure connections through configuration files are displayed in the License Metric Tool user interface. However, they can be managed only through the VM Manager Tool command-line interface.
VM Manager Tool, starting from update 1.5.0.0, is enhanced to attempt to automatically fix the most common problems with the VM manager connection parameters. This feature is disabled by default. To enable it, go to the VM_Manager_Tool_install_dir/config directory, open the vmmmainconf.properties file, and change the value of the vmm_fix_parameters_enabled parameter to true.
While fixing connection problems, the VM Manager Tool can connect by using the HTTP protocol when the defined HTTPS connection is not available. This setting is enabled by default. To disable switching protocol from HTTPS to HTTP, go to the VM_Manager_Tool_install_dir/config directory, open the vmmmainconf.properties file, and change the value of the vmm_http_connection_allowed parameter to false. For more information, see: VM Manager Tool configuration parameters.
Procedure
-
Go to the config directory that is located in the installation directory of the VM Manager Tool.
-
To add a new connection, copy the vmmconf_template.properties file, and rename it to vmmconf_name.properties. The file now represents a new VM manager. To edit an existing connection, select the appropriate configuration file.
Attention: Each time that you create a VM manager configuration file, use the vmmconf_template.properties file as a template. Do not copy and edit configuration files that you previously created for a different VM manager. After you load the configuration file for the first time, an ID is generated for the VM manager. Each ID must be unique. When you copy and edit an existing configuration file, the ID is duplicated.
-
Edit the file, and specify the following parameters.
- vmm_url
- Specify the web address of the VM manager. You can specify either a full URL or only the host name or IP address. For example, vmm_url=http://192.0.2.0/wsman.
Important: The default URL differs depending on the virtualization type.
- vmm_type
- Specify the type of the VM manager. Use one of the following values.
For example, vmm_type=MICROSOFT_HYPER_V.
- vmm_login
- Specify the user name that is used to access the VM manager. For example, vmm_login=
administrator\cluster.com.
Important:
Avoid using non-ASCII characters in user names that are used to log in to VM managers, because the VM Manager Tool that connects to those VM managers does not support encoding into UTF-8 format.
VM managers use different definitions of users.
For Red Had OpenShift, leave the vmm_login blank.
For XenServer (formerly Citrix Hypervisor), the user is defined as user_name, for example root.
- For Microsoft Hyper-V or Azure Stack HCI, you must use the Administrator account. The user is defined as user_name\domain or user_name@domain. For example,
test\cluster.com or test@cluster.com.
For Nutanix, the user is defined as user_name, for example: test.
For Oracle Linux Virtualization Manager the user is defined as user_name@domain, for example: test@cluster.com.
- For RHV-M, the user is defined as user_name@domain, for example:
test@cluster.com.
- For VMware, the user is defined as domain\user_name, for example:
cluster.com\test.
- vmm_password
- Specify the password that is used to access the VM manager. The password is encrypted and saved when you load the configuration files.
Note:
- VM Manager Tool uses Advanced Encryption Standard (AES) for encrypting passwords associated with user accounts. By leveraging AES encryption, the users passwords remain secure and protected against unauthorized access or malicious interception.
For Red Hat OpenShift, use the ServiceAccount token as a password.
For more information about optional parameters, see: Configuration parameters.
-
Save the configuration file.
What to do next
To establish the connection to the VM manager, run the VM Manager Tool and load the configuration file.