Installing the Collector on macOS

Contents

Installing the Collector on macOS

Overview

Nexthink distributes the Collector for macOS as a disk image (.dmg) file with the following contents:

  • A package (.pkg) file for installing the Collector from a graphical user interface.
  • The application csi.app for installing the Collector from the command line interface.
  • A reporter shell application that gathers system information in the case that you find any issue when running the Collector on macOS.
  • An uninstaller application to remove the Collector when it is no longer needed.

After the installation, as a sanity check, optionally verify the status of the TCP connection between the Collector and the Engine.

Starting from V6.17, the Mac Collector runs in user mode and it does not need to ask the user for explicit permissions to install any kernel extension. The fact of running in user mode comes with the added benefit of making unnecessary to reboot your macOS devices after updating or uninstalling the Collector. Rebooting the device is only required the first time that the Collector is installed on a macOS device.

Applies to platforms: PlatformMac.png

Prerequisites

You need:

  • One or more macOS devices where to install the Collector.
  • The Nexthink Collector disk image (Nexthink_Collector_<version>.dmg file).
  • The Customer Key and Root Certificate of the master Appliance. These are essential to enable the complementary TCP connection of the Collector with the Engine. Read this article if you need to install the Collector as part of a POC, before having installed the definitive master Appliance.
  • Optional: A third-party automated deployment tool.

Find the Nexthink Collector image file in the Product Downloads page of Nexthink:

  1. Open your favorite web browser.
  2. Navigate to the official Nexthink documentation web site: doc.nexthink.com.
  3. Click Product download in the top right corner of the main documentation page, above the search tool.
  4. In the Nexthink Help Center, click the Product Downloads section.
  5. Sign in with your customer credentials.
  6. Click the first entry of the Latest V6 releases list.
  7. Optional: Click the link to the release notes of the Mac Collector to learn about the new features and bug fixes.
  8. Under Download links, find the Collector section.
  9. Click to download the Collector package for Mac.
  10. Optional: Verify your download with the provided SHA-256 hash.
  11. Click the downloaded file Nexthink_Collector-<version>.dmg file.
  12. Find the package file (Nexthink_Collector-<version>.pkg) and the csi app inside the image file.

Download the Customer Key and default Root Certificate from the master Appliance:

  1. Log in to the Web Console of the master Appliance as admin.
  2. Select the Appliance tab at the top of the Web Console.
  3. Click Collector security in the left-hand side menu.
  4. Click the buttons DOWNLOAD CUSTOMER KEY and DOWNLOAD DEFAULT ROOT CERTIFICATE to download, respectively, the text files holding the Customer Key and the default Root Certificate of the master Appliance (the latter is required only if you did not replace the certificate for the TCP communication channel of the slave Appliances with the Collector).

You need to know:

  • The DNS name or IP address of the Engine (as specified as External DNS name of the Engine in the Web Console).
  • UDP port number where the Engine is listening for the Collector (default 999).
  • TCP port number of the non-traffic channel of the Engine (default 8443).

Graphical installation

To install the Collector on macOS using the graphical interface:

  1. Double-click the provided disk image file to mount it into your filesystem and see its contents.
  2. Double-click the package file Nexthink_Collector_<version>.pkg and the installer starts with the introduction.
  3. Click Continue to proceed with the installation.
  4. In the step Personalization, configure the settings of the Engine to which the Collector will send the gathered information:
    Install macOS.png
    • Nexthink Appliance name or IP address: Type in the host name or IP address of the appliance running the Engine, External DNS name.
    • Nexthink Engine UDP port: Type in the port number that listens to traffic data from the Collectors in the Engine.
    • Nexthink Engine TCP port: Type in the port number that listens to non-traffic data from the Collectors in the Engine.
    • Customer Key: Copy and paste the contents of the the file that holds the Customer Key of the master Appliance.
    • Root CA: Copy and paste the contents of the file that holds the default Root Certificate of the master Appliance. If you leave this field empty, the Collector assumes that you replaced the server certificates in the Engine and falls back to using the Keychain Access for verifying the certificates presented by the Engine (the slave) Appliance.
  5. Click Continue to go on.
  6. In the step Destination select, the installer program shows the local paths in the system where it is going to install the different components of the Collector. Keep the default paths and click Continue.
  7. The Installation Type step informs you about some details of the installation process, including the amount of space that the program is going to occupy on disk. Click Install to begin with the actual installation.
  8. The installer shows the progress of the installation and it finishes with a summary message. If the installation was successful, click Close to terminate the procedure.
  9. Only if you are installing the Collector for the first time, reboot the device to finish the installation.

Command line installation

The command line installation lets you install the Collector even when you have access to a computer only through the shell of macOS. Using the command line installation, you can thus install the Collector either locally or remotely through an ssh connection.

Execute the csi application provided with the disk image. To mount the disk image into the file system:

  1. After downloading the image file from Product Downloads, pick one of the following options:
    • If you are installing the Collector in a remote computer:
      1. Copy the image file to the remote coputer:
        scp Nexthink_Collector_<version>.dmg <username>@<address>:
      2. Log in to the remote computer:
        ssh <username>@<address>
    • If you are installing the Collector in the local computer:
      1. Change the directory to the one where you downloaded the image file.
  2. Mount the image file:
    hdiutil mount Nexthink_Collector_<version>.dmg

Once with the image file mounted into the filesystem of the target Mac computer, install the Collector from the command line:

  1. Change the directory to the path of the csi application:
    cd /Volumes/Nexthink_Collector_<version>/csi.app/Contents/MacOS
  2. Type in the following command and provide, as arguments, the DNS name or IP address of the Engine, the port where the Engine listens to traffic data from Collectors, the port where the Engine listens to non-traffic data from Collectors, the path to the Root Certificate and the path to the Customer Key file:
    sudo ./csi -address <engine_address> \
    -port <engine_udp_port> -tcp_port <engine_tcp_port> \
    -rootca <root_certificate_file> -key <customer_key_file>
  3. Reboot the device to finish the installation, as long as you are installing the Collector for the first time.
  4. Only if you are installing the Collector for the first time, reboot the device to finish the installation.

Enterprise deployment

The Collector supports its installation in an enterprise environment being based on either:

  • Imaging
  • Mobile Device Management (MDM)

Choose the method that better suits your needs depending on your deployment workflow.

Uninstalling the Collector

To uninstall the Collector, execute the uninstaller script that is provided with the image file. Assuming that you have mounted the image file into the filesystem of the computer where the Collector is installed:

  1. From the shell, type in the following command:
    sudo /Volumes/Nexthink_Collector_6.x.x/uninstaller
The operations described in this article should only be performed by a Nexthink Engineer or a Nexthink Certified Partner.

If you need help or assistance, please contact your Nexthink Certified Partner.