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
  • To add a user account to the Local Administrators group (repeat the same steps for WSS_ADMIN_WPG):
  • To add a user account to SharePoint farm Administrators group:
  • To add a user account to SharePoint_Shell_Access role:

Was this helpful?

  1. Requirements

SharePoint On-Premises User Permissions Requirements

This article lists all user privileges needed to retrieve SharePoint farm settings with SPDocKit Snapshot Wizard or SPDocKit PowerShell module.

PreviousRequirementsNextSupported SharePoint Editions

Last updated 2 years ago

Was this helpful?

To run SPDocKit Snapshot Wizard or SPDocKit PowerShell module and to retrieve all SharePoint settings you want to document, the user running SPDocKit Snapshot Wizard or SPDocKit PowerShell module needs to have proper privileges. Here is the list of required privileges to load SharePoint farm settings:

  1. Local Administrators and WSS_ADMIN_WPG group member on every machine in the SharePoint farm. Required to retrieve list of installed applications on farm servers.

  2. SharePoint farm administrator. Required to retrieve SharePoint farm settings.

  3. Member of SharePoint_Shell_Access role on SharePoint Server databases. Required to retrieve particular SharePoint farm properties via PowerShell.

  4. needed to retrieve additional server configuration data (RAM, processors, disk space…) and SQL Server configuration information for DB servers.

  5. needed to retrieve Search service application configuration data (content sources, crawl rules, managed properties, search topologies...).

  6. needed to retrieve User Profile service application configuration data (Synchronization Connections, MySite Settings, Audiences, User Profile Properties...).

Here is how you can give user these privileges:

To add a user account to the Local Administrators group (repeat the same steps for WSS_ADMIN_WPG):

  • On the server, click Start, right-click Computer, and then click Manage.

  • Navigate to Configuration, expand Local Users and Group and then click Groups.

  • Right-click the Administrators group, and then click Add to Group.

  • In the Administrators Properties dialog box, click Add.

  • In the Select User, Computers, or Groups dialog box, in the Enter the object names to select box, type the account name on which you want your worker process to run (for example, Domain\YourAccount), and then click OK.

  • In the Administrators dialog box, click OK.

  • Close the Server Manager screen.

To add a user account to SharePoint farm Administrators group:

  • Open SharePoint Central Administration.

  • Navigate to Security > Manage the farm administrators group.

  • Use the New button to add users to this group.

To add a user account to SharePoint_Shell_Access role:

  • Open SharePoint Management Shell.

  • If you want to grant PowerShell shell access to all content databases, download: Configure-SPShellAdmin.ps1

if((Get-PSSnapin | Where {$_.Name -eq "Microsoft.SharePoint.PowerShell"})-eq $null) 
{Add-PSSnapin Microsoft.SharePoint.PowerShell;}  
cls  
$username = Read-Host "Enter username";  
Get-SPDatabase | ForEach-Object {Add-SPShellAdmin -UserName $username -database $_.Id}

Please note! The cmdlet Add-SPShellAdmin is going to apply to all current SharePoint databases. If more SharePoint databases are added in the future, you might have to re-run the cmdlet again.

Type the following PowerShell command: <Add-SPShellAdmin -UserName DOMAIN\YourAccount>

If you want to grant PowerShell shell access to a single database for more details.

The cmdlet might fail in some environments; please for further assistance.

(click here to learn more)
check this article
contact us
Server specific requirements
Search service application requirements
User Profile service application requirements
6KB
configure-spshelladmin.zip
archive