Install the PnP PowerShell Module for SharePoint Online

The PnP PowerShell module has become an indispensable tool for many SharePoint administrators and developers. This open-source module, created by Microsoft’s Patterns and Practices (PnP) initiative, provides a robust set of commands for managing SharePoint Online and SharePoint Server through PowerShell.

In this post, I will provide an overview of the PnP PowerShell module, discuss how to install and update it, demonstrate some key commands and capabilities, and share some of the common tasks to manage your SharePoint environment. Whether you are new to the PnP PowerShell module or looking to get more out of it, this post will help take your skills to the next level. By the end, you’ll have the module installed and connected to SharePoint Online using an authenticated session for executing commands.

What is PnP PowerShell?

PnP PowerShell

The new PnP PowerShell module PnP.PowerShell is a cross-platform, .net framework-based PowerShell product that can run on any operating system that supports .net core, like Windows, Linux, macOS, etc., and provides 500+ cmdlets to work with Microsoft 365 environment (No support for On-Premises server products, As a side note!) cloud products like SharePoint Online, Microsoft Teams, Microsoft Planner, Security & Compliance, Azure Active Directory, and more.

Some of the key features of PnP PowerShell include:

  • Ability to connect to SharePoint Online and on-premises environments.
  • A wide range of cmdlets for managing sites, lists, libraries, content types, fields, and more.
  • Support for provisioning and deploying SharePoint artifacts.
  • Integration with the SharePoint REST API and CSOM (Client-Side Object Model).
  • Extensibility through custom cmdlets and scripts.
  • Working with SharePoint files and folders.
  • Managing Microsoft 365 users and groups.

If you are administering Microsoft SharePoint, you know that PnP PowerShell is an essential tool for managing your environment. It’s an open-source component and community-provided library with active community members providing support, so there won’t be any SLA or direct support from Microsoft. This article will show you how to install the PnP PowerShell module for SharePoint Online.

How to Install the PnP PowerShell Module: Step-by-Step

Managing SharePoint Online environments often requires executing repetitive administrative tasks – like creating sites, setting permissions, and configuring libraries. Carrying out these tasks manually through the SharePoint admin center can be time-consuming. That’s where the Patterns and Practices (PnP) PowerShell module comes into play.

To install the new PnP PowerShell module, You have to follow these steps:

  1. Uninstall the Legacy SharePointPnPPowerShellOnline Module, if already installed.
  2. Install the New PnP PowerShell Module.
  3. Register Azure AD Application and Grant Access to the tenant.

Let’s get started! Open the Windows PowerShell console as an Administrator and execute these steps to install PnP.PowerShell module.

install pnp powershell sharepoint online

Step 1: Uninstall the Legacy SharePointPnPPowerShellOnline Module

Check if the classic PnP PowerShell module is installed with the below command:

Get-Module SharePointPnPPowerShellOnline -ListAvailable | Select-Object Name,Version | Sort-Object Version -Descending

This returns the Name and version of legacy PnP PowerShell installed on the machine (If any). Uninstall Any previous PnP PowerShell Modules for SharePoint Online installed:

Uninstall-Module SharePointPnPPowerShellOnline -Force -AllVersions

Step 2: Install the New PnP PowerShell Module

How do I install a new PowerShell module? To install the new PnP PowerShell module, use:

Install-Module PnP.PowerShell

This will download and install the PnP PowerShell module from the PowerShell Gallery. How to install PnP PowerShell offline? If needed, You can also use setup files from GitHub, Download the PnP PowerShell Offline Installation package, and install it with the following:

Install-Package C:\Path\File.nupkg

Step 3: Register a new Azure AD Application and Grant Access to the tenant

Register-PnPManagementShellAccess

The final step is granting the tenant access to the PnP Management Shell Multi-Tenant Azure AD Application. On executing the above cmdlet, you’ll be prompted to log in and provide consent for your tenant. You must log in with Global Admin (or Tenant Administrator) permissions and complete this step.

