[SDP 5][ 25757492-db0e-411f-894a-4a6d92ef80c6] SharePoint Search 2016 Diagnostic (SPSearch2016)


This SharePoint Search 2016 (SPSearch2016) Diagnostic detects certain problematic conditions that may exist in the configuration of the server that is running Microsoft SharePoint Server. The rules in this diagnostic package are limited to SharePoint searching, crawling, and related activities.

Important The problematic conditions are checked only on the server on which this manifest is run. To make sure that you have maximum coverage, we recommend that you run SPSearch2016 on each computer in the Microsoft SharePoint farm.

This article explains the operation of this diagnostic package.

Required permissions

The rules in the diagnostic package leverage the SharePoint Windows PowerShell snap-in to get information about your farm. Therefore, the account that is used to run the diagnostic package must either be the farm account or have been given the required permissions through the Add-SPShellAdmin command. Note that the farm account is the account under which the timer service and central administration site's application pool are running.

Some rules in this diagnostic package also must have local server administrative credentials to use remote and local administrative tools and also to access secure system locations such as the registry. The following table can be used to reference the permissions that are required for each rule.

Permission codeDescriptionRequired permission
1Use SharePoint Windows PowerShell cmdlets to interact with the SharePoint farm.Farm Administrator
2Run queries against SharePoint databases.Farm Administrator
3Access server administrative tools.Server Administrator
4Access files and other resources on the server. Server Administrator

More Information

This article describes the information that may be collected from a computer when you run SPSearch2016.

DescriptionFile name
Contains the actual results of the SPSearch2016 manifest. This is what is shown to the user to indicate that status of each rule that is run.ResultReport.xml
This is an .xlst transform that formats the results in the ResultReport.xml file. It contains no customer data. Results.xsl
Contains debug information that may be generated during the execution of the manifest. It also contains timings on each of the rules that are run. It may contain customer data. However, every attempt has been made to minimize the amount of data.SPSearch2016.0.debugreport.xml
Contains additional debug information for the manifest execution. It may contain customer data. However, every attempt has been made to minimize the amount of data.Stdout.log
Contains the environmental information for each computer in the farm. The information that's captured includes the following:
  • Computer name
  • Operating system name
  • Last reboot/uptime
  • Computer model
  • Processors
  • Computer domain
  • Role
  • Operating system language
  • Time zone
  • Total RAM
  • Drives (total and free space available)
Contains SQL Server information from the SQL instance that hosts the SharePoint Configuration database. The information that's captured includes the following:
  • ProductVersion
  • ProductLevel
  • Edition
  • ServerName
  • InstanceName
  • MaxDegreeOfParallelism
  • LastUpdateDate
  • IsClustered
  • IsFullTextInstalled
  • IntegratedSecurity
Collects the SharePoint farm information. The information that's captured includes the following:
  • Farm general settings
  • Services on servers
  • Installed products on servers
  • Features on servers
  • Custom solutions
  • Service applications
  • Web applications
  • AAMs and authentication providers
  • Content databases
  • Content deployment
Contains detailed health report diagnostics for SharePoint Search Service Application components.%ComputerName%_cfg_%LANG%_O16SP_SearchComponentDetailDiagnostic.txt
Contains a health state check for SharePoint Search Service Application components.%ComputerName%_cfg_%LANG%_O16SP_SearchComponentHealthState.txt
Contains a runtime constellation health check for SharePoint Search Service Application components.%ComputerName%_cfg_%LANG%_O16SP_SearchRuntime.txt

General performance and reliability

Rule IDTitleRequired PermissionsDescription
45952226-46F1-4867-892D-22914259E9AASecurity Token Web Service does not exist1, 4http://support.microsoft.com/kb/2493524
9075ED01-1E56-461B-A8C2-F049CC13652DSecurity Token Service Application is not online1http://support.microsoft.com/kb/2493524
DB2D6406-5155-477A-AB9B-DF5E523AA7C0Check for disabled service accounts1, 4http://technet.microsoft.com/en-us/library/cc781527(v=WS.10).aspx
C717129A-25D9-4A00-9821-ED7BE333F7EECheck if application pools are domain or builtin accounts1http://gallery.technet.microsoft.com/office/Change-SharePoint-Web-64b872d7
74B418B9-84CD-491D-9251-A0B6C572FCE5Check SharePoint application pool .Net Framework version1, 4
8282AAB4-6164-4991-A78B-5CDFE4917C4FCheck for expired SharePoint certificates4http://technet.microsoft.com/library/cc730605.aspx
17F09AA0-78E8-4C83-AAFB-BF293E580E1FCheck time difference between SharePoint Servers and Domain Controllers1
5DDE95FB-2637-4C10-A657-84038614A916Check if Windows Auth Extended Protection is Enabled1, 4
33A8CA67-9771-C0DE-DE06-3FF3A4750358Check connection to crl.microsoft.com4http://blogs.technet.com/b/lukeb/archive/2011/04/13/sharepoint-delays-crl.aspx
42A80BE2-6E02-4B1B-9125-CB49FF1FF091Check if Application Server Administration Service Job Exists1
433BE5AA-0F3C-42E1-B958-3D27655A68D3Check if Application Server Administration Service Job ran recently1
4475D8F3-A222-42DB-8F18-4FBFF013ABA1Check if Application Server Administration Service Job schedule is modified from default1
453E9EFB-B5D7-4C25-AFE6-1CF7A43BA161Check if Application Server Administration Service Job status is online1

Capacity planning guidelines

