Quick Start for POCs and Test Environments

Prev Next

Before you set up a ControlUp proof of concept (POC) or test environment, use the following article to get your environment ready for ControlUp.

For POC and Test Environments Only
Use this article only if you set up ControlUp in a POC or test environment. For production environments, see Install and Configure Hybrid Cloud Real-Time Console.

VDI & DaaS Requirements

The following section covers the ControlUp for VDI & DaaS requirements and prerequisites.

Set up Your Active Directory

Prepare your Active Directory by creating user groups for ControlUp users, and a service account for the ControlUp Monitor.

Organization Owner
The user that creates a ControlUp organization becomes the organization owner, making that user a ControlUp Admin. You can adjust your ControlUp security policy later to assign permissions for each user group.

Create ControlUp User Groups

Create user groups in your Active Directory for users who will use ControlUp products. You should decide now who you want to be ControlUp Admins and regular ControlUp users. 

You might also want to separate Active Directory user groups based on department, position, location, etc. for easier security control later.

Removed AD Dependency
You can deploy ControlUp Monitors on machines that are not joined to a local Active Directory (AD) domain. For details, see here.

Create a Monitor Service Account

Create a service user account for the ControlUp Monitor. This account is used by the Monitor to connect to endpoints. To get this account ready:

  • Give the account Allow Log On as a Service permission. This must be set on all machines running the Monitor service and is set under Windows Group Policy Management Settings in Local Policies/User Rights Assignment. If you want to be able to remotely deploy the ControlUp Agent on machines from the ControlUp Console, then you need to give the service account Allow Log On Locally permission.
  • Add the service account to your Active Directory group used for ControlUp Admins.
  • Set the account password to never expire.

Set up Your Machines for ControlUp

Before you upgrade to version 9.0, allow the new URLs listed here.

Console Machines

You can run the ControlUp Console on domain-joined machines with:

  • Windows 8 or higher.
  • Windows Server 2016 or higher.
  • .NET Framework 4.5 or higher.

Network Requirements

Allow the following outbound URLs over TCP port 443 on your Console Machines:

  • fe1.controlup.com (EU)
  • fe2.controlup.com (US)
  • fe3.controlup.com (EU)
  • fe4.controlup.com (US)
  • rt-app.controlup.com
  • cu-ca-eu.controlup.com (EU)
  • cu-ca-us.controlup.com (US)
  • mp.controlup.com
  • insights-hec.controlup.com
  • https://prod-dex-login.controlup.com

Agent Machines

You can install the ControlUp Agent on domain-joined machines with:

  • Windows 8 or higher.
  • Windows Server 2016 or higher.
  • .NET Framework 4.5 or higher. Version 9.0 requires .NET Framework 4.8

Network Requirements

To use Agent Outbound Communication from version 9.0, allow the following URLs:

Allow the following inbound ports on your Agent machines:

Local PortServicePurpose
40705TCPConsole to Agent communication

If you want to remotely deploy the ControlUp Agent on machines from the ControlUp Console, you must also allow the following ports:

Local PortServicePurpose
135 - 139msrpc (135)
profile (136)
netbios-ns (137)
netbios-dn (138)
netbios-ssn (139)
Used only when remotely deploying from the Console / Monitor
445microsoft-dsUsed only when remotely deploying from the Console / Monitor
RPC ports (49152 - 65535)Dynamic portsIncoming Agent connections

Monitor Machines

You can install the ControlUp Monitor on domain-joined machines with:

  • Windows Server 2016 or higher.
  • .NET Framework 4.8
  • PowerShell 5.x

Network Requirements

Allow the following outbound URLs over TCP port 443 on your Monitor Machines:

  • rt-app.controlup.com
  • cu-ca-eu.controlup.com (EU)
  • cu-ca-us.controlup.com (US)
  • insights-hec.controlup.com
  • mp.controlup.com

Allow the following inbound ports on your Monitor machines:

PortsTypeProtocolPurpose
40706TCPWCFinter-Monitor communication

If you want to remotely deploy Monitors from the ControlUp Console, then you also need to allow the following ports:

Local PortServicePurpose
135 - 139msrpc (135)
profile (136)
netbios-ns (137)
netbios-dn (138)
netbios-ssn (139)
Monitor deployment from the Console
RPC ports (49152 - 65535)
Monitor deployment from the Console

VDI App Reports from New Data Pipeline

To enable ControlUp monitors to send data to the new data pipeline for reporting, allow the following URLs:

Remote DX

The Remote DX plugin runs on:

  • Windows 10 or higher (32/64-bit).
  • MacOS 10.13.6 or higher.
  • IGEL Linux 11.3 or higher.
  • HP ThinPro OS.

Set up Your External Resources

Before you connect your external resources to ControlUp, you need to:

  • Make sure the resource meets the prerequisites
  • Allow network communication between the resource and ControlUp
  • Create a service account with the necessary permissions. These credentials are used by ControlUp to connect to the resource.
  • Set up a machine to act as a data collector for the resource. The requirements for the data collector machine depend on the resource you are connecting to.

Click on the resources below to see their requirements.

Hypervisors

Hyper-V

Component Requirements

  • Hyper-V 2016 or higher, including standalone and clustered hosts.
  • .NET Framework 4.5 or higher.
  • ControlUp Agent installed on the Hyper-V hosts

