Active Directory / LDAP Harvester Guide
Install and activate the Invarosoft AD/LDAP Harvester, connect it to a client directory, approve imports, run manual or scheduled updates, and configure deployment through XML and command-line tools.
The Active Directory/LDAP Harvester imports users from a client’s directory into ITSupportPanel and PSA contacts. Follow the steps below to install, configure, and approve the Harvester.
From the Invarosoft Portal, download the AD Harvester installer to your client’s server and run the installation. The configuration screen opens automatically after installation.
Enter the client’s activation code into the field near the top right of the configuration form and click Activate.
The Harvester Info section should display Pending Approval. While it remains in this status, Invarosoft servers will not process any actions.
The Harvester Activation area should show the partner and client details.
Enter the Active Directory/LDAP server IP address or hostname, a username with permission to browse the directory, and the associated password. The form also provides AD Domain, OU Filter, and Search Filter fields.
Click Test AD Connection to verify connectivity, then use Review Results to inspect the users returned.
Once the connection test succeeds, click Save Changes to save the connection details. Use Review Results again to confirm the set of users the Harvester will collect.
In the Invarosoft Portal, go to Clients and click the Harvest button against the relevant client.
Click Approve on the client’s Harvest page.
After approval, the portal displays the Harvest screen. Invarosoft servers are now ready to receive the first Active Directory upload for processing.
You can manually execute an update to synchronize new users sooner than the default scheduled run.
Use the Start Menu or desktop icon labeled ADHarvester Config to reopen the configuration form.
Click Execute Upload in the Harvester Info section.
A confirmation dialog is displayed. For more information, review the black command-style console window that opens during the upload.
According to the source guide, the server-side processor picks up and processes the dataset within approximately 2–5 minutes. Check the client’s Harvest page in the portal to review its status.
Use the Start Menu or desktop shortcut labeled ADHarvester Manual Update.
The shortcut opens a console window, runs the update automatically, and closes shortly afterwards.
The guide states that processing takes approximately 2–5 minutes. Refer to the client’s Harvest page for the result.
The Harvester installer automatically creates a task that runs every 2 hours. You can modify this schedule in Windows Task Scheduler.
On the server, open Control Panel and go to Administrative Tools.
Select Task Scheduler.
Find the entry named ITSP ADHarvester and edit its schedule and settings.
After saving, the directory harvest will run according to the schedule you defined.
The Harvester supports configuration through PSA/RMM tools or custom scripts using an XML configuration file and a command-line action.
| Element | Purpose |
|---|---|
| activationcode | Activation code for the client to which the Harvester is being installed. |
| adserverip | IP address or hostname of the Active Directory server. |
| adusername | Active Directory user account with directory browsing rights. |
| adpassword | Password for that Active Directory account. |
| addomain | Field included in the XML example; the source guide does not give a separate definition. |
| oufilter | Field included in the XML example; the source guide does not give a separate definition. |
| searchfilter | Field included in the XML example; the source guide does not give a separate definition. |
Run itsp.adharvest.exe from its installation directory with the following arguments:
The results are written to the console. If successful, no further server-side configuration is required, but you must still approve the Harvester in the Invarosoft Portal.
The executable supports the following arguments to script Harvester configuration and execution.
| Argument | Action |
|---|---|
| ACTIVATE <code> | Activate the Harvester using the supplied activation code. |
| DEACTIVATE | Deactivate the Harvester without clearing its Active Directory configuration. |
| RESET | Perform a full factory reset, including deactivation and removal of Active Directory configuration. |
| CONFIGURE | Open the interactive configuration form. |
| CONFIGUREXML <path> | Configure the Harvester from a formatted XML file. |
| PROCESS | Upload Active Directory users to Invarosoft. |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article