This page last changed on Apr 07, 2008 by smaddox.

Confluence supplies an 'External User Test' tool (also called 'Paddle') that will test the LDAP settings in your atlassian-user.xml file. This will help you to diagnose problems with external 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 external user management by Active Directory and other LDAP directories.

This document applies to Confluence 2.8 and later

From Confluence version 2.8, the External 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:

Error formatting macro: toc: java.lang.NullPointerException

Running the External User Test Tool via the Administration Console

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 the external user management settings,

  1. First verify that external user management is enabled for your Confluence instance:
    • Go to the 'Administration Console' and click 'General Configuration' in the 'Configuration' section of the left-hand panel.
    • Verify that the 'External user management' option is turned on (in the 'Security and Privacy' section).
  2. Still in the 'Administration Console', click 'External User Test' in the 'Administration' section of the left-hand panel.
    The 'External User Test' will only appear if you have external user management enabled, as described in the preceding step.

  3. 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 External User Test Tool outside Confluence

You do not need to have Confluence running to run this tool. Instead, you can copy the jar file from your Confluence installation, add the supplied log4j.properties file, and run the tool against your atlassian-user.xml file. Detailed instructions are below.

Steps in Detail

  1. Copy the Paddle jar file into a directory where you have permission to create files. You will find this file at the following location in your Confluence Installation directory: <Confluence-Installation>/confluence/WEB-INF/lib/atlassian-paddle-5.jar
  2. Download the properties file attached to this page and put it into the same directory as the jar file.
  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.
  4. Run java -jar paddle-5.jar.

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


log4j.properties (application/octet-stream)
ExternalUserTest.png (image/png)
Document generated by Confluence on Apr 10, 2008 20:47