add permission to PnP Management Shell

In case you are not a global admin, use: Register-PnPManagementShellAccess -ShowConsentUrl and share the URL you get from this cmdlet with the Tenant Admin, and they can complete this consent step from the URL you share.

register pnp managementshellaccess consenturl

Finally, You can verify the installation by getting a list of PnP PowerShell commands:

Get-Command -Module PnP.Powershell

Connect to SharePoint Online site using PnP PowerShell

How do I use PnP PowerShell in SharePoint Online? Once you are done with the above steps, You can connect to SharePoint Online through PnP PowerShell scripts with username and password with the following commands:

#Connect to PnP Online
Connect-PnPOnline -Url "https://Crescent.sharepoint.com/sites/Marketing/" -Credential (Get-Credential)

#Get All Lists
Get-PnPList

Connect-PnPOnline using MFA

To connect to SharePoint Online using PnP PowerShell MFA (Multifactor authentication): Use the “-Interactive” switch instead of “Credentials” if your account is MFA enabled. Behind the scenes, each cmdlet executes a client-side object model code to achieve functions.

#Connect to SharePoint site
Connect-PnPOnline -Url "https://Crescent.sharepoint.com/sites/Marketing" -Interactive

#Retrieve a List
$list = Get-PnPList -Identity "Documents"

This retrieves the list with the title “Documents” and assigns it to the $list variable.

If you want to schedule your PowerShell script, You can use either the Windows Task scheduler or Azure Automation! How to Schedule PowerShell Scripts with Azure Automation?

PnP PowerShell to Connect to OneDrive for Business

Microsoft OneDrive for Business – The cloud-based storage and file-sharing part of the Office 365 suite can be managed with PowerShell, too. To access the OneDrive for Business site from PowerShell, you will need to first connect to the OneDrive site by running the following cmdlet: Connect-PnPOnline. Once you are authenticated, you can then run any available cmdlets against your OneDrive for Business site just as you would any other SharePoint Online site. E.g., let’s connect to the OneDrive site and create a new folder:

#Parameters
$OneDriveSiteURL = "https://crescent-my.sharepoint.com/personal/salaudeen_crescent_com"
$FolderName = "Archives"
  
Try {
    #PowerShell to Connect to OneDrive for Business
    Connect-PnPOnline -Url $OneDriveSiteURL -Interactive
      
    #ensure folder in SharePoint Online using powershell
    Resolve-PnPFolder -SiteRelativePath "Documents/$FolderName"
}
catch {
    write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
}

Managing PnP PowerShell Module

Let’s see how to update it, find the installed module version, and uninstall the module:

Update PnP PowerShell for SharePoint Online

How do I update PnP PowerShell? To update the PnP PowerShell to the latest version, run the following:

Update-Module -Name "PnP.PowerShell"

This will download and install the latest version of the PnP PowerShell module on your local machine.

update pnp powershell

What version of PnP PowerShell do I have?

To check the installed version of PnP PowerShell in your system, use:

Get-InstalledModule -Name "PnP.PowerShell"

Uninstall the PnP PowerShell Module

If you would like to remove the PnP PowerShell, you can run the following:

Uninstall-Module -Name "PnP.PowerShell"

Can I have both the New PnP PowerShell and the Classic PnP Modules?

If you want to use the PnP PowerShell module for SharePoint Server (On-Premises), You can install it along with Pnp.PowerShell module as:

Install-Module -Name SharePointPnPPowerShell2019 -AllowClobber

This script installs the SharePointPnPPowerShell2019 module and makes cmdlets available from this module. You can use “Import-Module SharePointPnPPowerShell2019” on the first line to instruct your script to load and use Cmdlets from this specific module. As a side note, the old SharePointPnPPowerShellOnline module is archived and no longer updated.

At times, You may need to use the CSOM PowerShell scripts with the combination of PnP PowerShell cmdlets, as we don’t have PnP PowerShell cmdlets for each and everything in SharePoint Online: How to Connect to SharePoint online using CSOM PowerShell?

