# Collect HPE Nimble Storage OS logs

Supported in:

This document explains how to ingest HPE Nimble Storage OS logs to Google Security Operations using Bindplane.

HPE Nimble Storage OS is a storage array operating system that generates system, hardware, and replication logs. The platform monitors storage operations and provides detailed event logging for capacity management, array health, and data protection activities. HPE Nimble Storage arrays support native syslog forwarding of system events to external collectors.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance
- Windows Server 2016 or later, or Linux host with `systemd`
- Network connectivity between the Bindplane agent and HPE Nimble Storage array
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the HPE Nimble Storage array with administrator permissions

## 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/nimble_os:
          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: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: '<customer_id>'
          endpoint: chronicle.googleapis.com
          log_type: NIMBLE_OS
          raw_log_field: body
          ingestion_labels:
            env: production

      service:
        pipelines:
          logs/nimble_to_chronicle:
            receivers:
              - udplog
            exporters:
              - chronicle/nimble_os

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - `udplog`: The receiver type based on protocol:
    - `udplog` for UDP syslog
    - `tcplog` for TCP syslog
  - `0.0.0.0`: IP address to listen on:
    - `0.0.0.0` to listen on all interfaces (recommended)
    - Specific IP address to listen on one interface
  - `514`: Port number to listen on (for example, `514`, `1514`, `6514`)
- **Exporter configuration:**

  - `nimble_os`: Descriptive name for the exporter
  - `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`.
  - `NIMBLE_OS`: Log type exactly as it appears in Chronicle
  - `ingestion_labels`: Optional labels in YAML format (for example, `env: production`)
- **Pipeline configuration:**

  - `nimble_to_chronicle`: Descriptive name for the pipeline

### 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/nimble_os:
          compression: gzip
          creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: '<customer_id>'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: NIMBLE_OS
          raw_log_field: body
          ingestion_labels:
            env: production

> [!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 HPE Nimble Storage OS syslog forwarding

HPE Nimble Storage arrays support forwarding system, hardware, and replication event logs to an external syslog server. You can configure syslog forwarding using the CLI or the management GUI.

### Configure syslog using the CLI

1. Connect to the HPE Nimble Storage array via SSH with administrator credentials:

       ssh admin@<nimble_array_ip>

2. Enable syslog and specify the Bindplane agent as the syslog server:

       group --edit --syslog_server <bindplane_agent_ip>

3. (Optional) Specify a custom syslog port (default is `514`):

       group --edit --syslog_port <port_number>

4. Verify the syslog configuration:

       group --info | grep -i syslog

   The output should show `Syslogd enabled: Yes`, along with the configured server address and port.

   > [!NOTE]
   > **Note:** Ensure that firewall rules allow UDP traffic on the syslog port (typically `514`) from the Nimble array to the Bindplane agent host.

### Configure syslog using the management GUI

1. Sign in to the HPE Nimble Storage management interface.
2. Go to **Administration \> Syslog**.
3. Click **Enable Syslog Server**.
4. In the **Server** field, enter the IP address of the Bindplane agent host.
5. In the **Port** field, enter the port matching the Bindplane agent receiver configuration (default `514`).
6. Click **Save**.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
|   | extensions.auth.mechanism | Authentication mechanism |
|   | extensions.auth.type | Authentication type |
| data_message | metadata.description | Event description |
| type | metadata.event_type | Event type |
| type | metadata.product_event_type | Product event type |
| id | metadata.product_log_id | Product log ID |
| version | metadata.product_version | Product version |
| group | principal.group.group_display_name | Group display name |
| logsource | principal.hostname | Principal hostname |
| client_ip | principal.ip | Principal IP address |
| array | principal.resource.name | Resource name |
|   | principal.resource.resource_subtype | Resource subtype |
|   | principal.resource.resource_type | Resource type |
| status | security_result.action | Security action |
| error | security_result.description | Security result description |
|   | security_result.summary | Security result summary |
| filename,target | target.file.full_path | File full path |
| object_id | target.resource.id | Resource ID |
| object,target,filename,partner,volname | target.resource.name | Resource name |
|   | target.resource.resource_subtype | Resource subtype |
|   | target.resource.resource_type | Resource type |
|   | target.user.user_display_name | User display name |
| username | target.user.userid | User ID |
|   | metadata.product_name | Product name |
|   | metadata.vendor_name | Vendor name |

## Change Log

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

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