Confluence supplies an LDAP connectivity tool (also called 'Paddle') that will test the LDAP settings in your atlassian-user.xml file. This will help you to diagnose problems with LDAP user management, such as:

  • LDAP server not responding.
  • LDAP settings incorrectly configured in atlassian-user.
  • Other issues reported from the LDAP queries run by the testing tool.

LDAP is the protocol used for user management by Active Directory and other LDAP directories.

This document applies to Confluence 2.8 and later

From Confluence version 2.8, the LDAP User Test tool is integrated into the Administration Console. In previous versions of Confluence, this tool was available as a separate utility called 'Paddle'. If you are running an earlier version of Confluence, please refer to the Confluence 2.7 documentation or choose the relevant Confluence version from the list of previous versions on the documentation home page.

On this page:

Running the LDAP Connectivity Tool via the Administration Console

(warning) Note: You will need to restart your Confluence server each time you make changes to your atlassian-user.xml file. To avoid this, consider running the tool outside of Confluence.

To test your LDAP connection settings,

  1. First verify that your atlassian-user.xml contains at least one LDAP repository with a key of "ldapRepository".

  2. Go to the Confluence 'Administration Console'. To do this:

    • Open the 'Browse' menu and select 'Confluence Admin'. The 'Administration Console' view will open.
  3. Select 'LDAP Connectivity Test' in the 'Administration' section of the left-hand panel.
    (info) The 'LDAP Connectivity Test' will only appear if your atlassian-user.xml contains an ldap repository with a key of "ldapRepository", as described in the preceding step.

  4. The results of the test will appear in the main panel of the screen. Refer to the screenshot below for an example, and to the output samples lower down on this page.



Screenshot: External User Test



Running the LDAP Connectivity Test Tool outside Confluence

You do not need to have Confluence running to run this tool. Instead, you can download this jar and perform the following steps.

Steps in Detail

  1. Install the Java SDK from Sun. See Setting the JAVA_HOME Variable in Windows for tips on a Windows installation. On a Mac, Java comes pre-installed.
  2. Copy the Paddle jar file into a directory where you have permission to create files.
  3. Copy your atlassian-user.xml file into the same directory. You will find this file at the following location in your Confluence Installation directory: <Confluence-Installation>/confluence/WEB-INF/classes/atlassian-user.xml. If your instance is hosted, you can download one here to supply to our hosted team.
  4. Configure atlassian-user.xml according to Customising atlassian-user.xml.
  5. CD into this directory from a command prompt
    1. Mac users: Open Terminal from Applications >> Utilities >> Terminal. Use the 'cd' command to change to the proper directory.
    2. Windows users: Open a command prompt from Start >> Run >> cmd.
  6. Run java -jar paddle-6.jar.

The output will appear both in the command console window and in a paddle output log file that gets written to the local directory.

Parameters

Paddle supports the following parameters:

Name

Example

Purpose

debug

java -jar paddle-x.x.jar debug

Prints DEBUG messages to the console as well as paddle.log.

limit

java -jar paddle-x.x.jar limit=100

Sets the limit on the number of results returned by user and group queries. Defaults to 10.

Sample Output

Below are some examples of the output from the user test tool. The output is the same, whether you run the tool via the Administration Console or outside Confluence.

Output from a Successful Test

This is an example of a successful run:

###########################################################################################################################

LDAP Support Tool version 4.0

###########################################################################################################################

Connected to server successfully
-----------------------------------------------------------------
TEST 1: Search and list 10 users
-----------------------------------------------------------------

User: cn=foobar2092828899,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users236420517,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users1970486739,ou=groups,dc=example,dc=com

User: cn=foobar1810841610,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users646381955,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users841429091,ou=groups,dc=example,dc=com

User: cn=foobar1678090341,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users971262324,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users1400937719,ou=groups,dc=example,dc=com

User: cn=foobar625635825,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users1866930491,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users80556787,ou=groups,dc=example,dc=com

User: cn=foobar1740817394,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users1866930491,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users80556787,ou=groups,dc=example,dc=com

User: cn=foobar39774714,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users902164367,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users93075839,ou=groups,dc=example,dc=com

User: cn=foobar1748690196,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users1386043681,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users1418978137,ou=groups,dc=example,dc=com

User: cn=foobar1958046554,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users78102241,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users220323310,ou=groups,dc=example,dc=com

User: cn=foobar1263319669,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users283478949,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users1866930491,ou=groups,dc=example,dc=com

User: cn=foobar1541805698,ou=users,dc=example,dc=com
Member of:
	cn=ldap-confluence-users1736591783,ou=groups,dc=example,dc=com
	cn=ldap-confluence-users91103896,ou=groups,dc=example,dc=com

