SharePointPnP.PowerShell Commands

Summary

This solution contains a library of PowerShell commands that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises.

Applies to

Office 365 Multi Tenant (MT)
Office 365 Dedicated (D)
SharePoint 2013 on-premises
SharePoint 2016 on-premises

Prerequisites

In order to generate the Cmdlet help you need to have the Windows Management Framework v4.0 installed, which you can download from http://www.microsoft.com/en-us/download/details.aspx?id=40855

Solution

Solution	Author(s)
SharePointPnP.PowerShell	Erwin van Hunen

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

COMMANDS INCLUDED

Navigate here for an overview of all cmdlets and their parameters

INSTALLATION

Setup files

You can download setup files from https://github.com/officedev/pnp-powershell/releases. These files will up be updated on a monthly basis.

Using the Windows Management Framework

If you main OS is Windows 10, you can run the following commands to install the PowerShell cmdlets:

SharePoint Online

Install-Module SharePointPnPPowerShellOnline -AllowClobber

SharePoint 2016

Install-Module SharePointPnPPowerShell2016 -AllowClobber

SharePoint 2013

Install-Module SharePointPnPPowerShell2013 -AllowClobber

Notice: if you installed the latest PowerShellGet from Github, you might receive an error message stating

PackageManagement\Install-Package : The version '2.8.x.x' of the module 'SharePointPnPPowerShellOnline' being installed is not catalog signed.

In order to install the cmdlets when you get this error specify the -SkipPublisherCheck switch with the Install-Module cmdlet, e.g. ```Install-Module SharePointPnPPowerShellOnline -SkipPublisherCheck -AllowClobber

Alternatively for installation on machines that have at least PowerShell v3 installed (you can find this out by opening PowerShell and running $PSVersionTable.PSVersion. The value for Major should be above 3) you can run the below command which will install PowerShell Package Management and then install the PowerShell Modules from the PowerShell Gallery

Invoke-Expression (New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/OfficeDev/PnP-PowerShell/master/Samples/Modules.Install/Install-SharePointPnPPowerShell.ps1')

If you wish to see the commands that the above will run please see the files as stored in the below locations:

Once the above has been completed you can then start to use the PowerShell Modules

Once new releases of the module are made available on the PowerShell Gallery you will be able to use the the following command to install the latest updated version

Update-Module SharePointPnPPowerShell*

This will automatically load the module after starting PowerShell 3.0.

You can check the installed PnP-PowerShell versions with the following command:

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

HOW TO USE DURING DEVELOPMENT

A build script will copy the required files to a folder in your users folder, called: C:\Users\<YourUserName>\Documents\WindowsPowerShell\Modules\SharePointPnPPowerShell<Platform>

GETTING STARTED

To use the library you first need to connect to your tenant:

Connect-PnPOnline –Url https://yoursite.sharepoint.com –Credentials (Get-Credential)

To view all cmdlets, enter

Get-Command -Module *PnP*

At the following links you will find a few videos on how to get started with the cmdlets:

SETTINGS UP CREDENTIALS

See this wiki page for more information on how to use the Windows Credential Manager to setup credentials that you can use in unattended scripts

CONTRIBUTING

If you want to contribute to this OfficeDevPnP PowerShel library, please proceed here

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

FranckyC/PnP-PowerShell