Apache Hop
Download
User manual 2.20.0 (pre-release)

Development Documentation

Edit this page

LDAP Output transform Icon LDAP Output

Description

The LDAP Output transform allows you to write information like users, roles and other data to an LDAP server.

The following sections describe the available options for the LDAP Output transform.

General Tab

Option Description

Transform name

Name of the transform; this name has to be unique in a single pipeline.

Host

Host can be the IP address of the LDAP directory server or its DNS name.

Port

Port number of LDAP directory server.

Referral

Determines how to handle referrals.

  • Ignore: Ignore referrals.

  • Follow: Automatically follow any referrals.

Derefalias

Determines how aliases are dereferenced.

  • Always: Always dereference aliases.

  • Never: Never dereference aliases.

  • Finding: Dereference aliases only during name resolution.

  • Searching: Dereference aliases only after name resolution.

Protocol

Determines which protocol is used.

  • LDAP

  • LDAP SSL

  • LDAP TLS

Use authentication

To enable LDAP authentication.

Username

The username to be passed during authentication.

Password

The password to be passed during authentication.

Use certificate

To enable the use of a certificate.

Trust store path

Trust store password

Trust all certificates

Test connection

Tests the configured connection to the LDAP server.

Settings

Option Description

Operation

Insert, Update, Upsert, Add attribute, Delete, Rename DN (distinguished name), Remove attribute.

Multi valued field seperator

Fail if not exist

Dn fieldname

Field which contains the distinguished name.

Old DN fieldname

Field which contains the old distinguished name (rename).

New DN fieldname

Field which contains the new distinguished name (rename).

Delete RDN

Whether or not to delete the RDN (relative distinguished name)

Operation Types

The LDAP Output transform supports the following operation types:

  • Insert: Creates a new LDAP entry with the specified DN and attributes.

  • Update: Updates existing attributes of an LDAP entry. The entry must exist.

  • Upsert: Inserts a new entry if it doesn’t exist, or updates it if it does exist.

  • Add attribute: Adds new attribute values to an existing LDAP entry without removing existing values.

  • Delete: Deletes an entire LDAP entry.

  • Rename DN: Renames an LDAP entry by changing its distinguished name.

  • Remove attribute: Removes attribute values from an LDAP entry. If a value is specified, only that specific value is removed. If no value is specified (empty), the entire attribute is removed from the entry.

Fields Tab

Option Description

Search base for fields

Where to start looking for fields

Attributes

Stream field

Update

Whether or not to update the fields (Y/N)

Get fields

Edit mapping