Skip to main content
Migration Notice
We're migrating documentation from the old portal into this one. Some things may look a little different or out of place in the meantime — we know, and we're working to get it right. If something's unclear or doesn't look right, let us know.
Version: 2.15.0

Integration Guide for Data Orchestration for Dell

Introduction

This guide covers the integrations documented for Data Orchestration for Dell (Superna Golden Copy): notification channels, integration with other Superna products, and a sample pattern for pushing job history data into external systems for centralized logging and automation.

Email Notifications

Data Orchestration can email job progress summaries on a schedule (24 hours by default, configurable). This allows administrators to monitor copy jobs without logging in to the appliance, and progress emails can be attached to support cases.

Configure a notification group and enable it on a cluster's folders:

searchctl archivedfolders notifications addgroup --isilon <host> --group <notification-group-name>
searchctl archivedfolders notifications modify --isilon <cluster name> --enabled true
searchctl archivedfolders notifications list

See Auto Progress Emails in the Configuration Guide for the full command set, including how to change the reporting interval.

Smart AirGap / Ransomware Defender Integration

Data Orchestration can integrate with Ransomware Defender to enforce a Smart AirGap-style block on copy jobs. When enabled, full or incremental archive jobs are blocked if an active alarm is raised in Ransomware Defender or triggered by Easy Auditor's Active Auditor.

On node 1, generate an API token in the Eyeglass GUI (Eyeglass main action menu → Eyeglass REST API → API Tokens → Create New Token), then edit /opt/superna/eca/eca-env-common.conf. See the Data Security API Guide for background on the Zero Trust API, token authentication, and licensing requirements this integration relies on.

export EYEGLASS_LOCATION=x.x.x.x
export EYEGLASS_API_TOKEN=<token>
export ARCHIVE_RSW_CHECK_THRESHOLD=WARNING
export ARCHIVE_RSW_CHECK_INTERVAL_MINS=1
export ARCHIVE_RSW_CHECK_ENABLED=TRUE
  • ARCHIVE_RSW_CHECK_THRESHOLD — one of WARNING, MAJOR, or CRITICAL. Setting this to WARNING blocks jobs on any severity; MAJOR ignores warnings; CRITICAL ignores both warnings and major alerts.
  • ARCHIVE_RSW_CHECK_INTERVAL_MINS — how often the appliance checks for active alarms (1 minute is the documented recommendation).
  • ARCHIVE_RSW_CHECK_ENABLED — must be TRUE to activate the integration.

Save the file and restart the cluster for the change to take effect:

ecactl cluster down
ecactl cluster up

Automating with the Golden Copy API

Data Orchestration exposes a GraphQL API that can be used to automate copy jobs and monitor job status, allowing integration with external workflow or orchestration tools that need to trigger data movement between the file system and cloud object storage. See the API Guide for authentication, available operations, and examples.

Kafka-Based Job History Integration

For customers who need to push Data Orchestration job history into an external system (for example, for centralized security auditing), Superna documents a Kafka-based integration pattern. The appliance publishes job history to a Kafka topic (jobshistory) on port 9022, which an external host can subscribe to and forward to a destination of your choice.

caution

This integration pattern is provided as sample code only, with no coverage under a support contract and no express or implied warranty. It has only been tested against AWS S3 as the destination. Do not run automation scripts directly on the Data Orchestration appliance nodes — use a separate host.

Setup

  1. On a host separate from the Data Orchestration appliance, install Python.

  2. Allow the automation host to reach the appliance's Kafka service by updating the appliance firewall. On node 1, as ecaadmin:

    nano /opt/superna/eca/scripts/eca_iptables.sh

    Under rule #5, add a line permitting the automation host's IP address on port 9022:

    sudo /usr/sbin/iptables -A $CHAIN -p tcp --dport 9022 -s x.x.x.x -j ACCEPT

    Save and exit.

  3. Schedule the integration script to run on your own cron interval (scheduling the script itself is outside the scope of this documentation).

Sample Pattern

The documented sample subscribes to the jobshistory Kafka topic and writes each new record to an S3 bucket as a JSON object, using the record's timestamp in the object key. Key points to adapt before use:

  • Point the Kafka bootstrap server at your Data Orchestration node 1 DNS name (for example, kafka.node1.<yourdomain>.eca.local:9092).
  • The consumer group name (for example, automation-cg) is an arbitrary label used to identify the automation host's registration in the Kafka GUI.
  • The topic name jobshistory does not need to change — it is the topic that carries job history data.
  • Store cloud credentials using your cloud provider's standard credential mechanism (for example, AWS boto credential files) rather than embedding them directly in the script, as shown in Superna's sample.
  • Update the destination bucket name to match your environment.

Storage Target Integrations

Data Orchestration integrates with the following storage providers as copy/recall targets (not third-party software integrations in the SIEM/monitoring sense, but documented storage backend integrations): Dell ECS, Amazon AWS S3, Microsoft Azure Blob Storage, Google Cloud Storage, Cohesity, Pure Storage FlashBlade, MinIO, Wasabi, and Ceph. See the Configuration Guide for target-specific configuration examples.

note

No dedicated named SIEM product integrations (for example, Splunk or QRadar) are documented for Data Orchestration. Alarm and event forwarding to external monitoring is available through the shared Eyeglass platform's email, syslog, and SNMP notification channels rather than a product-specific SIEM connector.

See Also

  • API Guide – GraphQL API reference for automation.
  • Configuration Guide – Notification setup, storage target configuration, and Cloud Browser for Data Mobility.