Self Scan

For a probe to scan workstations, certain conditions must be met.

If, for any reason, these conditions cannot be fulfilled, you can use the Self Scan script as an alternative.

Self Scan scripts allow you to scan a standalone machine locally and upload the results either to the probe machine or directly to ServiceDesk Plus Cloud.

To run a self scan script,

On Windows machines: Run SelfScan.exe.
On Linux or macOS machines: Run Scan_Script.sh.

These scripts must be executed individually on each machine to be scanned.

If the machine to be scanned is inside your network and has access to the probe, you can configure the script to send the scan data to the probe.

If the machine is outside of your network and does not have probe access, you can configure the script to send data directly to ServiceDesk Plus Cloud.

Download Self Scan

Go to Setup > Probes & Discovery > Settings > Scan Script.
Download SelfScan.exe or Scan_Script file by clicking the link provided.

Using Self Scan to Send Details to the Probe

You can scan a standalone workstation and upload the results to the probe using the Self Scan script. The script must be run from the workstation’s command prompt, with the probe's hostname specified as an argument.

Platform

Command

Parameters

Example

Mac/Linux

bash scan_script.sh <probehostname> sw_scan=false

sw_scan: Set to true if software information needs to be collected during the scan on Linux machines.

Default: sw_scan=false.

bash scan_script.sh test-probe-machine sw_scan=true

Windows

SelfScan.exe <probehostname> 5454

<probehostname>: Name of the probe machine.
5454: Probe communication port.

SelfScan.exe test-probe-machine 5454

The scan details are first uploaded to the probe, which then forwards the data to ServiceDesk Plus Cloud.
Make sure that the port 5454 on the probe machine is accessible from the target workstation; otherwise, the upload will fail.

Using Self Scan to send data to ServiceDesk Plus Cloud

SelfScan.exe / scan_script.sh scripts can directly upload the scan data to ServiceDesk Plus Cloud.

Use this method only if the standalone machine is outside of your network and do not have access to the probe.

To scan the standalone system, follow the steps below:

Open Command Prompt and go to SelfScan.exe location.
Generate API Key from Setup > Probes & Discovery > Settings > Scan Script by clicking the corresponding link.

Copy the Self Scan apiKey.
Now, execute the script by using the apiKey to upload the scan details to ServiceDesk Plus Cloud.

For Mac/Linux

bash scan_script.sh apiKey=xxx sw_scan=false serverUrl=https://sdpondemand.manageengine.com

Parameter

Description

sw_scan

If the software information need to be discovered during the scan on Linux machines, use "sw_scan=true"

Default: sw_scan=false

serverUrl

Depends on the ServiceDesk Plus Cloud data center used. Click here to know more.

Example: For IN DC,

bash scan_script.sh apiKey=1003.e3d5xxxx.xxxx2hlc sw_scan=true server=https://sdpondemand.manageengine.in

For Windows

C:SelfScan>SelfScan.exe apiKey=xxx server=sdpondemand.manageengine.com

Parameter

Description

server

Depends on the ServiceDesk Plus Cloud data center used. Click here to know more.

Example :
SelfScan.exe apiKey=1003.e3d5xxxx.xxxx2hlc server=sdpondemand.manageengine.com

This will scan the standalone system, and send the scan data to ServiceDesk Plus Cloud.

Configure SelfScan.exe to run as an Active Directory logon script

You can configure the self-scan script as a Logon script in Active Directory. If configured, the script will run during the user login process, scan the user's machine, and send the scanned data to the probe.

To configure as a Logon script, do the following:

From your domain controller, go to Group Policy Management Console.
In the console tree, right-click the domain or OU and create a new GPO.
Enter a name for the GPO and click OK.
Right-click the newly created GPO and click Edit.
In the pop-up window, go to User Configuration > Policies > Windows Settings > Scripts. Double-click logon.
New logon properties will open. Click Add.
Click Browse. A windows explorer tab will open.
Copy and paste the SelfScan.exe file to this folder.
Select SelfScan.exe.
In the script parameters field, type the probe installation system name (for example, SDPOD-WIN10) and click OK.
Click OK in the Logon properties window.

Other Parameters

For Windows Machine:

1) timeout=10: If the SelfScan throws timeout error, you can use this parameter to increase the wait time and complete the scan.

2) no_vm_scan: To exclude the Hyper-V virtual machine during the scan.

FAQs

1. Error: "Please check apiKey or Problem while uploading to server,error=401"

Cause:

The apiKey is incorrect.
The ServiceDesk Plus Cloud server URL (based on the Data Center) is not configured correctly.

Resolution

Verify and update the apiKey.
Ensure the correct SDP Cloud server URL is used.

2. Error while using the probe host name: "Unable to resolve probe host"

Cause:

Incorrect or unreachable probe hostname.
Port 5454 on the probe machine is blocked.

Resolution:

Port 5454 should be enabled in the probe-installed machine if you are using the probe hostname as a parameter.

Ping the ProbehostName/ProbeHostIP to verify if the probe machine is reachable. For example,

ping ProbeHostNameOrIP

On the target machine, use the following command:

PowerShell -command "Test-NetConnection -ComputerName ProbeHostNameOrIP -Port 5454"

TcpTestSucceeded should be true.

3. Error: SelfScan terminated with error "Going to terminate process with timeout =150000"

Resolution:

Use the timeout parameter while executing the Self Scan.

For example,

SelfScan.exe apiKey=1003.er45xxxx.xxxx3fgh server=sdpondemand.manageengine.com timeout=15

4. Error: Configured GPO policy is not working

Cause:

The SelfScan executable is not placed in a location accessible to all target machines.
Incorrect parameters used in the GPO script.

Resolution:

Ensure that the folder containing SelfScan.exe is a shared location accessible to all target machines affected by the GPO policy.
- By default, when you click Browse while selecting the Script Name in GPO, it points to a public path accessible by all target machines.
- Copy SelfScan.exe to this path and select it in the policy.
Manually execute SelfScan.exe with the required parameters on one of the target machines.
After the execution is successful, use the same parameters in the GPO policy configuration.