SPDocKit Consultant
Try it for FreeContact UsProduct Site
  • SPDocKit Consultant by Syskit
  • Product Updates
    • SPDocKit Consultant 12
    • SPDocKit Consultant 11.1.0
    • SPDocKit Consultant 11
    • SPDocKit Consultant 10
    • SPDocKit Consultant 9.1.0
    • SPDocKit Consultant 9
    • SPDocKit Consultant 8.0.3
    • SPDocKit Consultant 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Installation Guide
    • Upgrade to the Latest Version
    • Uninstallation Guide
    • PowerShell Guide
  • Activation
    • Activation Privacy Statement
    • Online Activation
    • Offline Activation
    • Manage License
    • Activation FAQ
    • Consultant License FAQ
  • Get To Know SPDocKit Consultant
    • Backstage Screen
      • Options Wizard
      • Compare Wizard
    • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Passwords and Product keys
    • Best Practices Screen
    • Snapshots Screen
    • PowerShell Commands
  • How To
    • Create Snapshot
    • Farm Documentation
      • Create Farm Documentation
      • Customize Documentation Template
    • Compare Wizard
      • Compare Farms
      • Compare Servers
      • Compare Web Applications
      • Compare Site Collections
      • Compare Web.Config Files
    • Best Practices
      • Available Best Practices Reports
      • Create Custom Best Practices Reports
      • Personalize Best Practices Reports
    • Generate an AutoSPInstaller XML Configuration File
  • FAQ
    • Miscellaneous
    • Security
    • Troubleshooting
      • RPC Server is Unavailable
      • Could not access content database
      • Error occurred while loading Web Application
      • Error occurred while trying to load ‘Problems and Solutions’ and ‘Rule Definitions’
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • The service application 'UPA Name' does not have any proxies that are default in a proxy group
      • SQL Server is unavailable
  • Known Issues
    • CREATE TABLE permissions denied
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • PowerPivot FileNotFoundException issue
    • Unaccounted differences in the UPA settings
Powered by GitBook
On this page
  • Install SPDocKit PowerShell Module
  • 1. Using the command
  • 2. Manually copy and paste PowerShell module:
  • Uninstall SPDocKit PowerShell Module
  • Update SPDocKit PowerShell Module

Was this helpful?

  1. Installation

PowerShell Guide

This article explains how to install, uninstall, or update SPDocKit PowerShell Module.

PreviousUninstallation GuideNextActivation

Last updated 1 year ago

Was this helpful?

SPDocKit PS module is used to collect SharePoint farm settings and permissions. SPDocKit PS module needs to run on a server inside your client’s farm.

After acquiring PowerShell module from or Syskit , the module can be imported by manually copying the module and pasting it to the PowerShell module path or by using the command, whichever you prefer.

The PowerShell module can be used with PowerShell version 3.0 or higher.

Install SPDocKit PowerShell Module

1. Using the command

Please note! To be able to install _**_SPDocKit PS module using PowerShell's Install-Module command, PowerShell 5 or later is required.

You can easily upgrade PowerShell by downloading

  • Save the module to preferred location:

Save-Module -Name SysKit.SPDocKit.PS -Path < path >

< path > can be any location of your choice such as: C:\Users\Public\Desktop Save–Module command automatically downloads and unzips module to location.

  • Install the module:

Install-Module -Name SysKit.SPDocKit.PS

Install-Module command installs SPDocKit PS Module to default location: C:\Program Files\WindowsPowerShell\Modules

  • (Optional) Check the SPDocKit PS module version:

Get-SPDocKitVersion

Running Get-SPDocKitVersion is used to check SPDocKit PS module version to make sure you have successfully installed the module.

2. Manually copy and paste PowerShell module:

  • Navigate to the Manual Download tab, then select the Download the raw nupkg file option.

  • Once you’ve downloaded syskit.spdockit.ps.1.X.X.nupkg, change the file extension from .nupkg to .zip and extract it to a location of your choosing.

Please note! The file you downloaded is just a .zip archive with extra files containing information about the contents of the package. You can unpack the downloaded file by changing the file extension from .nupkg to .zip.

  • Finally, copy the extracted content from syskit.spdockit.ps.1.X.X folder to C:\Program Files\WindowsPowerShell\Modules\SysKit.SPDocKit.PS.

Uninstall SPDocKit PowerShell Module

If you wish to uninstall SysKit.SPDocKit PS module from a server inside your client’s farm you can use the following command:

Get-InstalledModule -Name “SysKit.SPDocKit.PS” | Uninstall-Module

Or you can manually delete SysKit.SPDocKit PS file from the location you chose during installation.

Update SPDocKit PowerShell Module

SysKit.SPDocKit module update can be done using the following command:

Update-Module -Name “SysKit.SPDocKit.PS”

To update the module manually, first, uninstall the existing version of module, then follow instructions in [section 2](powershell-guide.md#2-manually-copy-and-paste-powershell-module) of this article.

Please note! After a successful update of the module, restart of the Windows PowerShell is required before creating the snapshot, otherwise, the snapshot will be created using the old version of the module.

SPDocKit PS module does not support SharePoint 2010.

Go to to find the latest version of SPDocKit PowerShell module.

General information on how to create a snapshot can be viewed .

PowerShell Gallery
Customers Web
WMF 5.0 or later.
PowerShell Gallery
here