Usage

Usage Guide for SPSWakeUp.ps1

Overview

SPSWakeUp.ps1 is a PowerShell script designed to wake up SharePoint sites by sending HTTP requests to their URLs. This ensures that the sites are preloaded into memory, reducing the initial load time for users.

The script can use two execution paths:

• PowerShell 7.x path via SPSWakeUp-pwsh.ps1 (preferred when available).
• PowerShell 5.1 fallback path when pwsh is not installed.

Prerequisites

• PowerShell 5.1 or later.
• PowerShell 7.x (optional but recommended).
• Run from a SharePoint Web Front End (WFE) server.
• Do not run from a server with the Search MinRole.
• Necessary permissions to access the SharePoint sites.
• Ensure scripts are placed in the same directory and accessible by the user:
  • SPSWakeUP.ps1
  • SPSWakeUp-pwsh.ps1

Parameters

The script supports the following parameters:

Parameter	Description
-Action	(Optional) Use the Action parameter equal to Install if you want to add the warmup script in taskscheduler, InstallAccount parameter need to be set. Use the Action parameter equal to Uninstall if you want to remove the warmup script from taskscheduler. Use the Action parameter equal to AdminSitesOnly if you want to warmup the Central Administration Site collection
-InstallAccount	(Optional) Need parameter InstallAccount whent you use the Action parameter equal to Install.
-Transcript	(Optional) Use the boolean Transcript parameter if you want to start Transcrit PowerShell Feature.

Examples

Example 1: Wake up central admin site

.\SPSWakeUP.ps1 -Action AdminSitesOnly

Example 2: Wake up all sites

.\SPSWakeUP.ps1

Example 3: Install script in Task Scheduler

.\SPSWakeUP.ps1 -Action Install -InstallAccount (Get-Credential)

Example 4: Uninstall script in Task Scheduler

.\SPSWakeUP.ps1 -Action Uninstall

Example 5: Enable Transcript

.\SPSWakeUP.ps1 -Transcript:$True

Logging

The script logs the status of each request, including success or failure, and saves it to the specified log file or the default location.

Error Handling

• If a site URL is unreachable, the script will log the error and continue with the next URL.
• Ensure the provided credentials have access to the specified SharePoint sites.

Notes

• Use HTTPS URLs for secure communication.
• If your environment only uses PowerShell 5.1, the script still works through fallback mode.
• Test the script in a non-production environment before deploying it widely.

Support

For issues or questions, please contact the script maintainer or refer to the project documentation.