Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions packages/efficient_ip/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Elastic License 2.0

URL: https://www.elastic.co/licensing/elastic-license

## Acceptance

By using the software, you agree to all of the terms and conditions below.

## Copyright License

The licensor grants you a non-exclusive, royalty-free, worldwide,
non-sublicensable, non-transferable license to use, copy, distribute, make
available, and prepare derivative works of the software, in each case subject to
the limitations and conditions below.

## Limitations

You may not provide the software to third parties as a hosted or managed
service, where the service provides users with access to any substantial set of
the features or functionality of the software.

You may not move, change, disable, or circumvent the license key functionality
in the software, and you may not remove or obscure any functionality in the
software that is protected by the license key.

You may not alter, remove, or obscure any licensing, copyright, or other notices
of the licensor in the software. Any use of the licensor’s trademarks is subject
to applicable law.

## Patents

The licensor grants you a license, under any patent claims the licensor can
license, or becomes able to license, to make, have made, use, sell, offer for
sale, import and have imported the software, in each case subject to the
limitations and conditions in this license. This license does not cover any
patent claims that you cause to be infringed by modifications or additions to
the software. If you or your company make any written claim that the software
infringes or contributes to infringement of any patent, your patent license for
the software granted under these terms ends immediately. If your company makes
such a claim, your patent license ends immediately for work on behalf of your
company.

## Notices

You must ensure that anyone who gets a copy of any part of the software from you
also gets a copy of these terms.

If you modify the software, you must include in any modified copies of the
software prominent notices stating that you have modified the software.

## No Other Rights

These terms do not imply any licenses other than those expressly granted in
these terms.

## Termination

If you use the software in violation of these terms, such use is not licensed,
and your licenses will automatically terminate. If the licensor provides you
with a notice of your violation, and you cease all violation of this license no
later than 30 days after you receive that notice, your licenses will be
reinstated retroactively. However, if you violate these terms after such
reinstatement, any additional violation of these terms will cause your licenses
to terminate automatically and permanently.

## No Liability

*As far as the law allows, the software comes as is, without any warranty or
condition, and the licensor will not be liable to you for any damages arising
out of these terms or the use or nature of the software, under any kind of
legal claim.*

## Definitions

The **licensor** is the entity offering these terms, and the **software** is the
software the licensor makes available under these terms, including any portion
of it.

**you** refers to the individual or entity agreeing to these terms.

**your company** is any legal entity, sole proprietorship, or other kind of
organization that you work for, plus all organizations that have control over,
are under the control of, or are under common control with that
organization. **control** means ownership of substantially all the assets of an
entity, or the power to direct its management and policies by vote, contract, or
otherwise. Control can be direct or indirect.

**your licenses** are all the licenses granted to you for the software under
these terms.

**use** means anything you do with the software requiring one of your licenses.

**trademark** means trademarks, service marks, and similar rights.
64 changes: 64 additions & 0 deletions packages/efficient_ip/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{{- generatedHeader }}
{{/*
This template can be used as a starting point for writing documentation for your new integration. For each section, fill in the details
described in the comments.

Find more detailed documentation guidelines in https://www.elastic.co/docs/extend/integrations/documentation-guidelines
*/}}
# EfficientIP Integration for Elastic

The EfficientIP integration collects and parses data from [EfficientIP](https://efficientip.com/) DDI (DNS, DHCP, and IPAM) solutions, enabling centralized monitoring and analysis of network infrastructure events within Elastic.

## Overview
{{/* Complete this section with a short summary of what data this integration collects and what use cases it enables */}}
The EfficientIP integration for Elastic enables collection of event logs from DNS, DHCP and IPAM. This integration enables the
following use cases:
- DNS query monitoring and threat detection
- DHCP lease management and IP address tracking
- IPAM auditing and infrastructure compliance
- Network anomaly identification and security investigations

### Compatibility
{{/* Complete this section with information on what 3rd party software or hardware versions this integration is compatible with */}}
This integration is tested with EfficientIP version 8.4.7e

## What data does this integration collect?
{{/* Complete this section with information on what types of data the integration collects, and link to reference documentation if available */}}
This integration collects the following data types from EfficientIP DDI solutions:

- **DNS Events**: Query logs, response codes, and DNS transactions
- **DHCP Events**: Lease assignments, renewals, releases, and IP address allocations
- **IPAM Events**: Address space changes, subnet modifications, and infrastructure audits

All events are forwarded via syslog and processed through Elastic ingest pipelines for analysis and visualization within the Elastic Stack.


## What do I need to use this integration?
{{/* List any vendor-specific prerequisites needed before starting to install the integration. */}}
Minimum requierment Elastic stack 9.0.x and EfficientIP version 8.4.7e


## Deployment methods
This integration supports the following deployment methods:

**Syslog-based**: EfficientIP nodes forward events to a syslog destination where Elastic Agent collects and processes the data.

To configure syslog forwarding on an EfficientIP node:

1. Access the EfficientIP administration interface
2. Navigate to **System Settings** > **Logging** or **Event Forwarding**
3. Select **Syslog** as the destination type
4. Enter the syslog receiver host IP address and port
6. Verify the connection and enable syslog forwarding
7. Configure Elastic Agent to listen on the syslog port and ingest the forwarded events

Refer to the EfficientIP documentation for your version for detailed configuration steps specific to your deployment.

### Agent-based deployment
Elastic Agent must be installed. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.

Elastic Agent is required to stream data from the syslog or log file receiver and ship the data to Elastic, where the events will then be processed via the integration's ingest pipelines.

### Inputs used
{{/* All inputs used by this package will be automatically listed here. */}}
{{ inputDocs }}
Loading