Set-PnPHomePage

Module:
SharePointPnPPowerShell
Applies to:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online

Sets the home page of the current web.

Syntax

Set-PnPHomePage
   -RootFolderRelativeUrl <String>
                  [-Web <WebPipeBind>]
                  [-Connection <PnPConnection>]

Examples

------------------EXAMPLE 1------------------

Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx

Sets the home page to the home.aspx file which resides in the SitePages library

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-RootFolderRelativeUrl

The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'

Type:String
Aliases:Path
Position:0
Accept pipeline input:True
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False