Configuring the eG VM Agent to Communicate with the eG Manager/eG Remote Agent

The eG VM Agent, once installed and started, will begin collecting metrics on internal performance of the target Windows virtual desktop. However, the VM agent has no knowledge of the remote agent to which it needs to send the metrics; nor does it know to which Cloud Desktop component these metrics pertain. Without this knowledge, the eG VM Agent will not be able to transmit the right 'inside view' metrics to the right eG remote agent.

For this purpose, you can do either of the following:

Configure the eG VM Agent with the IP address of the eG remote agent to which it needs to transmit inside view metrics, and the nick name of the Cloud Desktop component that is monitored by the remote agent. This is the recommended approach. To know how to configure this, refer to Configuring the eG VM Agent with Details of the eG Remote Agent .
Alternatively, you can configure the eG VM Agent with the IP address/port number of the eG manager with which it should communicate. To know how to configure this, refer to Configuring the eG VM Agent with Details of the eG Manager.

If you choose this approach, then the eG VM agent will download the details of the remote agent and managed Cloud Desktop component from the eG manager itself. Take this route, only under the following circumstances:
- If you be will frequently changing the remote agent for a VM agent - i.e., using the eG manager itself, and/or;
- If you want to auto-upgrade the eG VM Agent from the eG manager.

Once the mode of communication is set, you should also explicitly enable the remote agent port (default port is 60010) via which the eG VM agent will send inside view metrics to the remote agent. To know how to achieve this, refer to Enabling the Port Via which the eG VM Agent Communicates with the eG Remote Agent.

Configuring the eG VM Agent with Details of the eG Remote Agent

To achieve the above, follow the steps

Login to the cloud desktop hosting the eG VM agent.
Go to the command prompt and switch to the <EGVMAGENT_INSTALL_DIR>\lib directory.
Run the following command:

SetManagerInfo.bat
The script will first request you to enter the nick name of the Cloud Desktop component for which this VM agent collects metrics. Make sure that this name matches the nick name of the Cloud Desktop component that has been managed in the eG manager.

This script configures the eG Manager/eG agent that the VM agent will connect to.

************************************************************************************

Please specify the Cloud Desktop component that this VM agent is part of.

The Cloud Desktop component must exist on the component on the eG manager: cloud_desk
The script will then prompt you to confirm if you want the eG VM Agent to communicate with a specific remote agent.

Do you want this VM Agent to communicate to a specific eG Remote Agent (Yes/No)?yes
Enter Yes at this prompt to confirm. Then, specify the IP address of the host on which the eG remote agent is deployed and then the TCP port number on which the remote agent is listening. The VM agent uses these details to communicate with the corresponding remote agent.

Please enter the eG Remote Agent IP/Name to which this VM Agent should communicate to:172.16.10.1

Please enter the TCP Port on which the eG Remote Agent is listening (60010): 60010
The following messages will appear once the eG VM Agent is successfully configured with the details of the remote agent it should communicate with and the Cloud Desktop component it should monitor.

The VM Agent has been successfully configured.

Stopping and starting the VM Agent now.

*****************************************************

The eGVmAgent service is stopping.

The eGVmAgent service was stopped successfully.

The eGVmAgent service is starting.

The eGVmAgent service was started successfully.

Configuring the eG VM Agent with Details of the eG Manager

To achieve the above, follow the steps

Login to the cloud desktop hosting the eG VM agent.
Go to the command prompt and switch to the <EGVMAGENT_INSTALL_DIR>\lib directory.
Run the following command:

SetManagerInfo.bat
The script will first request you to enter the nick name of the Cloud Desktop component for which this VM agent collects metrics. Make sure that this name matches the nick name of the Cloud Desktop component that has been managed in the eG manager.

This script configures the eG Manager/eG agent that the VM agent will connect to.

************************************************************************************

Please specify the Cloud Desktop component that this VM agent is part off.

The Cloud Desktop component must exist on the component on the eG manager: cloud_desk
The script will then prompt you to confirm if you want the eG VM Agent to communicate with a specific remote agent or with the eG manager.

Do you want this VM Agent to communicate to a specific eG Remote Agent (Yes/No)?no
If you entered No at step 5, specify the IP address and then the port number of the eG manager with which this VM agent should communicate.

Please enter the eG Manager IP/Name to which the VM Agent should connect: 192.168.8.149

Please enter the Port on which the VM Agent connects to the eG Manager: 7077
Then, indicate whether/not the eG manager is SSL-enabled. If it is, then specify Yes at this prompt. If not, enter No.

Is the eG Manager SSL enabled (Yes/No)? No
If the VM agent should use a proxy server to communicate with the eG manager, then specify Yes at the next prompt. If not, then enter No.

Should the VM Agent use a proxy server to connect to the eG Manager (Yes/No)?No
If you entered Yes at step 8, then you will be required to provide the IP and port number of the proxy server via which the VM agent and manager should communicate.

Please enter the proxy IP/Name: 10.10.1.13

Please enter the proxy port: 6789

Then, specify Yes at the next prompt if the proxy server to be used requires authentication. If the proxy server does not require authentication, enter No.

Does the proxy require user authentication (Yes/No)? Yes
If you had specified Yes at step 10, then you will be required to mention the proxy user name and password for authentication.

Please enter the proxy username: egtest

Please enter the proxy password: w3lc0m3
Once the details are provided, the script will then try to connect to the eG manager specified at step 6, download the details of the managed Cloud Desktop component from the eG manager, and write it to a eg_managersetup.ini file on the VM agent host. Then, the script will restart the eG VM Agent service.

Trying to connect to the eG Manager...

Connected to http://192.168.8.149:7077

Details of the eG Manager have been successfully configured in the file: C:\eGVmAgent/lib/eg_managersetup.ini

The eGVmAgent service is stopping.

The eGVmAgent service was stopped successfully.

The eGVmAgent service is starting.

The eGVmAgent service was started successfully.

Enabling the Port Via which the eG VM Agent Communicates with the eG Remote Agent

For this purpose, follow the steps below:

Login to the system hosting the eG remote agent.
Edit the eg_tests.ini file in the <EG_AGENT_INSTALL_DIR>\agent\config directory.
In the file, look for the RemoteAgentPortEnabled flag. This flag will be set to no by default. Change it to yes, so that the remote agent's port is enabled.
Below this flag, you will also find the RemoteAgentPort parameter. Here, specify the port using which the remote agent receives inside view metrics from the eG VM agent. By default, for the push model, this port number is 60010. However, if the remote agent listens on a different port in your environment, then change the port here. In this case, you will also have to make sure that you specify the same port number when configuring the eG VM agent with the details of the remote agent (see Enabling the Port Via which the eG VM Agent Communicates with the eG Remote Agent).