Most Common PnP PowerShell Cmdlets for SharePoint Online

Here are some of the most common PnP PowerShell cmdlets for SharePoint Online from the PnP.PowerShell module.

CmdletDescriptionReference
Connect-PnPOnlineConnects to a SharePoint site. Required before executing most other cmdlets.How to Connect to SharePoint Online using PnP PowerShell?
Get-PnPListRetrieves a list or library from the site.How to Get a List in SharePoint Online using PnP PowerShell?
Add-PnPListItemAdds an item to a list.How to Add a New List Item in SharePoint Online using PnP PowerShell?
Set-PnPListItemUpdates a list item with new data.How to Update List Items in SharePoint Online using PnP PowerShell?
Remove-PnPListItemDeletes an item from a list.How to Delete a List Item in SharePoint Online using PowerShell?
Get-PnPFileDownloads a file from the SharePoint site.How to Download a File from SharePoint Online using PnP PowerShell?
Add-PnPFileUploads a file to a document library or folder.How to Upload Files to SharePoint Online using PnP PowerShell?
Set-PnPFileUpdates properties of a file.How to Update Document Properties in SharePoint Online using PnP PowerShell?
Remove-PnPFileDeletes a file from a document library.How to Delete a File from SharePoint Online Document Library using PnP PowerShell?
Get-PnPWebRetrieves information about the site.How to Get Subsites in SharePoint Online using PnP PowerShell?
New-PnPWebCreates a new sub-site.How to Create a Subsite in SharePoint Online using PnP PowerShell?
Set-PnPWebUpdates properties of the site.How to Change the SharePoint Online Site Title (Name) using PnP PowerShell?
Get-PnPUserRetrieves a user from the site.How to Get All Users in SharePoint Online Site Collection using PnP PowerShell?
Add-PnPGroupMemberAdds a user to a group.How to Add User to a Group in SharePoint Online using PnP PowerShell?
Get-PnPTenantSiteRetrieves a list of site collections.How to Get All Site Collections in SharePoint Online using PnP PowerShell?
New-PnPListCreates a new list or library.How to Create a Document Library in SharePoint Online using PnP PowerShell?

How to Create a List in SharePoint Online using PnP PowerShell?
Remove-PnPListDeletes a list or library.How to Delete a List in SharePoint Online using PnP PowerShell?

How to Delete a Document Library in SharePoint Online using PnP PowerShell?
Get-PnPFolderRetrieves a folder within a list or library.How to Get a Folder in SharePoint Online Document Library using PnP PowerShell?
Add-PnPFolderCreates a new folder within a list or library.How to Create a Folder in SharePoint Online using PnP PowerShell?
Remove-PnPFolderDeletes a folder from a list or library.How to Delete a Folder in SharePoint Online using PnP PowerShell?
Get-PnPFieldRetrieves a field (column) from a list.How to Get List Fields in SharePoint Online using PnP PowerShell?
Add-PnPFieldAdds a new field (column) to a list.How to Add a Column to List in SharePoint Online Using PnP PowerShell?
Remove-PnPFieldRemoves a field (column) from a list.How to Delete a Column from a List in SharePoint Online using PnP PowerShell?
Set-PnPFieldUpdates a field (column) in a list.How to Change List Field Settings in SharePoint Online using PnP PowerShell?
Get-PnPViewRetrieves a view from a list.How to Get List Views in SharePoint Online using PnP PowerShell?
Add-PnPViewCreates a new view in a list.How to Create a List View in SharePoint Online using PnP PowerShell?
Remove-PnPViewDeletes a view from a list.How to Delete a List View in SharePoint Online using PnP PowerShell?
Set-PnPViewModifies a view in a list.How to Update a List View in SharePoint Online using PnP PowerShell?
Get-PnPGroupRetrieves a SharePoint group.How to Get SharePoint Groups from SharePoint Online site using PnP PowerShell?
New-PnPGroupCreates a new SharePoint group.How to Create a Group in SharePoint Online using PnP PowerShell?
Remove-PnPGroupDeletes a SharePoint group.How to Delete Group in SharePoint Online using PnP PowerShell?
Set-PnPSiteSets properties of a site collection.How to Enable Custom Script in SharePoint Online using PowerShell?

