# Collect Trellix IPS logs

Supported in:

This document explains how to ingest Trellix IPS logs to Google Security Operations using the Bindplane agent.

Trellix IPS (formerly McAfee IPS/Network Security Platform) is a network intrusion prevention system that provides real-time detection and prevention of network-based threats, including exploits, malware, and denial-of-service attacks. It uses signature-based and behavioral analysis to inspect network traffic inline, automatically blocking malicious activity while allowing legitimate traffic to pass through.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance
- A Windows 2016 or later or Linux host with `systemd`
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the Trellix IPS Manager (Network Security Manager) console

## Get Google SecOps credentials for the Bindplane agent

To authenticate the Bindplane agent to Google SecOps, choose one of the following methods:

- **New deployments**: Use the Chronicle API (Option 1).
- **Legacy deployments**: Continue using the ingestion authentication file (Option 2) until the Ingestion API is discontinued on July 20, 2027.

### Option 1: Create a service account for the Chronicle API (recommended)

1. Sign in to the [Google Cloud console](https://console.cloud.google.com/) and select the Google Cloud project that is linked to your Google SecOps instance.
2. Go to **IAM \& Admin \> Service Accounts**.
3. Click **Create service account**.
4. Provide the following configuration details:
   - **Service account name** : Enter a name for the account (for example, `bindplane-ingest`).
   - **Service account description** : Enter a description (for example, `Bindplane agent log ingestion`).
5. Click **Create and continue**.
6. In the **Grant this service account access to project** section, click **Select a role** and select **Chronicle Editor**.
7. Click **Continue** , and then click **Done**.
8. Click the service account you created, and then go to the **Keys** tab.
9. Click **Add key \> Create new key**.
10. Select **JSON** and click **Create**. The key file is downloaded to your computer.
11. Save the key file as `ingestion-auth.json` in the Bindplane collector directory (`/opt/observiq-otel-collector/ingestion-auth.json` on Linux or `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json` on Windows), or update `creds_file_path` in `config.yaml` to match the path where you save it.
12. Go to **IAM \& Admin \> Settings** and copy the **Project number**. You'll need it for the exporter configuration.

> [!NOTE]
> **Note:** The JSON key is a credential. Restrict access to the file on the Bindplane host and rotate the key according to your organization's policy.

### Option 2: Download the ingestion authentication file (legacy)

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Data Management \> Collection Agents** . If you are on a SIEM-only platform, go to **Settings \> Collection Agents**.
3. Download the **ingestion authentication file**.
4. Save the file securely on the system where the Bindplane agent will be installed.

> [!NOTE]
> **Note:** This file authenticates the agent to the legacy Ingestion API (`malachiteingestion-pa.googleapis.com`), which Google has scheduled for end of life on July 20, 2027. Plan to move to Option 1 before that date.

## Get Google SecOps customer ID

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Administration \> Profile** . If you are on a SIEM-only platform, go to **Settings \> Profile**.
3. Copy and save the **Customer ID** from the **Organization Details** section.

## Install the Bindplane agent

Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.

### Windows Installation

1. Open the **Command Prompt** or **PowerShell** as an administrator.
2. Run the following command:

       msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

### Linux Installation

1. Open a terminal with root or sudo privileges.
2. Run the following command:

       sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

### Additional Installation Resources

For additional installation options, consult this [installation guide](https://docs.cloud.google.com/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).

> [!NOTE]
> **Note:** The Chronicle API exporter configuration requires Bindplane collector v1.106.0 or later. The previous commands install the latest release. If you're updating an existing installation, upgrade the collector before changing the configuration.

## Configure the Bindplane agent to ingest Syslog and send to Google SecOps

1. Access the Configuration File:

   - Locate the `config.yaml` file. Typically, it's in the `/opt/observiq-otel-collector/` directory on Linux or in the installation directory on Windows.
   - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).
2. Edit the `config.yaml` file as follows:

       receivers:
         tcplog:
           # Replace the port and IP address as required
           listen_address: "0.0.0.0:514"

       exporters:
         chronicle/chronicle_w_labels:
           protocol: https
           # Region of your instance, for example us, europe, asia-southeast1
           location: <LOCATION>
           # Project number of the Google Cloud project linked to the instance
           project: '<PROJECT_NUMBER>'
           compression: gzip
           # Adjust the path to the credentials file you downloaded in Step 1
           creds_file_path: '/path/to/ingestion-authentication-file.json'
           # Replace with your actual customer ID from Step 2
           customer_id: YOUR_CUSTOMER_ID_HERE
           endpoint: chronicle.googleapis.com
           # Add optional ingestion labels for better organization
           log_type: 'MCAFEE_IPS'
           raw_log_field: body
           ingestion_labels:

       service:
         pipelines:
           logs/source0__chronicle_w_labels-0:
             receivers:
               - tcplog
             exporters:
               - chronicle/chronicle_w_labels

   - Replace the port and IP address as required in your infrastructure.
   - Replace `YOUR_CUSTOMER_ID_HERE` with the actual Customer ID.
   - Update `/path/to/ingestion-authentication-file.json` to the file path where the service account key file (Option 1) was saved in Step 1.
   - Replace `<LOCATION>` with the region of your Google SecOps instance (for example, `us`, `europe`, or `asia-southeast1`). The exporter prefixes `chronicle.googleapis.com` with this value. See [Regional Endpoints](https://docs.cloud.google.com/chronicle/docs/reference/rest?rep_location=us#regional-service-endpoint) for the complete list.
   - Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.

### Legacy ingestion API exporter

- If you use the ingestion authentication file from Option 2, replace the `exporters` block with the following. Set `creds_file_path` to the path to the ingestion authentication file, and if your instance is outside the US, replace `malachiteingestion-pa.googleapis.com` with your [regional endpoint](https://docs.cloud.google.com/chronicle/docs/reference/ingestion-api#regional-endpoints) (for example, `europe-malachiteingestion-pa.googleapis.com`).

      exporters:
        chronicle/chronicle_w_labels:
          compression: gzip
          # Adjust the path to the credentials file you downloaded in Step 1
          creds_file_path: '/path/to/ingestion-authentication-file.json'
          # Replace with your actual customer ID from Step 2
          customer_id: YOUR_CUSTOMER_ID_HERE
          endpoint: malachiteingestion-pa.googleapis.com
          # Add optional ingestion labels for better organization
          log_type: 'MCAFEE_IPS'
          raw_log_field: body
          ingestion_labels:

> [!NOTE]
> **Note:** This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

## Restart the Bindplane agent to apply the changes

1. To restart the Bindplane agent in **Linux**, run the following command:

       sudo systemctl restart observiq-otel-collector

2. To restart the Bindplane agent in **Windows** , you can either use the **Services** console or enter the following command:

       net stop observiq-otel-collector && net start observiq-otel-collector

## Configure Trellix IPS syslog forwarding

1. Sign in to the **Trellix Network Security Manager** (formerly McAfee Network Security Manager) console.
2. Go to **Manager \> Setup \> Notification \> Syslog**.
3. Click **Enable** to enable syslog notification.
4. Click **Add** to add a new syslog server.
5. Provide the following configuration details:
   - **Syslog Server IP Address** : Enter the IP address of the Bindplane agent host (for example, `192.168.1.100`).
   - **Port** : Enter `514` (or the port configured in Bindplane).
   - **Protocol** : Select **TCP**.
   - **Facility** : Select **Local0** (or as required by your environment).
6. In the **Notification** section, select the alert severity levels to forward:
   - **Informational**
   - **Low**
   - **Medium**
   - **High**
   - **Critical**
7. In the **Message Format** section, select the syslog message format:
   - Select **Standard Syslog** or **CEF** (Common Event Format) based on your requirements.
8. Click **Save** to save the syslog server configuration.
9. Go to **Manager \> Setup \> Notification \> Forward Alerts**.
10. Enable alert forwarding and select the syslog server configured in the previous steps.
11. Select the alert types to forward:
    - **IPS Alerts**
    - **Fault Alerts**
    - **Audit Alerts**
12. Click **Save** to apply the configuration.

    > [!NOTE]
    > **Note:** For more information, see the [Trellix Network Security Manager documentation](https://docs.trellix.com/bundle/network-security-platform-manager-administration-guide-11.1.x/page/GUID-F5994024-5A56-4AA2-A498-B498EA1D9B5C.html).

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `_intermediary` | `intermediary` | Merged |
| `_event_type` | `metadata.event_type` | Directly mapped |
| `_network` | `network` | Renamed/mapped |
| `_principal` | `principal` | Renamed/mapped |
| `_security_result` | `security_result` | Merged |
| `_target` | `target` | Renamed/mapped |
| N/A | `intermediary` | Constant: `_intermediary` |
| N/A | `metadata.product_name` | Constant: `MCafee IPS` |
| N/A | `metadata.vendor_name` | Constant: `MCafee` |
| N/A | `security_result` | Constant: `_security_result` |

**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/)