PowerShell Scanners

Table of Contents

• Downloading
  • Git
  • ZIP
• Importing
• Using in PDQ Connect
• Contributing

Downloading

Git

The best way to use this repository is with Git. It makes updating very easy and allows you to contribute your own PowerShell scanners or fixes.

Setup

1. Install Git. We have a package for this in PDQ Deploy's Package Library ;)
2. Clone this repository to the root of your C drive. This is necessary because the PowerShell Scanner feature does not currently support variables, and all paths assume C:\PowerShell-Scanners.

git clone https://github.com/pdq/PowerShell-Scanners.git C:\PowerShell-Scanners

Updating

1. Navigate to your clone of this repository.
2. Run git pull.

cd C:\PowerShell-Scanners
git pull

ZIP

An alternative download method if you can't/don't want to install Git.

Setup

1. Click the green "Code" button toward the top-right of this page.
2. Click the "Download ZIP" link.
3. Save the ZIP anywhere you want.
4. Extract the contents of the ZIP to the root of your C drive. This is necessary because the PowerShell Scanner feature does not currently support variables.
5. Rename PowerShell-Scanners-master to PowerShell-Scanners.

Updating

1. Delete C:\PowerShell-Scanners (as long as you haven't edited anything!).
2. Follow the Setup instructions again.

Importing

Now that you have this repository downloaded, it's time to import the PowerShell Scanner profile(s) that you want!

1. Open PDQ Inventory (version 19.0.40.0 or later).
2. Go to File > Import.
3. Navigate to the folder of the PowerShell Scanner you want, such as C:\PowerShell-Scanners\PowerShell Scanners\Mapped Drives.
4. Click on Scan Profile.xml.
5. Click the Open button.

That's it! To update your imported profile(s), follow the appropriate Updating section above. You shouldn't have to re-import any Scan Profiles unless you see a note telling you to in that profile's README file.

Using in PDQ Connect

Many of these scanners are compatible with PDQ Connect for remote execution. To use a scanner in PDQ Connect:

1. Check the scanner's README file for the Compatibility section to verify PDQ Connect support.
2. Copy the PowerShell code from the scanner's .ps1 file.
3. Paste it into a PDQ Connect Run PowerShell script action.
4. Configure any required parameters as noted in the scanner's README.

For a list of scanner compatibility with PDQ Connect, see the Compatibility section in each scanner's README under PowerShell Scanners\<Scanner Name>\README.md.

Contributing

If you have created a PowerShell Scanner that you would like to add to this repository, please read the Contributing guide.