Rule IDTitleRequired PermissionsDescription
8F1C132D-2656-4D8D-9E58-606C0F97B748Check for minimum hardware configuration3https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx
B4A7071B-7EE7-C0DE-DE06-4546907CF8E3Checks if there are more than two crawl components per search service application1https://technet.microsoft.com/en-us/library/cc262787(v=office.16).aspx#Search
C29CD08F-E40A-C0DE-DE06-FEB7ECA47CDBChecks if there are more than one query processing component per server 1https://technet.microsoft.com/en-us/library/cc262787(v=office.16).aspx#Search

Searching, crawling, and indexing

Rule IDTitleRequired PermissionsDescription
3920CEE6-ADBE-C0DE-DE07-65EEB09BA3EDCheck people search configuration.1http://technet.microsoft.com/en- us/library/hh582311.aspx
4298BA58-9003-C0DE-DE07-1E720756EF28Check if SiteData.asmx is modified.4http://msdn.microsoft.com/en-us/library/ms774821 (v=office.12).aspx
CDE10F2E-D02E-C0DE-DE07-86A4E8DBC212Check the search content access account permission on the user profile service1http://technet.microsoft.com/en- us/library/hh582311.aspx
D71257B8-0591-C0DE-DE07-CD0A1853E0A3Check content access account permission on Web Applications1http://technet.microsoft.com/en- us/library/cc678863.aspx#Section3
DC1A2159-A1AA-4B24-8922-6A91149F2632Check the crawl temporary folder on the server1http://support.microsoft.com/kb/2628230
81D3001B-11A2-4A31-9562- C3BD5EB894C5Check for changes to IgnoreCertCNError registry key1http://technet.microsoft.com/library/dd630760.aspx
A307CB67-E999-C0DE-DE06 -9FDA2E45A88BCheck SPNs on Search and Distributed Cache Service Accounts1, 3
CF480ABF-DDCA-457C-98A9- 01C8161443CFChecking memoryLimitMegabytes setting in noderunner.exe.config4
76C39B77-7C01-43BA-BEEB- D904F089D833Check custom dictionaries update job with mms configuration1
199466D0-ECCA-C0DE-DE07- A0CA38491A7ACheck for changes to search indexer performance level4https://technet.microsoft.com/library/gg750251 (v=office.14).aspx
C901AD77-CD52-4863-B7A3-943C7BCE186ECheck if registry key DebugFilters is not set to 04http://technet.microsoft.com/library/dd630757.aspx
D999154A-C1C2-44A0- AF5A-72475639CECCCheck if registry key DebugWordBreakers is not set to 04http://technet.microsoft.com/library/dd630757.aspx
2F449690-601E-42D5- A9AD-120D1B71E803Check if Search Robot Threads Number is not set to 01, 4http://technet.microsoft.com/library/dd630757.aspx
21E921EE-8804-43BE-9992 -1C5C2FDEB443Check for search service application index size limit1https://technet.microsoft.com/en-us/library/cc262787(v=office.16).aspx#Search
06FDEDDE- 71C9-418F-87E9-A89BC470E233Check for search component degraded state1https://technet.microsoft.com/en-us/library/jj862354.aspx
117E0326-7B9F-449A-901E-70ED3AFFBA1ACheck for search component inactive state1https://technet.microsoft.com/en-us/library/jj862354.aspx
2C5163BA-38B6-4A01-88EF-5664C1B5FE52Check for search component failed state1https://technet.microsoft.com/en-us/library/jj862354.aspx
C3F72D3C-8721-407C-8E5B-84A3C6FB5F1ACheck for search component unknown state1https://technet.microsoft.com/en-us/library/jj862354.aspx

Check for Search Service Application Proxy 1
B77B2C71-3081-45ED-A50D-F74505B6EEBECheck each web app for multiple search service app proxy groups1
1855DAA7-B280-4261-AE36-DFEDB645625CCheck status of SharePoint Search Location Configurations1
ED85393F-B739-43DB-BABE-1A432B13EF3CCheck if search content source name length exceeds 32 characters1
E823733B-F102-4E65-993F-160B88160BCDCheck status of search query and site settings service1https://technet.microsoft.com/en- us/library/ff468691.aspx
B740A656-522C-4ACC-9393-31C94171D2CFCheck if search application proxy is added to a proxy group1http://blogs.msdn.com/b/spses/archive/2012/08/29/sharepoint-2010-issues-with-service-application-proxy-amp-proxy-group- associations.aspx
CA2E4323-955B-4BD2-A2A2-8E9B35FDEB42Check if Primary search host controller has the latest repository version1https://technet.microsoft.com/library/jj219482.aspx
CA31EE38-4CC5-4E37- BF5F-960E715BB199Check if search host controller is online1https://technet.microsoft.com/library/jj219482.aspx
C7672409-D855-4A10- B939-52B8F3838BE2Check if web proxy server exists for search1https://technet.microsoft.com/en-us/library/ff623007.aspx
C96935DB-4BC5-43E4-AEBE-06FE0D286830Check if proxy server returns HTTP Status Code OK for a content source starting address1https://technet.microsoft.com/en-us/library/ff623007.aspx

Server and farm configuration and administration

Rule IDTitleRequired PermissionsDescription
EC2FB075-DD02-4E4D-89AE-B260D3F34014Check whether DisableLoopbackCheck registry is set3http://support.microsoft.com/kb/926642
19C5BFBD-6B69-40E6-BD5B- A97EAC7D0088Check for proper configuration of identity impersonation in web.config1, 4http://support.microsoft.com/kb/979917
96F32729-D6E2-42A1-B038- 8A5AEB6CB6CBChecking PSModulePath environmental variable4
B4B17887-105F-46FF-B5FC-6FA513E9BC0CCheck if SQL Server Native Client is installed4https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx


Frequently asked questions about the Microsoft Support Diagnostic Tool (MSDT) for Windows 7


Article ID: 3166496 - Last Review: Jun 14, 2016 - Revision: 1