How to Change the Site Logo in SharePoint Online using PowerShell?
Get-PnPPropertyBag, Set-PnPPropertyBagRetrieves/sets key-value pairs from the property bag.How to Get-Set Property Bag Values in SharePoint Online with PnP PowerShell?
Add-PnPAppRetrieves installed apps from the site.How to Deploy an App to App Catalog in SharePoint Online?
Install-PnPAppInstalls an app to the site.How to Add an App to SharePoint Online Site using PnP PowerShell?
Uninstall-PnPAppUninstalls an app from the site.How to Remove an App in SharePoint Online using PnP PowerShell?
Get-PnPSiteTemplate, Invoke-PnPSiteTemplateGets/Applies a site template.How to Copy a Site in SharePoint Online using PnP PowerShell?
Get-PnPNavigationNode, Add-PnPNavigationNodeRetrieves/Adds navigation nodes from the site.How to Add Top Navigation Link in SharePoint Online using PnP PowerShell?

How to Add a Link to Quick Launch Navigation in SharePoint Online using PnP PowerShell?
Remove-PnPNavigationNodeRemoves a navigation node from the site.How to Remove a Link in Quick Launch/Top Navigation in SharePoint Online using PowerShell?
Get-PnPTermGroupRetrieves term groups from the term store.How to Export-Import Site Collection Term Store in SharePoint Online using PowerShell?
New-PnPTermGroupCreates a new term group in the term store.How to Create a New Term Group in SharePoint Online using PowerShell?
Remove-PnPTermGroupDeletes a term group from the term store.How to Delete a Term Group in SharePoint Online using PowerShell?
Set-PnPTermSetUpdates a term set in a term group.How to Update a Term Set in SharePoint Online using PnP PowerShell?
New-PnPTermSetCreates a new term set in a term group.How to Create a New Term Set in SharePoint Online using PnP PowerShell?
Get-PnPTermRetrieves terms from a term set.How to Get Terms from a Term Set in SharePoint Online using PowerShell?
Add-PnPTermAdds a new term to a term set.How to Create a Term in SharePoint Online Term Store using PowerShell?
Remove-PnPTermRemoves a term from a term set.How to Delete a Term in SharePoint Online Term Store using PowerShell?

Conclusion

And that wraps up this guide on installing and configuring the incredibly useful PnP PowerShell module for SharePoint Online! As you’ve seen, getting set up with PnP PowerShell is quick and easy with just a few PowerShell commands.

Now that the module is installed, you have access to a vast suite of commands for efficiently administering your SharePoint Online environments. From creating sites, lists, libraries, and columns to applying themes, managing permissions, and more, the possibilities are endless with PnP PowerShell.

Be sure to check out the documentation on the available cmdlets to leverage its capabilities fully. As SharePoint Online continues to evolve, so will the PnP PowerShell module, with new features added regularly.

I hope you found this guide helpful. The PnP PowerShell module can massively boost your productivity as a SharePoint admin or developer. Automating tasks allows you to focus on more strategic initiatives rather than heavy manual configuration.

What is PnP PowerShell?

PnP PowerShell is a set of PowerShell modules that provide a command-line interface for managing and automating tasks in SharePoint Online, SharePoint on-premises, and Microsoft 365 environments. It allows developers and administrators to interact with SharePoint using PowerShell commands.

How to install PnP PowerShell for SharePoint Online?

To install PnP PowerShell for SharePoint Online, open Windows PowerShell as Administrator and run the command: Install-Module PnP.PowerShell

How do I connect to SharePoint Online using PnP PowerShell?

To connect to SharePoint Online using PnP PowerShell, use the Connect-PnPOnline cmdlet. Here’s an example:
Connect-PnPOnline -Url "https://yourcompany.sharepoint.com" -Interactive

