Synchronizing LDAP Groups
Pre-requisites:
To synchronize a LDAP group through the CentraSite Command Line Interface, you must have the CentraSite Administrator role.
Before you run the tool, Software AG recommends that you create a database backup.
In addition to the database backup, make sure the following conditions are satisfied:
There is a unique registry object for the external LDAP group.
The external LDAP group can be uniquely identified in the security configuration.
You might consider synchronizing a LDAP group in CentraSite if you want to update any changes to the group, for example, user additions, user deletions, and user transfers between user groups from the LDAP directory. The synchronization affects users and groups and the user-to-group relationship only.
Assume that User1, User2, User3, and User4 are defined on the external authentication system, and a group called GroupA has members User1, User2, and User3, on the external authentication system. Assume that the users User1, User2, and User4 (except User3) and the Group A have already been imported from the external authentication system to CentraSite.
Now assume that User3 is added to GroupA in the external authentication system, User3 also becomes a member of the GroupA in CentraSite when the synchronization occurs.
CentraSite provides a command tool named sync Ldap Group for this purpose.
To synchronize LDAP group
Run the command sync Ldap Group. The syntax is of the format: C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd sync Ldap Group [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -groupName <GROUP-NAME>
The input parameters are:
Parameter | Description |
CENTRASITE-URL | (Optional). The URL of the CentraSite registry. For example, http://localhost:53307/CentraSite/CentraSite. |
USER-ID | The user ID of a registered CentraSite user who has the CentraSite Administrator role. For example, Administrator. |
PASSWORD | The password for the registered CentraSite user identified by the parameter USER-ID. |
GROUP-NAME | The name of the LDAP group to synchronize the group's membership and the user information from the LDAP directory. |
Example (all in one line):
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd sync Ldap Group -url http://localhost:53307/CentraSite/CentraSite -user Administrator -password manage -groupName SAG\ManageAssets
The response to this command could be:
Executing the command: sync Ldap Group
Group SAG\ManageAssets synchronised successfully.
Successfully executed the command: sync Ldap Group