Network Requirements

  • TCP port 40705 on Hyper-V hosts for communication to the ControlUp Console.

Service Account Requirements

  • Credentials are not required to monitor Hyper-V hosts. You don't need to configure a service account.

Data Collector Requirements

  • Data collectors are not used for Hyper-V hosts. You do not need to configure a data collector machine.
vCenter

Component Requirements

  • vCenter 6.5 or higher.
  • .NET Framework 4.5 or higher.
  • PowerCLI 10.1.1.x or higher.

Network Requirements

  • Enable TCP port 443 (HTTPS) on vCenter Server.

Service Account Requirements

  • The Read-Only role is sufficient for all monitoring purposes.

Data Collector Requirements

The data collector machine must have the following requirements:

  • ControlUp Agent installed.
  • PowerCLI 10.1.1.x or higher.
  • .NET Framework 4.5 or higher.
Citrix Hypervisor

Component Requirements

  • Citrix XenServer 6.1 (with Performance Monitoring Enhancement Pack CTX135033), 6.2, 6.5, 7.x
  • Citrix Hypervisor 8.x

Network Requirements

  • TCP port 80/443 (HTTP/S) on Citrix XenDesktop Controllers.
  • TCP port 80/443 (HTTP/S) on Citrix XenServer pool master/hosts.

Service Account Requirements

  • The Read-Only role is sufficient for all monitoring purposes. If you want to perform VM power management actions, then the service account needs the VM Operators role.

Data Collector Requirements

The data collector machine must have the following:

  • ControlUp Agent installed.
  • Citrix Module.
  • .NET Framework 4.5 or higher.
Nutanix AHV

Network Requirements

  • Enable TCP port 9440 on Nutanix Prism Element.

Service Account Requirements

  • The Viewer role is sufficient to monitor AHV. If you want to perform VM power management and host maintenance actions, then the service account needs the Cluster Admin role.

Data Collector Requirements

The data collector machine must have the following:

  • ControlUp Agent installed.
  • .NET Framework 4.5 or higher.

EUC Environments

Omnissa Horizon

Component Requirements

  • Full support for Omnissa Horizon v7.4 and higher.
  • Limited support for Omnissa Horizon v7.0 - v7.3

Network Requirements

  • TCP port 443 (HTTPS) on Horizon Connection Server.

Service Account Requirements

  • The Read-Only is sufficient for all monitoring purposes. If you want to perform built-in Horizon actions, then the service account needs the following permissions:
    • Enable Farm and Desktop Pools
    • Manage Machine
    • Manage Sessions
    • Manage Global Sessions (Cloud Pod architecture only)
CVAD

Component Requirements

  • XenDesktop 7.5 or higher.
  • XenDesktop PowerShell SDK installed on all computers running the ControlUp Real-Time and ControlUp Monitor, as well as any machines configured as dedicated data collectors.

Network Requirements

  • TCP port 80/443 (HTTP/S) for communication with the ControlUp Console.

Service Account Requirements

  • The Read Only Administrator is sufficient for all monitoring purposes. If you want to perform built-in XenDesktop management actions, then the service account needs the following permissions:
    • Edit Application Group Policies
    • Edit Application Properties (Application Group)
    • Edit Delivery Group Properties
    • Edit Machine Catalog Properties
Citrix Cloud

Network Requirements

  • Allow the following URLs from the ControlUp Monitor over TCP port 443 (HTTPS):
    • https://*.cloud.com
    • https://*.citrixworkspacesapi.net
    • https://*.xendesktop.net

Service Account Requirements

  • The service account credentials must have access to the Citrix Cloud API. To learn how to create an API client and get your Citrix Cloud credentials, click here.

Cloud Environments

Amazon Web Services

Service Account Requirements

  • AWS EC2 credentials can be read-only.
Microsoft Azure

Network Requirements

  • The data collector must have access to https://management.azure.com

Service Account Requirements

  • Create a service principal with the Reader and Virtual Machine Contributor roles, and generate a ClientID and Secret Key.

Data Collector Requirements

The data collector machine must have the following:

  • ControlUp Agent installed
  • .NET Framework 4.5 or higher.
Citrix ADC

Network Requirements

  • TCP port 80/443 on Citrix ADC appliances.

Service Account Requirements

  • The Read-Only role is required. Note that you must use a local NetScaler account. AD accounts are not supported.

Data Collector Requirements

The data collector machine must have the following:

  • ControlUp Agent installed
  • .NET Framework 4.5 or higher.

Physical Endpoints & Apps Requirements

For detailed prerequisited for Edge DX deployment, read Prerequisites for Edge DX Agent Deployment.

Synthetic Testing Requirements

This section covers the requirements and prerequisites for synthetic testing with ControlUp.

Scoutbees

Scoutbees Endpoints

US Region

  • app.scoutbees.io
  • api.scoutbees.io
  • ws.scoutbees.io

EU Region

  • app.eu.scoutbees.io
  • api.eu.scoutbees.io
  • ws.eu.scoutbees.io

For testing Citrix Storefront, the location (hive) running the test requires:

  • TCP 8008 (WebSocket) to the Virtual Delivery Agent (VDA)
  • TCP 443 to Citrix ADC, Storefront, and Citrix Brokers

For testing Horizon Connection Server / UAG, the location (hive) running the test requires:

  • TCP 443 to Horizon Connection Server and Unified Access Gateway