# Collect IBM AIX system logs

**Parser Version:** 15.0
Supported in:

This document explains how to ingest IBM AIX system logs to Google Security Operations using Bindplane.

IBM AIX is a Unix-based operating system designed for enterprise workloads on IBM Power Systems hardware. AIX system logs contain information about system events, authentication activity, kernel messages, daemon operations, and security-related events generated by the syslog daemon.

## Before you begin

Make sure you have the following prerequisites:

- Google SecOps instance.
- Windows Server 2016 or later, or Linux host with systemd to run the Bindplane agent.
- Network connectivity between the Bindplane agent host and the AIX system on UDP port 514.
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements.
- Root or privileged access to the AIX system.
- IBM AIX 7.1 or later operating system.

## 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.

   > [!NOTE]
   > **Note:** The customer ID is required for configuring the Bindplane agent exporter.

## Install the Bindplane agent

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

### Windows installation

1. Open **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

3. Wait for the installation to complete.

4. Verify the installation by running:

       sc query observiq-otel-collector

The service should show as **RUNNING**.

### 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

3. Wait for the installation to complete.

4. Verify the installation by running:

       sudo systemctl status observiq-otel-collector

The service should show as **active (running)**.

### Additional installation resources

For additional installation options and troubleshooting, see [Bindplane agent 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

### Locate the configuration file

- **Linux:**

      sudo nano /opt/observiq-otel-collector/config.yaml

- **Windows:**

      notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

### Edit the configuration file

- Replace the entire contents of `config.yaml` with the following configuration:

      receivers:
        udplog:
          listen_address: "0.0.0.0:514"

      exporters:
        chronicle/aix_system:
          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
          creds_file_path: '<CREDS_FILE_PATH>'
          customer_id: '<CUSTOMER_ID>'
          endpoint: chronicle.googleapis.com
          log_type: AIX_SYSTEM
          raw_log_field: body
          ingestion_labels:
            source: aix

      service:
        pipelines:
          logs/aix_to_chronicle:
            receivers:
              - udplog
            exporters:
              - chronicle/aix_system

### Configuration parameters

Replace the following placeholders:

**Exporter configuration:**

- `<CREDS_FILE_PATH>`: Full path to the service account JSON key file (Option 1):
  - **Linux** : `/opt/observiq-otel-collector/ingestion-auth.json`
  - **Windows** : `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json`
- `<CUSTOMER_ID>`: Customer ID from the previous step
- `location`: 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.
- `project`: Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.
- `endpoint`: Keep set to `chronicle.googleapis.com`.

### 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/aix_system:
          compression: gzip
          creds_file_path: '<CREDS_FILE_PATH>'
          customer_id: '<CUSTOMER_ID>'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: AIX_SYSTEM
          raw_log_field: body
          ingestion_labels:
            source: aix

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

### Save the configuration file

After editing, save the file:

- **Linux** : Press `Ctrl+O`, then `Enter`, then `Ctrl+X`
- **Windows** : Click **File \> Save**

## Restart the Bindplane agent to apply the changes

To restart the Bindplane agent in Linux:

1. Run the following command:

       sudo systemctl restart observiq-otel-collector

2. Verify the service is running:

       sudo systemctl status observiq-otel-collector

3. Check logs for errors:

       sudo journalctl -u observiq-otel-collector -f

To restart the Bindplane agent in Windows:

1. Choose one of the following options:

   - Command Prompt or PowerShell as administrator:

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

   - Services console:
     1. Press `Win+R`, type `services.msc`, and press Enter.
     2. Locate **observIQ OpenTelemetry Collector**.
     3. Right-click and select **Restart**.
2. Verify the service is running:

       sc query observiq-otel-collector

3. Check logs for errors:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

## Configure syslog forwarding on AIX

1. Sign in to the **AIX system** with root or privileged access.
2. Edit the `/etc/syslog.conf` file using a text editor (for example, `vi`):

       vi /etc/syslog.conf

3. Add the following line to forward logs to the Bindplane agent:

       *.info  @<BINDPLANE_AGENT_IP>

   - Replace `<BINDPLANE_AGENT_IP>` with the IP address of the Bindplane agent host.
   - The separator between the selector (`*.info`) and the action (`@<BINDPLANE_AGENT_IP>`) must be a **tab character**.
   - The selector `*.info` forwards all messages with `info` priority or higher from all facilities. Adjust the facility and priority as needed per your requirements.

   > [!NOTE]
   > **Note:** A single `@` prefix indicates UDP forwarding, which is the standard syslog transport on AIX.

4. Save the file and exit the editor.

5. Refresh the `syslogd` daemon to apply the changes:

       refresh -s syslogd

   > [!NOTE]
   > **Note:** If the `refresh` command does not apply the changes, restart the daemon using the SRC stop and start commands:

       stopsrc -s syslogd
       startsrc -s syslogd

6. Verify that the `syslogd` daemon is running:

       lssrc -s syslogd

   The output should show `syslogd` with a status of **active**.
7. Ensure that **UDP port 514** is open between the AIX host and the Bindplane agent.

### Verify log forwarding

Test that logs are being forwarded to the Bindplane agent:

1. On the AIX system, generate a test log message:

       logger -p user.info "Test syslog message from AIX"

2. On the Bindplane agent host, check the agent logs to verify the message was received:

   **Linux:**

       sudo journalctl -u observiq-otel-collector -n 50

   **Windows:**

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

3. Verify that logs appear in the Google SecOps console within 5-10 minutes.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `application` | `target.application` | Value extracted from the message field using grok patterns. |
| `cmddata` | `target.process.command_line` | Value extracted from the message field using grok patterns. |
| `command_line` | `principal.process.command_line` | Value extracted from the description field using grok patterns. |
| `description` | `metadata.description` | Value extracted from the message field using grok patterns. |
| `folder` | `target.process.file.full_path` | Value extracted from the message field using grok patterns. |
| `hostname` | `principal.hostname` | Value extracted from the message field using grok patterns. |
| `intermediary_hostip` | `intermediary.ip` | Value extracted from the message field using grok patterns. |
| `sc_summary` | `security_result.summary` | Value extracted from the description field using grok patterns. |
| `severity` | `security_result.severity` | Set to "INFORMATIONAL" if severity is "info" (case-insensitive). Set to "ERROR" if severity is "Err" (case-insensitive). |
| `src_ip` | `principal.ip` | Value extracted from the message or description field using grok patterns. |
| `src_port` | `principal.port` | Value extracted from the description field using grok patterns. |
| `sys_log_host` | `intermediary.hostname` | Value extracted from the message field using grok patterns. |
| `syslog_priority` | `security_result.priority_details` | Value extracted from the message field using grok patterns. |
| `ts` | `metadata.event_timestamp` | Converted from the ts field in the log message using grok and date filter. |
| `user` | `principal.user.userid` | Value extracted from the message or description field using grok patterns. |
| N/A | `metadata.event_type` | Set to "STATUS_UPDATE" if src_ip or hostname are present. Set to "USER_UNCATEGORIZED" if user is present but not the others. Otherwise set to "GENERIC_EVENT". |
| N/A | `metadata.vendor_name` | Set to "AIX_SYSTEM". |
| N/A | `metadata.product_name` | Set to "AIX_SYSTEM". |
| N/A | `metadata.log_type` | Set to "AIX_SYSTEM". |

## Change Log

[View the Change Log for this parser](https://docs.cloud.google.com/chronicle/docs/ingestion/parser-list/aix-system-changelog)

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