How do I get all columns, types, and internal names in my site by PnP PowerShell?

Use: Get-PnPField | Select Title, TypeDisplayName, InternalName
More info: Get Site Columns in SharePoint Online using PowerShell

How do you get all SP library IDs with PnP Online?

To get IDs of all SharePoint Online document libraries, use: Get-PnPList | Where-Object {$_.BaseType -eq “DocumentLibrary”}
More info: Get All Document Libraries in SharePoint Online

How do you create top link navigation in PowerShell?

Use the Add-PnPNavigationNode cmdlet to create a top navigation link to the SharePoint Online site.
More info: Add Top Navigation Link in SharePoint Online using PowerShell

How to use SharePoint Online Management Shell?

The SharePoint Online Management Shell is a PowerShell Module that helps administrators manage SharePoint Online sites. Install the Module “Microsoft.Online.SharePoint.PowerShell”, connect to SharePoint Online with Connect-SPOService, and then start using any available cmdlets.
More info: Connect to SharePoint Online from PowerShell

How do I install SharePointPnPPowerShellOnline module?

If you want to install the legacy SharePointPnPPowerShellOnline module for backward compatibility or to manage SharePoint On-premises versions, use: “Install-Module SharePointPnPPowerShellOnline”
More info: How to Connect to SharePoint Online using PnP PowerShell?

Is PnP PowerShell different from the SharePoint Online Management Shell?

Yes, PnP PowerShell and the SharePoint Online Management Shell are different. The SharePoint Online Management Shell is a set of cmdlets for managing SharePoint Online specifically, provided by Microsoft. In contrast, PnP PowerShell offers a broader range of community-supported commands that often provide more functionality and flexibility.

Can I use PnP PowerShell to manage Microsoft Teams?

Yes, PnP PowerShell includes cmdlets for managing Microsoft Teams, allowing you to automate tasks such as creating teams, adding members, and configuring settings. It provides a convenient way to manage Teams alongside SharePoint and other Microsoft 365 services.

Salaudeen Rajack

Salaudeen Rajack - Information Technology Expert with Two-decades of hands-on experience, specializing in SharePoint, PowerShell, Microsoft 365, and related products. He has held various positions including SharePoint Architect, Administrator, Developer and consultant, has helped many organizations to implement and optimize SharePoint solutions. Known for his deep technical expertise, He's passionate about sharing the knowledge and insights to help others, through the real-world articles!

