ControlUp Integration

Nerdio Manager allows you to link ControlUp Monitors and deploy ControlUp monitoring agents to host pools from the Nerdio Manager console.

This article discusses the following:

• Prerequisites

• Link a ControlUp Monitor to Nerdio Manager

• Configure the ControlUp Integration Settings

• Configure ControlUp for Host Pools

• Manually Refresh ControlUp Data

• Monitor the Session Hosts in ControlUp

Prerequisites

Before you set up the integration, make sure you meet the following requirements:

• A ControlUp Real-Time DX environment.

• At least one ControlUp Monitor hosted in Azure. See this ControlUp article for more details.

• The Azure resource groups containing your Monitors are linked to Nerdio Manager. See Azure Environment: Linked Networks and Resource Groups for more details.

• The option Deploy Agents Automatically is unselected in the Agents settings window in the ControlUp Console. See this ControlUp article for more details.

• ControlUp version details and files are imported directly from the vendor's website. Ensure that the following web addresses are accessible from your Nerdio Manager web application and the AVD desktop VNet:

  • https://downloads.controlup.com/agent/versions.json

  • https://s3.amazonaws.com/downloads.controlup.com/*

Link a ControlUp Monitor to Nerdio Manager

Nerdio Manager requires access to a ControlUp Monitor to pull data (sites, folders, etc.) from your environment. This data is refreshed daily. However, you can manually refresh ControlUp data. See Manually Refresh ControlUp Data for details.

To link a ControlUp Monitor to Nerdio Manager:

1. In Nerdio Manager, navigate to Settings > Integrations.

2. In the ControlUp Daas Monitoring tile, select Link.

3. Enter the following information:

   • Resource Group: From the drop-down list, select the resource group that contains the ControlUp Monitor.

   • ControlUp Monitor: From the drop-down list, select the ControlUp Monitor.

4. Once you have entered the desired information, select OK.

   Notes:

   • Nerdio Manager performs a first-time discovery on the Monitor, which can take up to 10 minutes. You can view the task's progress in the Settings Tasks section.

   • After the first Monitor has completed linking, you can add the rest of your monitors simultaneously. Ensure that all the linking tasks are complete for all of the Monitors before proceeding to the next step.

   • You may select the Monitor's name to view its details.

Configure the ControlUp Integration Settings

After you have linked the ControlUp Monitors, follow these steps to enable and configure the ControlUp integration settings.

To configure ControlUp integration settings:

1. In Nerdio Manager, navigate to Settings > Integrations.

2. In the ControlUp Daas Monitoring tile, select Disabled.

3. Enter the following information:

   • Agents Authentication Key: Type, or copy/paste, the Agent Authentication Key.

     Note: The Agent Authentication Key can be found in the ControlUp Configuration Console. The same key is used for all agents deployed from Nerdio Manager. See this ControlUp article for more details about retrieving the Agent Authentication Key.

   • Select Monitor: From the drop-down list, select the Monitor(s) to use.

     Note: It is recommended that you select more than one Monitor.

   • Select Version: From the drop-down list, select the default version of the ControlUp Agent that is used for all host pools.

   • Enable removal of deleted desktops from ControlUp: Select this option if you want Nerdio Manager to be able to remove deleted session hosts from ControlUp's records,

     • Retention period: Type the retention period in days.

       Note: It is recommended that you enable this option and set the data retention period to 0 days so that the ControlUp Console stays up-to-date.

   • Registration Key: Type or paste the agent registration key.

     Note: The agent registration key can be found in the ControlUp Configuration Console. Inside the console navigate to Settings > Agent > Agent Deployment Settings. The same key is used for all agents deployed from Nerdio Manager.

     • Enable outbound communication: Select this option to enable outbound communication.

       Note: ControlUp outbound communication requires .Net 4.8 Framework. The minimum Windows versions that support it by default are Windows 10 19H1, Windows 11 21H2, and Windows Server 2022.

4. Once you have entered the desired information, select OK.

Configure ControlUp for Host Pools

Once ControlUp is linked and the integration settings are configured, you can configure ControlUp for host pools.

To configure ControlUp for host pools:

1. In Nerdio Manager, locate the host pool you wish to work with.

2. From the action menu, select Properties > ControlUp.

3. Enter the following information:

   • Use ControlUp monitoring: Toggle this option On.

   • Use default: Select this option to use the default ControlUp integration settings. Unselect this option to customize the settings for this host pool.

   • Authentication Key: Select Use custom and then type, or copy/paste, the Agent Authentication Key.

   • Agent Version: From the drop-down list, select the preferred default version of the ControlUp Agent that is used for all host pools.

   • Monitor: From the drop-down list, select the Monitor(s) to use.

   • Enable removal of deleted desktops from ControlUp: Select this option if you want Nerdio Manager to be able to remove deleted session hosts from ControlUp's records,

     • Retention period: Type the retention period in days.

   • Registration Key: Type or paste the agent registration key.

     • Enable outbound communication: Select this option to enable outbound communication.

     • Custom outbound communication setting: Select this option to enable custom outbound communication settings.

   • Select Site: From the drop-down list, select the preferred ControlUp site.

   • Select Folder: From the drop-down list, select the appropriate ControlUp folder for the agent.

     Tip: Folders are refreshed every 24 hours. To manually refresh, see Manually Refresh ControlUp Data for details.

   • Maintenance Window: Optionally, toggle on this option to create a maintenance window to control when application tasks are performed.

     Note: If configured, no application tasks are performed outside of the specified window. This window allows tasks to be automatically performed only during specified hours, ensuring that the user experience is not disrupted.

     • Maintenance Window days and times: From the drop-down lists, configure the days and times of the maintenance window.

   • Limit concurrent tasks: Select this option and type the maximum number of concurrent deployment tasks for the host pool.

   • Use alternate ControlUp settings for DR hosts: Optionally, toggle on this option to specify alternate disaster recovery hosts.

     • Alternate Monitor: From the drop-down list, select the alternate DR Monitor(s) to use.

     • Alternate Site: From the drop-down list, select the alternate ControlUp DR site.

     • Alternate Folder: From the drop-down list, select the alternate ControlUp DR folder.

4. Once you have entered the desired information, select Save or Save & close.

   Notes:

   • Nerdio Manager installs the agent on every session host in the host pool. Session hosts that are powered off are powered on to install the agent. Once the agent install is complete, the session host is powered off again.

   • The agent is automatically installed on any new session hosts created in the host pool.

   • You can see the agent install task's progress in the Host Pools Tasks section.

Manually Refresh ControlUp Data

ControlUp data is refreshed every 24 hours. There may be instances where you need to refresh the data manually. For example, you may need to see new folders that were just added and can't wait for the next scheduled refresh.

To manually refresh ControlUp data:

1. In Nerdio Manager, navigate to Settings > Integrations.

2. In the ControlUp Daas Monitoring tile, select Sync.

3. From the drop-down list, select the ControlUp Monitor to refresh.

4. Select OK.

Monitor the Session Hosts in ControlUp

After Nerdio Manager installs the ControlUp Agent on a session host, you can see the session host in your ControlUp Console.

In this example, we can see the session hosts in ControlUp after we enabled the integration. The session hosts are located in the site and folder that we specified.