• SQL Server Prerequisites for On-Premises Installation

    ControlUp On-premises uses Microsoft’s SQL Server to store and retrieve data, like script-based actions, trigger incidents, or historical data for Insights on-premises. During the installation of the on-premises server installation, you can choose between a Light-mode or Production-Mode installation. If you select Production Mode, you need to provide the name of your SQL Server instance, the database name that you preconfigured, and the authentication mode, which can be either Windows or SQL Authentication.

    Prerequisites

    If you want to use ControlUp Real-Time Console with your own SQL Server database, you have to make sure that your SQL Server environment meets the following requirements:

    • SQL Server 2014, 2016, or 2017
    • Editions: Standard or Enterprise
    • 10 GB of free disk space on the partition where SQL data will be stored

    The user that you provided in the on-premises installation wizard must be assigned the db_owner database role. The default database name in the installation wizard is shown as ControlUpDB. This may be changed based on your organization's requirements. Be aware that the database must already exist during installation, otherwise you are not able to continue with the on-premises server installation.  

  • On-premises Installation Prerequisites at a Glance for 8.1 and Higher

    The number and size of the servers required is determined by your company's size and level of use of ControlUp. While some of these can be installed on the same machine (for example for POCs), the Insights On-premises server must be installed on a separate server from the application and console. 

    Here is a quick description of each of the installed modules:

    • ControlUp Application Server: Backend components necessary for running ControlUp disconnected from any connections to the internet.
    • ControlUp Console: Gathers and displays current health & performance data. ControlUp's main frontend component. Can be installed on the same machine as the application.
    • Insights: Optional. Analyzes and reports 24/7 accumulated activity and performance data over time. Must be installed on a separate server from any of the other ControlUp modules. 
      • Insights On-Premises Forwarder (IOP Forwarder): Required if using Insights and requires a separate installation. Forwards the data from the monitor (see below) to the Insights server and must be installed either on a server with a shared activity folder that the monitors can access or on every monitor server. 
    ControlUp Module ControlUp Config Server Console Insights Server
    Machine Windows Server Windows Server or
    Windows 
    OVA or Linux
    *Must be installed separately from Console and Application
    Operating system  Windows Server supported versions:
    2019,
    2016,
    2012 R2,
    2008 R2
    Windows Server supported versions:
    2019,
    2016,
    2012 R2,
    2008 R2
    OR
    Windows 10, 8, 8.1, 7

    Supported OVA:
    vSphere 6.5 and above.
    Supported Linux OS versions:
    Photon OS 3.0
    CentOS 7
     (or above)
    Ubuntu 16.4
     (or above)
    Red Hat Enterprise Linux 7.6

    CPU* 2 CPU  2 CPU 12 CPU
    Memory* 8 GB RAM  8 GB RAM 32 GB RAM
    Disk space* 10 GB free  10 GB free 100 GB OS Drive
    50 GB Data
    Required installed
    software/
    permissions/other
    • .Net Framework versions 4.5 and above (4.7.2 recommended)
    • .Net Framework version 3.5 SP1 (required in parallel to 4.5 and above)
    • PowerShell 5.x or above

    Recommended for the installation:

    • IP address or FQDN of the machine where the Insights server will be installed.
    • Your SMTP server address
    .NET 4.5 or later

    For Linux:

    • Python 3.6
    • Docker 18.09.8 
       (or above)

    IOP Forwarder (see below)

     

    *Minimum recommended. For details, see Sizing Guidelines for ControlUp v8.x

    Database information

    Installation connects to a database which can be a SQL instance that already exists in your environment or one dedicated for ControlUp. For a production environment, the DBA should ready a dedicated database prior to the installation with a service account for ControlUp that has database owner rights. 

    Server Versions Minimum Size Collation

    Microsoft SQL versions (Standard & Enterprise editions) - SQL Server 2017, 2016, 2014

    10 GB SQL_Latin1_General_CP1_CI_AS

    Additional components 

    Once you've installed the ControlUp application, console & Insights, you deploy the following from the ControlUp console to retrieve monitoring data:

    • Agent: Lightweight component that enables rapid deployment and a minimal performance footprint on the managed machine. Every managed Windows machine that you want monitored in your environment must have an agent deployed for data to be sent to the console. (Linux machines are monitored via API.)
    • Data CollectorOptional. For increased performance of the console & monitor. Collects metrics from ‘external’ sources such as hypervisors, VMware, Citrix, NetScaler appliances, etc. Must be connected to an existing managed machine that has the ControlUp Agent deployed. 
    • ControlUp Monitor: Monitors assets 24/7 and enable triggers, alerts and automation. 
      Can be installed on the same machine as the application server (see above) but not recommended for larger installations. 
    ControlUp Module Agent Data Collector Monitor
    Machine No server installation necessary. Deployed onto Windows machines that are monitored by ControlUp
    (Linux monitored via API).
    Windows or Windows Server that has the ControlUp Agent deployed Windows Server
    Operating system  Windows Server supported versions:
    2019,
    2016 (Core or Full),
    2012 R2,
    2008 R2 (Full only)
    OR
    Windows 10, 8, 8.1, 7
    Windows Server supported versions:
    2019,
    2016,
    2012 R2,
    OR
    Windows 10, 8, 8.1, 7  
    Windows Server supported versions:
    2019,
    2016,
    2012 R2
    CPU* NA  2 CPU 2 CPU
    Memory* NA  8 GB RAM 8 GB RAM
    Disk Space* NA  10 GB 10 GB
    Required installed software - .NET 4.5 or later
    - Active Directory
    - ControlUp Agent
    - .Net Framework 4.7.2 or later (recommended)
    4.5 (supported)
    - Citrix SDK to connect to the Citrix API (if connecting to & monitoring Citrix products) 
    - .Net Framework 4.7.2 (recommended)
    - PowerShell 5.0
    (for Windows PS API)
    - IOP Forwarder or access to shared directory where IOP Forwarder is installed**

    *Minimum recommended. For details, see Sizing Guidelines for ControlUp v8.x

    Additional resources

     

  • Insights On-premises Virtual Appliance-based Installation - Version 8.1 and Above

    The Insights On-premises (IOP) component captures, indexes, and correlates real-time data in a searchable repository from which you can view a variety of dashboards, graphs, reports, alerts, etc.

    The following are prerequisites for an Insights server in the On-premises topology.

    Insights On-premises v8.1 contains significant improvements in performance and user experience.
    This version of Insights is available in 2 installation modes:

    • Virtual Appliance - This option comes as an OVA that runs Photon OS Linux distribution.
      Currently, it only supports VMware ESXi 6.5 or higher.
    • Linux OS Installation - This option allows you to install the IOP on various Linux distributions.

    To read more about IOP 8.1 Virtual Appliance Based Installation, see here.

    IOP 8.1 contains the IOP Forwarder. This component forwards the activity files from the monitor servers to the IOP servers.

    Insights On-premises Prerequisites

    You can install IOP 8.1 as a Single (Standalone) variation or as a Cluster for better performance in larger environments.

    • Single (Standalone) - Recommended for companies with 5000 sessions or less, in which case only one Linux server or virtual appliance needs to be used.
    • Cluster - Recommended for companies with 5000 sessions or more. In this variation, several Linux servers must be prepared: one for the master role and one data role for every 5000 sessions. In cluster mode, you need to repeat the installation for each server. 

    Sizing Examples

    # of Session # of Master nodes # of Data nodes
    6000 1 2
    9000 1 2
    11000 1 3

     

    Recommended Browser
    We recommend a Chromium-based browser such as Chrome or Microsoft Edge.

    Firewall / Port Settings

    The following ports need to be open:

    Machine type Inbound open ports
    Standalone 443
    8089
    9997

    Master

     

    443
    8089
    Data 9887
    9997
    8089


    Note: For Linux-based installations, these ports may need to be enabled at the OS level.

    More Information About Each Port

    Ports Traffic Source Usage
    9997/tcp CU Monitors Forwarder(s) send data to the data node(s).
    443/tcp IOP users IOP U/I
    8089/tcp Data nodes
    Master node
    CU Monitor
    Management port - connects between the master node and the data node(s).
    9887/tcp Data nodes Data Replication

     

    Recommended OS for a Linux-based Installation

    • Photon OS 3.0
    • CentOS 7 (or above)
    • ubuntu 16.4 (or above)
    • Red Hat Enterprise Linux 7.6
    • Additional operating systems are supported, subject to RPQ

    Required Packages for a Linux-Based Installation

    • Python 3.6
    • Docker 18.09.8 (or above)

    Sizing Recommendations

    The following is a general estimation of resources needed for both OVA and Linux-based installations. For further clarifications, please consult with our technical support team to assess your environment’s specific needs.

    Mode Cores RAM Storage

    Single (Standalone) installation 

    Under 5000 Sessions

    12 Cores (Minimum)

    32 GB 

    • SSD 100 GB (OS volume) and 500 GB* (data volume) with 800 IOPs
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    • The data volume must be mounted under “/opt/ iop_volumes”
    • The recommended file systems for the data volume are ext3, ext4 or xfs
    • If ext3 or ext4 are chosen for the data volume, the “Reserved block percentage” should be set to 1%, using the following command (as root): tune2fs -m 1 <FILESYSTEM-PATH>. i.e: tune2fs -m 1 /dev/sdb1

    Clustered installation 

    Over 5000 Sessions

    Master Server

    12 Cores (Minimum)

    32 GB

    • SSD 100 GB (OS volume) with 800 IOPs
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    Data Servers (1 data server recommended for every 5000 sessions)

    8 Cores (Minimum)

    16 GB
    • SSD 100 GB (OS volume) and 1 TB* (data volume) with 800 IOPs
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    • The data volume must be mounted under “/opt/ iop_volumes”
    • The recommended file systems for the data volume are ext3, ext4 or xfs
    • If ext3 or ext4 are chosen for the data volume, the “Reserved block percentage” should be set to 1%, using the following command (as root): tune2fs -m 1 <FILESYSTEM-PATH>. i.e: tune2fs -m 1 /dev/sdb1

    *The disk size may vary depending on the data retention period. 

    OVA Deployment 

    To install Insights, you have to prepare some installation files in advance. If you don’t have the installation files, contact support@controlup.com to receive them.

    To install the IOP OVA:

    1. Login to your V-Sphere with your Admin account.
    2. Right-click on one of your hosts, and choose Deploy OVF Template… and the Select an OVF template window appears.
      mceclip1.png
    3. Select the Local file and click Choose Files to choose the IOP OVA file.mceclip2.png
    4. Specify the virtual machine name and select the data center that the virtual machine will be under and select the host where the virtual machine will be deployed.
    5. Click Next on the Review details page once you have ensured that the details are correct.
    6. Select the Virtual Disk format and the virtual machine storage policy (both of the “thick” formats are recommended for better performance and flexibility).
    7. mceclip3.png.
    8. In the Customize Template page, specify the following for each section:
      1. Host Name Details:
        • Required: Hostname of the appliance. (i.e. iop_server)
        • Recommended: The DNS domain name of the appliance.
      2. Networking:
        • For DHCP - leave them all empty
          Note: If you are installing a clustered IOP, it is recommended to use a static network configuration, instead of a DHCP.
          • IP Address: IP + CIDR for the machine. (Default: DHCP)
            Example: CIDR notation for a static IP - 10.10.10.10/24 
          • Default Gateway - The default gateway address for this virtual machine. (Default: DHCP)
          • DNS - The IP address of the DNS server of the organization. (Default: DHCP)
      3. Credentials:
        • Required: Password for the root user of the virtual machine.
          • Password details:
            • It is recommended to use a strong password.
            • This is an Admin password for the IOP.
            • This password is to be used in all future upgrades.
      4. Appliance Settings:
        • Required:
          • Machine type. (Standalone/Master/Data)
          • If you choose 'Data' as your machine type - specify the DNS/IP of the master appliance.
    9. Review the selected settings and click Finish and the virtual machine is ready for configuration, as described in the following section.

    Post Installation Configuration

    Once the virtual machine is installed it must be configured before starting it.

    The default disk capacity for IOP data volume is set to 150 GB.

    To increase disk capacity for standalone/data machines:

    1. Right-click on your virtual machine name from the list on the left.
    2. Choose the Edit Settings… option.
    3. Change the number for the Hard disk 2 option to the capacity you want.

    Finalizing the Virtual Based Appliance Installation

    Once all configurations have been set, you must launch the console and complete the installation to begin using it.

    To finalize the installation:

    1. Click on the green button to start the machine.
    2. To see the console logs, go to the Summary section in your virtual machine page, and click the Launch Web Console option under the image square.
    3. Choose the Web Console option and click OK. (The login to the virtual machine is “root”.)

    When the installation is complete, you can connect to your Insights by going to https://<Server_IP>.

    Once the installation is complete the IOP Forwarder must be installed to receive activity files.

    Insights On-premises Forwarder Installation

    The Insights On-premises (IOP) Forwarder is a component that forwards the activity files from monitor servers to the IOP servers and requires a separate installation. It forwards the data from the ControlUp monitor to the Insights server and must be installed either on a server with a shared activity folder that the monitors can access or on every monitor server. 

    During the ControlUp On-premises installation, you must choose a location for the Activity Files.
    If you choose a local folder, then you need to install the IOP Forwarder on each monitor. If you choose a shared location, you need to install only one IOP Forwarder.

    To install the IOP Forwarder:

    1. Login to your monitor windows machine.
    2. Contact support@controlup.com to receive the iop_forwarder_stable.msi
    3. Run the iop_forwarder_8.1.733.XX.msi file and click Next to begin the installation:
      f1.png
    4. Use the Folder dropdown menu to select where on the monitor machine the installer should be installed, and click Next to continue.
      f2.png
    5. Choose the type of installation (Standalone or Cluster) according to the type of Insights installation, and click Next to continue.
      f3.png
    6. Select the Activity Files path folder location and then enter the IP of your IOP Server machine, and click Next to continue.
      fw006.png
    7. Click Install and the forwarder is installed. A confirmation popup appears once the process is complete.
      f5.png
      fr05.png

     

  • Insights On-premises Linux-based Installation - Version 8.1 and Above

    The Insights On-premises (IOP) component captures, indexes, and correlates real-time data in a searchable repository from which you can view a variety of dashboards, graphs, reports, alerts, etc.

    Insights On-premises v8.2 contains significant improvements in performance and user experience.
    This version of Insights is available in 2 installation modes:

    • Virtual Appliance - This option comes as an OVA that runs Photon OS Linux distribution.
      Currently supported only on VMWare.
    • Linux OS Installation - This option allows you to install the IOP on various Linux distributions.

    To read more about IOP 8.2 Virtual Appliance Based Installation, see here.

    IOP 8.2 contains the IOP Forwarder. This component forwards the activity files from the monitor servers to the IOP servers.

    Insights On-premises Prerequisites

    You can install IOP 8.2 as a Single (Standalone) mode or as a Cluster mode for better performance in larger-scale environments.

    • Single (Standalone) - Recommended for companies with 5000 sessions or less, in which case only one Linux server or virtual appliance needs to be used. 
    • Cluster - Recommended for companies with 5000 sessions or more. In this variation several Linux servers must be prepared; one for the master role and one data role for every 5000 sessions. In cluster mode, you need to repeat the installation steps, once for the master server, and for each data server.

      Sizing Examples
      # of Sessions # of Master Roles # of Data Nodes
      6000 1 2
      9000 1 2
      11000 1 3

    Recommended Browser

    We recommend a Chromium based browser, such as Chrome or Microsoft Edge.

    Firewall / Port Settings

    The following ports need to be open:

    Machine Type Inbound Open Ports
    Standalone
    • 443
    • 8089
    • 9997
    Master
    • 443
    • 8089
    Data
    • 9887
    • 9997
    • 8089

    Note: For Linux-based installations these ports may need to be enabled at the OS level.

    More Information About Each Port

    Ports Traffic Source Usage

    9997/tcp

    • CU monitors
    • Forwarder(s) send data to the data node(s)

    443/tcp

    • IOP users
    • IOP U/I

    8089/tcp

    • Data notes
    • Master node
    • CU monitor
    • Management port -connects between the master node and the data node(s).

    9887/tcp

    • Data nodes
    • Data replication

    Recommended OS for Linux-Based Installation

    • Photon OS 3.0
    • CentOS 7 (or above)
    • ubuntu 16.4 (or above)
    • Red Hat Enterprise Linux 7.6
    • Additional operating systems are supported, subject to RPQ

    Required Packages for Linux-Based Installation

    • Python 3.6
    • Docker 18.09.8 (or above)

    Sizing Recommendations

    Mode  Cores RAM Storage

    Single (Standalone) installation 

    Under 5000 Sessions

    12 Cores
    (Minimum)

    32 GB 

    • SSD 100 GB (OS volume)
    • 500 GB* (data volume) with 800 IOPs 
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    • The data volume must be mounted under “/opt/ iop_volumes”.
    • The recommended file systems for the data volume are ext3, ext4 or xfs.
    • If ext3 or ext4 are chosen for the data volume, the “Reserved block percentage” should be set to 1%, using the following command (as root): tune2fs -m 1 <FILESYSTEM-PATH>. I.e: tune2fs -m 1 /dev/sdb1

    Clustered 

    installation 

    Over 5000

    Sessions

    Master
    Server

    12 Cores
    (Minimum)

    32 GB

    • SSD 100 GB (OS volume) with 800 IOPs
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    Data
    Servers
    (We recommend one data server for every 5000 sessions)

    8 Cores
    (Minimum)

    16 GB
    • SSD 100 GB (OS volume) and 1 TB* (data volume) with 800 IOPs
    • 50 GB to "/var" partition (if mounted on a different filesystem than the OS partition)
    • The data volume must be mounted under “/opt/ iop_volumes”
    • The recommended file systems for the data volume are ext3, ext4 or xfs
    • If ext3 or ext4 are chosen for the data volume, the “Reserved block percentage” should be set to 1%, using the following command (as root): tune2fs -m 1 <FILESYSTEM-PATH>. I.e: tune2fs -m 1 /dev/sdb1

    *The disk size may vary depending on the data retention period.

    Insights On-Premises Installation

    Checking the Prerequisites

    Before you start the IOP installation, check that the prerequisites are met.

    Check that the Python and the Docker are installed.

    Note: The Syntax can be different between the Linux OS versions.

    To check that the Python and the Docker are installed:

    1. Connect to your Linux CLI and enter 'python' and press Tab twice.
    2.  Run 'docker -v' in the CLI.
      • If the components are installed, the following message appears:
        Sen02.png
      • If the components are not installed:
        Sen01.png

    If you don't have the Docker installed, you can follow the instructions from one of the sites below:

    Once the Linux OS is ready, you can start the IOP installation.

    To start the IOP installation:

    Copy Files From Windows to Linux

    To install Insights on your Linux machine, the files must be prepared in advance. If you don’t have the installation files, contact support@controlup.com to receive them.

    1. Download the IOP package to your Windows machine.
      • iop_forwarder-8.1.733.XX.msi
      • iop_8.1_images_stable.tgz
      • iopcmd-8.1.733.XX.tgz
    2. Copy iop_8.1_images_stable.tgz and iopcmd-8.1.733.XX.tgz to your Linux machine. To copy files from Windows OS to Linux OS you can use the WinSCP tool.
      • Open the WinSCP tool and make a connection to your Linux.
        movefiles02.png
      • Copy the files to your Linux user home folder.
        movefiles01.png

        Screenshot_1.png

    Prepare the Files for the Installation

    1. Log in to your Linux machine.
    2. Move the iop_8.1_images_stable.tgz and iopcmd-8.1.733.<latest build number>.tgz file from the user folder to /opt folder.
      (For example, a typical file name would be: iopcmd-8.1.733.60.tgz if the latest build number published is built 60.) 
      • sudo mv iop_8.1_images_stable.tgz /opt/
      • sudo mv iopcmd-8.1.733.<latest build number>.tgz /opt/
    3. CD into “/opt/” directory and extract the installation file.
      • sudo tar zxvf iopcmd-8.1.733.<latest build number>.tgz
    4. Move the iop_8.1_images_stable.tgz to “/opt/iopcmd/iop_images.tgz” 
      • sudo mv /opt/iop_8.1_images_stable.tgz /opt/iopcmd/iop_images.tgz
    5. CD into "/opt/iopcmd/" directory.

    Installation Process

    Prior to installation there a few important things to note:

    1. Password:
      • It is recommended to create a strong" password.
      • The password is an Admin password for the IOP and will be used in the future for upgrades.
    2. Once the installation is complete, it is recommended to remove the iop_images.tgz from the /opt/iopcmd/ directory.
    3. Once the installation is complete, you can connect to your Insights by browsing to https://<Your Server_IP>.

    Single (Standalone) Installation

    • Run the Install command, and the installation begins
      • sudo ./iopcmd install local -t standalone -pwd <Your Password> -p iop_images.tgz
        • For example:
        • sudo ./iopcmd install local -t standalone -pwd abc123 -p iop_images.tgz

    Cluster Installation

    1.  Run the Install command on the Master server, and the installation begins.
      • sudo ./iopcmd install local -t master -pwd <Your Password> -p iop_images.tgz
        • For example:
        • sudo ./iopcmd install local -t standalone -pwd abc123 -p iop_images.tgz
    2. Once the installation is complete, run the Install command on the Data servers
      • sudo ./iopcmd install local -t data -m <DNS name or ip address of Master> -pwd <Your Password> -p iop_images.tgz

    Insights On-premises Forwarder Installation

    The Insights On-premises (IOP) Forwarder is a component that forwards the activity files from monitor servers to the IOP servers and requires a separate installation. It forwards the data from the ControlUp monitor to the Insights server and must be installed either on a server with a shared activity folder that the monitors can access or on every monitor server. 

    During the ControlUp On-premises installation you must choose a location for the Activity Files.
    If you choose a local folder, then you need to install the IOP Forwarder on each monitor. If you choose a shared location, you need to install only one IOP Forwarder.

    To install the IOP Forwarder:

    1. Login to your monitor Windows machine.
    2. Contact support@controlup.com to receive the iop_forwarder_stable.msi file.
    3. Run the file and the Welcome to the IOP Forwarder Setup Wizard screen appears. Click Next and the Select Installation Folder screen appears.
    4. f1.png
    5. Use the Folder dropdown menu to select where on the monitor machine the installer should be installed, and click Next to continue.
      f2.png
    6. Choose the type of installation (Standalone or Cluster) according to the type of Insights installation, and click Next to continue.
      f3.png
    7. Select the Activity Files path folder location and then enter the IP of your IOP Server machine, and click Next to continue.
      fw006.png
    8. Click Install and the forwarder is installed. A confirmation popup appears once the prcess is complete.
      f5.png
      fr05.png
  • ControlUp Data Collector

    The Data Collector is responsible for collecting metrics from external sources such as VMware vCenter, Citrix Delivery Controllers, XenServer Poolmasters, AHV Clusters, and NetScaler appliances. Data collectors increase the performance capabilities of both your console and monitor. 

    Benefits of having a data collector 

    In the image on the left side, you see 2 consoles and a monitor both connected straight to the vCenter without a data collector. Each of these components is initiating its own API query to vCenter to gather data.

    With this configuration, the API gets 3 API queries each interval. In very large environments, the traffic can be substantial. 

    In the image on the right side, a data collector is deployed. The only entity that does the API query is the data collector and it saves the data locally on the machine's memory buffer. The consoles & monitor, which are connected to the agent on the data collector (light connection), can read the data from the agent itself instead of performing their own API queries. 

    inline1865324782.png

    *Example shows 443 but can also be referred to 80\9440

    Data collector requirements 

    • A data collector is assigned 4 vCPUs and 8 GB of RAM. (View the Sizing Guidelines article for exact sizing information.)
    • The OS can be either a client or a server. 
    • The machine must have the ControlUp Agent installed on it. 
    • .Net Framework v4.5
    • Depending on the type of port connection, you should enable ports 80/443/9440.
    • A pair of data collectors can be provided for high availability purposes. 
    • In the event of a failure of the data collector, a backup data collector assumes this role until the data collector is brought back online.
    • SDKs from Citrix must be deployed to the Data Collector to connect to the XenDesktop Delivery Controllers (you can download it from the following article).

    Note: If you have more than 5 external sources to connect to a data collector, please contact us for sizing recommendations at support@controlup.com

    Data collector configuration

    The following steps are strongly recommended to ensure optimal performance of ControlUp connections to the console and the monitor. It is a best practice to designate one or more machines in your ControlUp organization to act as a dedicated data collector for hypervisors. The steps below should be performed either while you add your hypervisors / EUC environments or after you have already added them. The data collector must be connected to every hypervisor / EUC environment in your environment.

    To configure a dedicated data collector:

    1. Add a managed machine to the console which will function as the data collector and will
      later be defined as the active data collector. You must designate this machine as the data collector for every hypervisor and EUC environment connection. 
    2. - To add the data collector to a new hypervisor or EUC environment, click either Add Hypervisor or Add EUC Environment in the top ribbon. You must set up the connection to the hypervisor or EUC environment in the top area of the dialog and then follow the steps below. 
      - To add a data collector to an existing hypervisor or EUC environment, right-click it in the organization tree and select Connection Settings.
        CD_ConnectionSettings.png
      For hypervisors, the Connection Options section below the connection to the hypervisor is where you designate data collectors. For EUC Environments it is in the Data Collectors tab. CD_ConnectionArea.png
      Tip: If you don't see the Connection Options area, click the down arrow at the side.
    3. By default, the ControlUp Console/Monitor acts as a data collector so to designate a data collector you first have to remove this default. 
      Click Remove and then OK. The ControlUp Console/Monitor is removed as the default.
      CD_RemoveCU.png
    4. If you are in the connection options for a hypervisor, click +Add.
      If you are in the connection options for an EUC environment, click the Data Collectors tab and then click +Add.
    5. Select the managed machine you added to function as the designated data collector in step 1 above and click OK.
      Your data collector is now configured for this connection.
    6. Repeat for every hypervisor/EUC environment. 

    You can also set a monitor as a data collector by installing the agent on the monitor machine and following this procedure.

  • Proxy Information for ControlUp - Hybrid Cloud

    Customers of ControlUp that are using a proxy in their environment should have the ControlUp cloud configuration servers whitelisted and open going out via the proxy. 

    The following URL's/IP addresses should be available via https (443):

    • fe1.controlup.com - 52.31.169.19
    • fe2.controlup.com - 52.22.91.133
    • fe3.controlup.com - 52.31.158.49
    • fe4.controlup.com - 52.23.86.15
    • US Load Balancers:
      • rt-app.controlup.com - 34.195.43.52
      • rt-app.controlup.com - 54.86.39.124
    • EU Load Balancers
      • rt-app.controlup.com - 18.200.38.56
      • rt-app.controlup.com - 52.212.202.250
    • mp.controlup.com
    • s3.amazonaws.com
    • Insights-hec.controlup.com

    If you have any further questions regarding proxy, feel free to contact us at support@controlup.com

  • ControlUp Hybrid Cloud Implementation Requirements

    The ControlUp Hybrid Cloud implementation is composed of three main components:

    • Console - for real-time environmental monitoring and management.
    • Monitor - to monitor your environment 24/7, and uploading historical and analytical data to our Hybrid Cloud infrastructure.
    • Agents - to communicate with the Console and Monitor. 

    For information regarding communication ports for each of the components, see here

    ControlUp Console Requirements

    ControlUpConsole.exe is the main executable used for data display and task invocation. No setup is needed to start using ControlUp. Just download the executable and run it on your admin station or a management server.

    ControlUp console is compatible with:

    • Windows 7
    • Windows 8 and 8.1
    • Windows 10
    • Windows Server 2008, Windows Server 2008 R2
    • Windows Server 2012, Windows Server 2012 R2
    • Windows Server 2016.
    • Windows Server 2019. (must have .NET 3.5 installed)

    The Console is the primary user interface for monitoring and managing your resources.

    • The Console requires no database.
    • All the data you see in it is stored in RAM, which allows for extremely fast manipulation of data. As a result, ControlUp Console memory usage can be intensive, depending on the number of managed machines.
    • A RAM footprint of about 1GB (Working Set) is normal when managing an enterprise with up to 500 live user sessions, while thousands of sessions can bring the console’s RAM usage up to several gigabytes.

    In larger environments, we recommend using a high-performance server for running the console. There are also some performance optimizations you should consider in order to reduce the amount of resources used by ControlUp Console. Please refer to the Advanced Settings documentation page for more details.

    Prerequisites for ControlUp Console

    • Domain joined desktop, laptop, Windows VM, or can be published as a XenApp application. 
    • .Net 4.5 and above. 
    • Download the executable from our website. (No installation required, run the executable with ease!)
    • AD account with privileges on the machines you wish to Monitor/Manage
    • Credentials (a service account is best) and URL for your hypervisor (XenServer, VMware, Hyper-V)
    • AD account with help-desk or higher permissions in the 7.15 environment and the Broker IP or hostname
    • Firewall exceptions inside the company for RPC/WMI and ports 40705 and 40706 (or Windows firewalls off)
    • Internet connectivity from the Monitor and Console machines (it can be via proxy) 

    ControlUp Monitor Requirements

    The ControlUp Monitor is a component principally equivalent to ControlUp Console but without an interactive user interface. The primary difference between a Monitor and a Console is the fact that the Monitor runs as a Windows service, requiring no user interaction and allowing for continuous monitoring of your resources.

    Prerequisites for ControlUp Monitor

    • Windows Server 2008 R2 or above
    • .NET Framework 4.5 and above
    • RPC Access enabled at the installation phase

    Read more about the benefits of Control-Up Monitor and how to set it up here.

    ControlUp Agent

    The ControlUp Agent is a lightweight service that gets installed on the managed computers in your organization. Installing the Agent on your systems allows you to use ControlUp Real-Time Console to perform in-depth monitoring, advanced systems management, and in-depth configuration evaluation. 

    ControlUp agents have a minimal performance impact

    • CPU usage – consistently 0% to 1%
    • RAM consumption – 60 to 90 MB
    • I/O – zero disk activity
    • No software hooks, no drivers and no reboot needed

    Prerequisites for ControlUp agents

    • Windows OS - Windows 7 to Windows Server 2019. (Windows 2003 is not supported.)
    • .Net Framework 3.5 SP1 or 4.5 and above.
    • Single incoming TCP port (by default 40705) open for ongoing console/monitor communications
    • RPC and WMI access for initial deployment via the console. If access is not available, the agent can be installed manually using the MSI package.
  • Managed Computers Requirements

    ControlUp supports managing computers that run:

    • Windows 7
    • Windows 8 (or 8.1)
    • Windows 10
    • Windows Server 2008 (full installation only\core edition is not supported), Windows Server 2008 R2
    • Windows Server 2012
    • Windows Server 2016 (core or full installation)
    • Windows Server 2019 (full installation)

    Managed computers should the following prerequisites:

    • Net Framework 3.5 SP1 or .Net Framework 4.5 and above. 
    • A single inbound TCP port (40705 by default) for incoming console and monitor communications.
    • ControlUp requires RPC access for remote agent installation and a single configurable incoming TCP port open (40705 by default) for agent communication. In case your managed computers are inaccessible using RPC, you can deploy the ControlUp agent using an MSI package. For more details, see “Add Managed Computers”.

    For additional information about used ports in ControlUp, please refer to the below articles suited for your deployment - 

  • Active Directory & DNS Requirements

    Active Directory is a prerequisite for managing computers using ControlUp. If your network includes computers that are not joined to a domain, you will be able to connect to these computers using ControlUp’s Remote Desktop view while other actions will not be available.

    The computer on which ControlUp Console is executed does not have to be a domain member. However, you will be required to enter valid domain credentials in order to manage computers in your environment.

    Full DNS name resolution is also mandatory for management connections using ControlUp. You should be able to access all of your managed computers using their Fully Qualified Domain Names (FQDN).

    As an exception to the above, virtual machines (including non-Windows guests) can be monitored via the hypervisor layer without the need for DNS resolution or AD domain membership. This agentless approach only enables access to VM-related data known to the hypervisor, not guest OS data.
    (Read more…)

    By default, ControlUp queries Active Directory for the DNS suffix when managed computers are added to the organization tree. For networks in which the domain name is not identical to the default DNS suffix of all computers, ControlUp supports for providing a custom DNS suffix during computer addition.
    (More details…)

  • Security Rights & Permissions

    By default, local administrative privileges on all managed computers are required in order to connect to these computers using ControlUp. Every time you attempt to run a management action using ControlUp, your Windows credentials will be evaluated according to your current ControlUp mode:

    • Enterprise Mode – in this mode ControlUp operates by evaluating both your current Windows credentials and the Security Policy configured using your organization’s central configuration. In Enterprise Mode the permissions may be restricted to limit access to ControlUp features for designated administrators, regardless of their existing Windows rights.
    • Standalone Mode – your Windows user account will always need to have full administrative rights on all target computers. If your account is not a local administrator on the managed computer, ControlUp agent will refuse the connection and you will not be able to monitor performance or execute management actions on that computer.

    For more information on configuring ControlUp permissions, see the Secure Your Organization chapter.

    For agentless monitoring of virtual machines, access permissions for the hypervisor are required.
    For more details, see Hypervisor Monitoring Requirements.

  • Hypervisor Monitoring Requirements

    Supported Hypervisor Platforms

    ControlUp supports VMware v4.x/5.x/6.x environments that are managed by vCenter. Standalone ESX/ESXi servers are not supported. ControlUp also supports Citrix XenServer v6.1 (with the Performance Monitoring Enhancement Pack, CTX135033), v6.2 and v7.0. For earlier versions, some performance columns not yet implemented in XenServer might be displayed as N/A. 
    Microsoft Hyper-V 2012 R2, Microsoft Hyper-V 2016 including standalone and clustered hosts. Please note that ControlUp Agent needs to be installed on the Hyper-V hosts to enable monitoring them as hypervisors (The console does not work on any version of Core, but the agent is fine as long as you have .Net 3.5.1 or .Net 4.6.2.).
    ControlUp Console supports two hypervisors platforms running on Nutanix (AOS), VMware vSphere and Nutanix Acropolis Hypervisor (AHV). You can now also manage your Nutanix AHV clusters - live, with real-time metrics in the familiar ControlUp way(https://support.controlup.com/hc/en-us/articles/360001166145-Connecting-to-your-Nutanix-AHV-hypervisor).

    Network Connectivity

    ControlUp data collection agents (ControlUp Console by default, or agents if explicitly designated) require https (tcp/443) access to the vCenter server or the XenServer pool master.

    Hypervisor Permissions

    VMware

    Required vCenter permissions: the Read-Only role is sufficient for all monitoring purposes. If you want to be able to use the built-in hypervisor-based VM power management functions, then you will need to create a custom role based on the Read-Only role, adding the following permissions:

    • In the Virtual Machine/Interaction category:
      • Power Off
      • Power On
      • Reset

    vSAN Prerequisites
    In order to retrieve vSAN metrics and metadata, please follow these requirements 

    System Requirements for the ControlUp Data Collector:
    PowerShell minimum Version 5.0 (with RemoteSigned execution policy)

    • VMware PowerCLI minimum Version 10.1.1.x  (if needed, Ignore Invalid SSL Certificates)
    • .NET framework version 4.5

    Example:  Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope AllUsers

    vSAN Requirements:

    • vSAN Performance service should be turned on
    • The user account configured for the hypervisor connection requires the "storage.View"

    XenServer

    If Active Directory authentication is enabled for the XenServer pool, then the Read-Only role is sufficient. If you want to be able to use the built-in hypervisor-based VM power management functions, then you will need to upgrade the user role to ‘VM Operators’.

    Nutanix

    ControlUp requires for the user\service account to have 'Viewer' only role for view-only capabilities (the user that you connect your Console to the hypervisor with). If you want to perform VM power management & host maintenance actions, you'll need to grant the user\service account with the 'Cluster Admin' role.
    In order to use a dedicated user\service account that you already have configured in your environment - you'll need to add your organizational Active Directory to Nutanix by going into Prism, Click the Gear Icon> 'Authentication'. When you're finished with adding your AD - you can 'Test' the connection in ControlUp console and verify that it works. 
    If you don't want to connect your AD to your Nutanix cluster, you can create a local user in the Nutanix local management within Nutanix Prism. Click the Gear Icons > 'Local User Management' and add the user with the proper role required.

     

  • Licensing

    Whenever you launch ControlUp, a license test is performed in order to determine the maximum number of concurrent user sessions that your current license permits you to manage using ControlUp.

    Your active license is determined by the ControlUp online servers during the login process. If you are using the offline option, your Offline License file needs to be available on your computer every time you launch ControlUp.

    In order to display your active license, click the “About” button on the Help ribbon and then click the “Licensing” button. This window will also pop up automatically any time your current license limit is exceeded.

    For more information on ControlUp licenses and pricing, please refer to our Pricing page.

  • vSAN Prerequisites

    ControlUp enhances your monitoring and troubleshooting toolset by introducing monitoring of vSAN-based datastores. In VMware vSphere environments, vSANs are becoming more and more popular. ControlUp leverages vSAN API to gather vSAN metadata and metrics, enabling for fine-grained visibility into the configuration and activity of your vSAN infrastructure.

    For vSphere hypervisor connections that contain a vSAN configuration, ControlUp will seamlessly detect vSAN objects and display related metrics in Datastores, Datastores on Hosts and Folders views. Using ControlUp to monitor vSAN, you will be able to troubleshoot all the way from datastore level, through virtual disks and into the guest VM activity to pinpoint the workloads (users or applications) involved.

    So how do I get started with vSAN?

    vSAN information will be displayed automatically if you already have a vSphere connection, along with the prerequisites listed below:

    System requirements for the Data Collector*:

    • PowerShell minimum Version 5.0 (with RemoteSigned execution policy)
    • VMware PowerCLI 10.1.1.x
    • .NET framework version 4.5

    vSAN Requirements:

    • vSAN Performance service should be turned on.
    • The user account configured for the hypervisor connection requires the "storage.View" permission.
    • Special Characters not supported for the account password (characters like $ and @).

    Note: By default data collection is performed by the console. If you have installed monitors or data collectors in a different location (recommended for large environments), these prerequisites should apply to them as well.