Monitoring Illumio Devices

Overview

Add Illumio Policy Compute Edge (PCE) devices to TOS using the Open Policy Model (OPM). OPM expands device coverage in TOS to additional vendors. Device connectors collect the device's configuration and policy data and import them into SecureTrack.

The Illumio device connector supports onboarding Illumio PCE using HTTPS API. SecureTrack pulls topology and rule data from the Orchestrator based on the sync schedule set in Tufin Integrations.

For supported features, see Features by Vendor in SecureTrack and Features by Vendor in SecureChange.

Prerequisites

  • TOS 5.1.00 and later
  • PCE: HTTPS API access

  • Customer Portal access to download the OPM package

  • Admin credentials for SecureTrack and SecureChange to be defined through Tufin Integrations before configuring device sync

  • TOS server:

    • sudo permissions to run the installer

    • File upload permissions to /opt/misc

  • On systems with non-Tufin OS, python3 and bzip2 packages installed

Install the OPM package

Install the OPM package from the shell on the TOS server. The steps are identical for both new installations and upgrades.

If you have existing OPM packages, the OPM installer automatically detects and upgrades older versions.
  1. Go to the Download center.

  2. Select Illumio.

  3. Click Download to Computer.

  4. Upload the downloaded file to /opt/misc (recommended) on the TOS server:

    sh <package-name>

    where:

    <package-name> is the name of the package you downloaded in the format install-<vendor>-1.0.0.aur.run

  5. Wait for the installation to complete. The installer installs PS Proxy and Tufin Integrations if they don't exist. If an older version is installed, the script upgrades it.

SecureTrack or SecureChange credentials are not required for and during installation.

After the installation, before you sync devices, make sure you define the credentials through Tufin Integrations.

Device properties

The following properties are used for Illumio PCE devices:

Device Property Description

API Key Secret

The API key secret used to authenticate with the Illumio PCE.

For details, see Authentication and API user permissions for PCE.

API Key User

API key used to authenticate with the PCE.

For details, see Authentication and API user permissions for PCE.

FQDN

The FQDN or hostname for SaaS-based management platforms, instead of an IP address. Otherwise, leave this field empty and enter the IP address in the IP field in General settings.

Organization

The ID of the Illumio PCE organization where the assets are located that the configured API account can access.

Port

Optional.

For Illumio PCE, specify 8443. Otherwise, TCP/443 is used by default.

Add a Device

Add an Illumio PCE device to SecureTrack.

The API key must have Read-Only permission.
  1. In SecureTrack, go to Monitoring > Devices > Device Viewer.

  2. Click Add Device, then select Add OPM Device.

  3. In the ADD OPM DEVICE window, define the device details:

    • Vendor: Illumio
    • OPM agent: Select the registered agent for Illumio
    • Type: PCE
    • Display name: Name to display in SecureTrack
    • IP: The IP address of the device. For SaaS-based management platforms that use an FQDN or hostname instead of an IP address, leave this field empty, and enter the FQDN or hostname in the FQDN field in Device property settings.
  1. Click Next.
  2. Define the device properties.
  3. Click Save to confirm settings and add the device.

Sync Device with SecureTrack

Use Tufin Integrations to configure how SecureTrack syncs with your OPM-managed device. Tufin Integrations is the web interface for managing OPM devices. It is automatically installed when installing the OPM package if it does not exist.

  • Configuring SecureTrack to sync with your OPM-managed device includes:

  • Defining user credential for SecureTrack and SecureChange

  • Importing devices and assigning them to a cluster

  • Scheduling sync and reviewing run details

When configuration is complete, SecureTrack runs a script that connects to the device, retrieves configuration data (such as interfaces, routes, and rules), and imports the data. This process enables scheduled or manual data collection.

Step 1: Go to Tufin Integrations

  • Do one of the following:

    • Go to https://<tos-vip>/apps/integrations.

    • In SecureTrack , from the list of Tufin Extensions , select Tufin Integrations.

Step 2: Set user credentials for Tufin API

For API configuration, define the username and password to connect to SecureTrack and SecureChange. If the credentials are not defined, Tufin Integrations cannot retrieve the devices.

  1. From the sidebar, select Settings > Tufin API Configuration.

    OR

    Go to https://<tos-vip>/apps/integrations/configuration/tufin-api.

  2. Define the username and password credentials for SecureTrack and SecureChange.

  3. Click Save.

    Credentials are automatically validated.

  4. Verify that Credentials Valid appears next to SecureTrack and SecureChange, indicating that the credentials are correct.

  5. If Credentials Invalid appears, correct the credentials, save, and validate again.

Step 3: Select OPM vendor and import devices

Run discovery to import the devices for vendors.

  1. Return to the Dashboard.

  2. Below OPM Device Connectors, select the OPM client or vendor with the devices to monitor.

  3. Click IMPORT DEVICES and then click RUN DISCOVERY.

    The available devices are displayed.

  4. Select the parent management device, or select a specific device.

  5. Right-click and select Enable Devices.

  6. Click Save.

    The enabled devices are added to the vendor list.

Step 4: Activate device monitoring and configure monitoring options

Activate monitoring for devices, and assign them to the current cluster or to a different cluster. In multi-domain deployments, you can migrate devices to different SecureTrack domains.

You can assign devices to different TOS clusters for monitoring. For example, you can monitor one OPM device from the main cluster and another from a remote collector. Remote collectors are available only if they are configured in TOS.

Migrating the device to a new domain, automatically removes the device from reports, queries, audits and alerts configured in the previous domain.

  • Retains device permissions for administrators of the target domain, but removes device permissions from users.

For automated or manual sync to run, you must enable monitoring for the device.
  1. Select one or more devices.

  2. Right-click the device or devices and select Start to start monitoring them.

  3. Optional. To move the selected devices to a new domain, right-click and select Move Device to New Domain.

  4. Optional. To monitor the selected devices from a different cluster, right-click and select one of the following:

    • Migrate to main: Monitor the device from the primary cluster.

    • Migrate to <remote_collector>: Monitor the device from a remote collector, for example, RC4.  Available only if a remote collector is configured in TOS. The actual name of the remote collector differs by environment.

Step 5: Set automated sync schedule and view run details

Schedule automated syncs or trigger a manual sync on demand when monitoring is enabled for the device. View per-device status, start/end time, and message after each agent run.

  1. In the Configuration section, set the automated sync schedule:

    1. Set Interval as hourly, daily, weekly, or monthly.

    2. Choose the Time or Day of execution.

    3. To enable the script, select Enabled.

    4. Click Save.

  2. To start collecting revisions immediately, click RUN.

    If not triggered manually, the sync is triggered as scheduled.
    Every script execution retrieves the configuration from all devices assigned to the vendor’s OPM agent.

  3. Verify the results in the Run Details popup:

    In the Device Connector Runs (last 10) table, in the Run Details column, click the blue information icon information icon .

    The popup shows the status, start and end time, and a message for each device in the run.

Below is an example of the device connector page for Huawei, with the device list, Configuration panel, and Device Connector Runs.