-----------------------------------------------------------------
TEST 2: Search and list 10 groups
-----------------------------------------------------------------

Group: cn=ldap-confluence-users16368779,ou=groups,dc=example,dc=com
Members:
	cn=foobar1588244344,ou=users,dc=example,dc=com
	cn=foobar997638232,ou=users,dc=example,dc=com
	cn=foobar1474202427,ou=users,dc=example,dc=com
	cn=foobar1371091481,ou=users,dc=example,dc=com
	cn=foobar794627990,ou=users,dc=example,dc=com
	cn=foobar904159761,ou=users,dc=example,dc=com
	cn=foobar1992607123,ou=users,dc=example,dc=com
	cn=foobar839977082,ou=users,dc=example,dc=com
	cn=foobar725629285,ou=users,dc=example,dc=com
	cn=foobar1317948366,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users1721354031,ou=groups,dc=example,dc=com
Members:
	cn=foobar991592891,ou=users,dc=example,dc=com
	cn=foobar1710975716,ou=users,dc=example,dc=com
	cn=foobar1505673129,ou=users,dc=example,dc=com
	cn=foobar1924966176,ou=users,dc=example,dc=com
	cn=foobar799226338,ou=users,dc=example,dc=com
	cn=foobar1999491022,ou=users,dc=example,dc=com
	cn=foobar14075397,ou=users,dc=example,dc=com
	cn=foobar539697111,ou=users,dc=example,dc=com
	cn=foobar112108820,ou=users,dc=example,dc=com
	cn=foobar1369772211,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users1418978137,ou=groups,dc=example,dc=com
Members:
	cn=foobar1588906497,ou=users,dc=example,dc=com
	cn=foobar713515675,ou=users,dc=example,dc=com
	cn=foobar111198746,ou=users,dc=example,dc=com
	cn=foobar1413209068,ou=users,dc=example,dc=com
	cn=foobar1748690196,ou=users,dc=example,dc=com
	cn=foobar1650270608,ou=users,dc=example,dc=com
	cn=foobar1083182874,ou=users,dc=example,dc=com
	cn=foobar397077941,ou=users,dc=example,dc=com
	cn=foobar982743351,ou=users,dc=example,dc=com
	cn=foobar1305199694,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users1970486739,ou=groups,dc=example,dc=com
Members:
	cn=foobar547480036,ou=users,dc=example,dc=com
	cn=foobar2092828899,ou=users,dc=example,dc=com
	cn=foobar1150791207,ou=users,dc=example,dc=com
	cn=foobar1648997840,ou=users,dc=example,dc=com
	cn=foobar632840294,ou=users,dc=example,dc=com
	cn=foobar1688785372,ou=users,dc=example,dc=com
	cn=foobar1402211544,ou=users,dc=example,dc=com
	cn=foobar1360676914,ou=users,dc=example,dc=com
	cn=foobar1900838417,ou=users,dc=example,dc=com
	cn=foobar174731773,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users80556787,ou=groups,dc=example,dc=com
Members:
	cn=foobar763847686,ou=users,dc=example,dc=com
	cn=foobar532641707,ou=users,dc=example,dc=com
	cn=foobar1478107215,ou=users,dc=example,dc=com
	cn=foobar1457615713,ou=users,dc=example,dc=com
	cn=foobar1740817394,ou=users,dc=example,dc=com
	cn=foobar477128147,ou=users,dc=example,dc=com
	cn=foobar1686683086,ou=users,dc=example,dc=com
	cn=foobar625635825,ou=users,dc=example,dc=com
	cn=foobar122705808,ou=users,dc=example,dc=com
	cn=foobar827130393,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users93075839,ou=groups,dc=example,dc=com
Members:
	cn=foobar1197670610,ou=users,dc=example,dc=com
	cn=foobar1478107215,ou=users,dc=example,dc=com
	cn=foobar477128147,ou=users,dc=example,dc=com
	cn=foobar122705808,ou=users,dc=example,dc=com
	cn=foobar847443321,ou=users,dc=example,dc=com
	cn=foobar39774714,ou=users,dc=example,dc=com
	cn=foobar797719296,ou=users,dc=example,dc=com
	cn=foobar1695434944,ou=users,dc=example,dc=com
	cn=foobar1251231239,ou=users,dc=example,dc=com
	cn=foobar2524660,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users91103896,ou=groups,dc=example,dc=com
