Purpose
This article outlines how to run an On Demand Scan to perform a one-time immediate data collection with a collector client. BHE administrators may use it during collector client deployment, one-time collections, or troubleshooting.
Prerequisites
- Creation of one SharpHound Enterprise client, see Create a SharpHound Enterprise collector client
- Logged in as a user role which is authorized to run an On Demand Scan, see User Role Definitions
Process
- In the top right, click settings ⚙️ → Administration
- In the top left side, click Manage Clients
- On the client, click the burger menu and select On Demand Scan
- Tip: Verify the client is online by validating Status is Ready
- In the On Demand Scan window, configure the scan:
- Data: The type of data the schedule collects, see SharpHound Enterprise Data Collection and Permissions
-
Advanced Options: See the Scanning section in the article SharpHound Enterprise Tenant Configuration
- Start the scan by clicking Run
Outcome
The client will start the On Demand Scan after the next client check-in, usually within one minute.
Once started, the client's Status will show Running a Job:
After completion, see the job's status in the Finished Jobs Log by clicking ⚙️ → Administration, and in the top left side, click Finished Jobs Log. The columns Status and Status Message report on the job's completion.
Updated