19 thoughts on “Install the PnP PowerShell Module for SharePoint Online

  • Thanks Salaudeen . I always like your blog – very helpful. I got this error when I try to install offline: Install-Package C:\Source\pnp.powershell.2.2.0.nupkg
    Install-Package: Object reference not set to an instance of an object. How can I fix it

    Reply
  • Trying to install but is not working. Run as administrator, ran “Install-Module PnP.PowerShell”, then ran ‘Register-PNPManagementShellAccess” but this is not recognized. Tried uninstalling any current versions, again, get an error stating no match was found. Tried “Install-Package C:\Path\File.nupkg”, no match found. At a loss here.

    Reply
  • Why even installing the PNP package, when I try to find any cmdlet, none appears? Even the ones in this guide when I execute then, an Not recognized cmdlet error is shown.

    Reply
      • Already did but didn’t worked. Already updated the PS and tried even in W11 and WS 2019.

        Reply
  • Hi Salaudeen Rajack, Thank you so much for providing the PnP scripts… it is the only resource I can relay to solve my PnP queries(almost all) thanks again.
    Well, some time ago I got some issue with my machine that left me in the situation of re-install the window anyway. Now, I am trying to install my PnP module again and it’s not allowing me to do so, showing me an error

    “Install-Package: No match was found for the specified search criteria and module name ‘PnP.PowerShell’. Try Get-PSRepository to see all available registered module repositories.”

    on running Get-PSRepository command getting “Unable to find module repositories.”
    tried so many ways after that but no luck can you kindly help in this regard? Would be highly grateful. Thanks in anticipation.

    Reply
  • Is it possible to deploy PnP.PowerShell Version = 1.12.0 from Intune? I tried but i guess in need admin rights for that and Run this script using the logged on credentials : No doesn’t help.

    Any other solution?

    Reply
  • Thank you for this post. When I try the 3rd step, I get this
    “Register-PnPManagementShellAccess : The ‘Register-PnPManagementShellAccess’ command was found in the module
    ‘PnP.PowerShell’, but the module could not be loaded. For more information, run ‘Import-Module PnP.PowerShell’.
    At line:1 char:1
    + Register-PnPManagementShellAccess
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : ObjectNotFound: (Register-PnPManagementShellAccess:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CouldNotAutoloadMatchingModule”

    I thought it would be a good idea to Import-Module -Name “PnP.PowerShell”
    that yields:
    Import-Module : Could not load file or assembly ‘System.Management.Automation, Version=7.2.0.0, Culture=neutral,
    PublicKeyToken=31bf3856ad364e35’ or one of its dependencies. The system cannot find the file specified.
    At line:1 char:1
    + Import-Module -Name “PnP.PowerShell”
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : NotSpecified: (:) [Import-Module], FileNotFoundException
    + FullyQualifiedErrorId : System.IO.FileNotFoundException,Microsoft.PowerShell.Commands.ImportModuleCommand

    Reply
  • Is it mandatory to register an Azure AD Application and Grant Access to the tenant? Or being a sharepoint admin and have installed PnP Powershell is enough to run some of the scripts?

    Reply
    • Yes, That’s mandatory! Because of the New PnP.PowerShell module uses the Application ID from Azure AD. If you are not a Tenant Admin, You can provide the Consent URL to the Admin and get the rights granted.

      Reply
      • We are getting the authorisation request each time even though the Tenant Admin has authorised the module across the tenant. Any ideas what we’ve missed?

        Thanks

        Reply
  • i am getting error when trying to do offline installation install-package Install-Package C:\install\pnp.powershell.1.12.0.nupkg -Verbose
    Install-Package : Package ‘PnP.PowerShell’ failed to install.
    At line:1 char:1
    + Install-Package C:\install\pnp.powershell.1.12.0.nupkg -Verbose
    + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo : InvalidResult: (PnP.PowerShell:String) [Install-Package], Exception
    + FullyQualifiedErrorId : PackageFailedInstallOrDownload,Microsoft.PowerShell.PackageManagement.Cmdlets.InstallPackage

    Reply
  • The command you have to get version and to remove are the same.

    Reply
  • The version 1.11.0 of PnP.Powershell is extremely buggy and broken. It does not even match documentation.
    Ex: Remove-PnPWeb -Identity (Most used to be able to use -URL, which was removed. Documentation for -Identity parameter states one can use the name not the GUID ID for it, but it will never find it)
    Been trying to figure out a way to downgrade to 1.10.0 to no avail.

    Reply
  • Thanks very much for all you do, your site has saved me many times over. I am wondering if you have ever come across this error when registering PnP PowerShell though. “Authentication failed.
    You did not consent for the PnP Management Shell Application for use by PnP PowerShell. Feel free to close this browser window.
    Error details: error invalid_client error_description:AADSTS650052: The app is trying to access a service ‘00000007-0000-0000-c000-000000000000′(Dataverse) that your organization ‘0a6e4b53-5fe9-41b3-b7e3-434ff1783940’ lacks a service principal for. Contact your IT Admin to review the configuration of your service subscriptions or consent to the application in order to create the required service principal. ” I have been searching for hours with no luck.

    Reply
  • Pingback:

  • Thank you so much for posting this!!! I was finally able to get my SharePoint 2016 on-prem server to connect to SharePoint Online! Now I can run scripts to sync data between them where needed!

    Reply

Leave a Reply

Your email address will not be published. Required fields are marked *