Members:
	cn=foobar991592891,ou=users,dc=example,dc=com
	cn=foobar1688694241,ou=users,dc=example,dc=com
	cn=foobar1924966176,ou=users,dc=example,dc=com
	cn=foobar1070601909,ou=users,dc=example,dc=com
	cn=foobar95317734,ou=users,dc=example,dc=com
	cn=foobar1999491022,ou=users,dc=example,dc=com
	cn=foobar62701314,ou=users,dc=example,dc=com
	cn=foobar14075397,ou=users,dc=example,dc=com
	cn=foobar1541805698,ou=users,dc=example,dc=com
	cn=foobar369641998,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users78102241,ou=groups,dc=example,dc=com
Members:
	cn=foobar997638232,ou=users,dc=example,dc=com
	cn=foobar1588244344,ou=users,dc=example,dc=com
	cn=foobar1783755629,ou=users,dc=example,dc=com
	cn=foobar1371091481,ou=users,dc=example,dc=com
	cn=foobar904159761,ou=users,dc=example,dc=com
	cn=foobar794627990,ou=users,dc=example,dc=com
	cn=foobar104918275,ou=users,dc=example,dc=com
	cn=foobar839977082,ou=users,dc=example,dc=com
	cn=foobar725629285,ou=users,dc=example,dc=com
	cn=foobar1958046554,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users236420517,ou=groups,dc=example,dc=com
Members:
	cn=foobar799557307,ou=users,dc=example,dc=com
	cn=foobar1258451414,ou=users,dc=example,dc=com
	cn=foobar1041699029,ou=users,dc=example,dc=com
	cn=foobar2092828899,ou=users,dc=example,dc=com
	cn=foobar547480036,ou=users,dc=example,dc=com
	cn=foobar2111497410,ou=users,dc=example,dc=com
	cn=foobar1648997840,ou=users,dc=example,dc=com
	cn=foobar1776604828,ou=users,dc=example,dc=com
	cn=foobar1121496402,ou=users,dc=example,dc=com
	cn=foobar1954769270,ou=users,dc=example,dc=com

Group: cn=ldap-confluence-users283478949,ou=groups,dc=example,dc=com
Members:
	cn=foobar1588906497,ou=users,dc=example,dc=com
	cn=foobar111198746,ou=users,dc=example,dc=com
	cn=foobar357608135,ou=users,dc=example,dc=com
	cn=foobar1413209068,ou=users,dc=example,dc=com
	cn=foobar1263319669,ou=users,dc=example,dc=com
	cn=foobar1650270608,ou=users,dc=example,dc=com
	cn=foobar397077941,ou=users,dc=example,dc=com
	cn=foobar2116500618,ou=users,dc=example,dc=com
	cn=foobar1668222621,ou=users,dc=example,dc=com
	cn=foobar1032804410,ou=users,dc=example,dc=com

Output showing Failure to Connect

This is an example of the output when the LDAP server is not available:

###########################################################################################################################

LDAP Support Tool version 4.0

###########################################################################################################################

Failed to connect to LDAP server: Failed to connect to LDAP server with provider URL ldap://ldap.example.com:389: ldap.example.com:389
com.atlassian.paddle.connection.ConnectionException: Failed to connect to LDAP server with provider URL ldap://ldap.example.com:389: ldap.example.com:389
	at com.atlassian.paddle.connection.DefaultConnectionFactory.createFriendlyLdapException(DefaultConnectionFactory.java:55)
	at com.atlassian.paddle.connection.DefaultConnectionFactory.createConnection(DefaultConnectionFactory.java:35)
	at com.atlassian.paddle.task.DefaultTaskRunner.runTask(DefaultTaskRunner.java:33)
	at com.atlassian.paddle.Paddle.testConnectivity(Paddle.java:98)
.
.
.
<<<snip>>>

Output showing No LDAP Configuration

This is an example of the output when the atlassian-user.xml file is not correctly configured for LDAP user management:

###########################################################################################################################

LDAP Support Tool version 4.0

###########################################################################################################################

Error reading atlassian-user.xml file: No LDAP settings found in XML configuration.
com.atlassian.paddle.configuration.ConfigurationException: No LDAP settings found in XML configuration.
	at com.atlassian.paddle.configuration.AtlassianUserConfiguration.setAtlassianUserXml(AtlassianUserConfiguration.java:44)
	at com.atlassian.paddle.configuration.AtlassianUserConfiguration.(AtlassianUserConfiguration.java:21)
	at com.atlassian.paddle.Paddle.testConnectivity(Paddle.java:79)
	at com.atlassian.confluence.admin.actions.ExternalUserConnectivityAction.execute(ExternalUserConnectivityAction.java:23)
.
.
.
<<<snip>>>
RELATED TOPICS

Requesting External User Management Support
LDAP User Management
User Management

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.