|
1 | 1 | --- |
2 | | -title: SharePoint Server Cmdlets |
| 2 | +description: Learn about the Microsoft.SharePoint.Powershell module, which contains cmdlets for managing SharePoint Server. |
| 3 | +title: Overview of the Microsoft.SharePoint.Powershell module |
3 | 4 | ms.service: sharepoint-powershell |
4 | 5 | --- |
5 | 6 |
|
6 | | -# SharePoint Server Cmdlets |
| 7 | +# Overview of the Microsoft.SharePoint.Powershell module |
7 | 8 |
|
8 | | -For a listing of the SharePoint Server cmdlets, see [SharePoint Server cmdlets](xref:SharePointServer) |
| 9 | +For a listing of the SharePoint Server cmdlets, see [Microsoft.SharePoint.Powershell cmdlets][04]. |
9 | 10 |
|
10 | 11 | ## Accessing PowerShell for SharePoint Server |
11 | 12 |
|
12 | | -After you install SharePoint Server, applicable PowerShell cmdlets are available in the SharePoint 2016 Management Shell. You can manage most aspects of SharePoint Server in the SharePoint Management Shell. You can create new site collections, web applications, user accounts, service applications, proxies, and more. Commands that you type in the SharePoint Management Shell return SharePoint objects that are based on the Microsoft .NET Framework. You can apply these objects as input to subsequent commands or store the objects in local variables for later use. |
| 13 | +After you install SharePoint Server, applicable PowerShell cmdlets are available in the SharePoint |
| 14 | +2016 Management Shell. You can manage most aspects of SharePoint Server in the SharePoint Management |
| 15 | +Shell. You can create new site collections, web applications, user accounts, service applications, |
| 16 | +proxies, and more. Commands that you type in the SharePoint Management Shell return SharePoint |
| 17 | +objects that are based on the Microsoft .NET Framework. You can apply these objects as input to |
| 18 | +subsequent commands or store the objects in local variables for later use. |
13 | 19 |
|
14 | | -With the SharePoint Management Shell, you do not have to register the snap-in that contains the cmdlets. Registration of the Microsoft.SharePoint.PowerShell.dll module for SharePoint Server cmdlets is automatic, as a result of the **Add-PSSnapin Microsoft.SharePoint.PowerShell** line in the SharePoint.ps1 file that is located in %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\<version>\Config\PowerShell\Registration, where version "15" equals SharePoint Server 2013, and version "16" equals SharePoint Server 2016. To use the PowerShell console, you must register this snap-in manually. |
| 20 | +With the SharePoint Management Shell, you don't have to register the snap-in that contains the |
| 21 | +cmdlets. Registration is handled by the `Add-PSSnapin Microsoft.SharePoint.PowerShell` line in the |
| 22 | +`SharePoint.ps1` file. This file is located in |
| 23 | +`%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\<version>\Config\PowerShell\Registration` folder. |
15 | 24 |
|
16 | | -Whether you use the SharePoint Management Shell or the PowerShell console, you can also load additional snap-ins. |
| 25 | +- `<version>` 15 equals SharePoint Server 2013 |
| 26 | +- and `<version>` 16 equals SharePoint Server 2016 |
| 27 | + |
| 28 | +To use the PowerShell console, you must register this snap-in manually. |
| 29 | + |
| 30 | +Whether you use the SharePoint Management Shell or the PowerShell console, you can also load |
| 31 | +additional snap-ins and modules. |
17 | 32 |
|
18 | 33 | > [!NOTE] |
19 | | -> The SharePoint Management Shell and the PowerShell console also differ in the use of the **ReuseThread** option, which defines how the threading model is used. The SharePoint Management Shell's use is defined by this line, {Host.Runspace.ThreadOptions = "ReuseThread"}, which is in the SharePoint.ps1 file. For more information, see [PS Thread Options](/dotnet/api/system.management.automation.runspaces.psthreadoptions). |
| 34 | +> The SharePoint Management Shell and the PowerShell console also differ in the use of the |
| 35 | +> **ReuseThread** option, which defines how the threading model is used. The SharePoint Management |
| 36 | +> Shell's use is defined by this line, `{Host.Runspace.ThreadOptions = "ReuseThread"}`, which is in |
| 37 | +> the `SharePoint.ps1` file. For more information, see |
| 38 | +> [PS Thread Options][01]. |
20 | 39 |
|
21 | 40 | ## Permissions |
22 | 41 |
|
23 | | -Before you can use the Add-SPShellAdmin cmdlet to grant permissions for users to run SharePoint Server cmdlets, verify that you meet all of the following minimum requirements: |
| 42 | +Before you can use the `Add-SPShellAdmin` cmdlet to grant permissions for users to run SharePoint |
| 43 | +Server cmdlets, verify that you meet all of the following minimum requirements: |
24 | 44 |
|
25 | | -* You must have membership in the **securityadmin** fixed server role on the SQL Server instance. |
26 | | -* You must be a member of the Administrators group on the server on which you are running the PowerShell cmdlet. |
| 45 | +- You must have membership in the **SecurityAdmin** fixed server role on the SQL Server instance. |
| 46 | +- You must be a member of the Administrators group on the server on which you are running the |
| 47 | + PowerShell cmdlet. |
27 | 48 |
|
28 | 49 | > [!NOTE] |
29 | | -> If these permissions are not satisfied, contact your Setup administrator or SQL Server administrator to request these permissions. |
| 50 | +> If these permissions aren't satisfied, contact your Setup administrator or SQL Server |
| 51 | +> administrator to request these permissions. |
30 | 52 |
|
31 | | -For additional information about PowerShell permissions, see [Add-SPShellAdmin](xref:SharePointServer.Add-SPShellAdmin). |
| 53 | +For additional information about PowerShell permissions, see [Add-SPShellAdmin][05]. |
32 | 54 |
|
33 | | -If you do not have membership in the **SharePoint_Shell_Access** role or **WSS_Admin_WPG** local group, use the **Add-SPShellAdmin** cmdlet to add the **WSS_Admin_WPG** group in all front-end web servers in the SharePoint farm and the **SharePoint_Shell_Access** role. If the SQL Server database does not have a **SharePoint_Shell_Access** role, the role is automatically created when you run the **Add-SPShellAdmin** cmdlet. After you run the **Add-SPShellAdmin** cmdlet, users can run SharePoint PowerShell cmdlets in a multiple-server farm environment. |
| 55 | +If you don't have membership in the **SharePoint_Shell_Access** role or **WSS_Admin_WPG** local |
| 56 | +group, use the `Add-SPShellAdmin` cmdlet to add the **WSS_Admin_WPG** group in all front-end web |
| 57 | +servers in the SharePoint farm and the **SharePoint_Shell_Access** role. If the SQL Server database |
| 58 | +doesn't have a **SharePoint_Shell_Access** role, the role is automatically created when you run the |
| 59 | +`Add-SPShellAdmin` cmdlet. After you run the `Add-SPShellAdmin` cmdlet, users can run SharePoint |
| 60 | +PowerShell cmdlets in a multiple-server farm environment. |
34 | 61 |
|
35 | 62 | > [!NOTE] |
36 | | -> When you install SharePoint Server, the user account from which you run the installation is granted the appropriate permissions to run PowerShell cmdlets. If any users have not been added to run a PowerShell cmdlet, you can use the **Add-SPShellAdmin** cmdlet to add them. |
| 63 | +> When you install SharePoint Server, the user account from which you run the installation is |
| 64 | +> granted the appropriate permissions to run PowerShell cmdlets. If any users haven't been added to |
| 65 | +> run a PowerShell cmdlet, you can use the `Add-SPShellAdmin` cmdlet to add them. |
37 | 66 |
|
38 | | -To see a list of all of the **SPShellAdmin** cmdlets, from a PowerShell command prompt, type _Get-Command -Noun SPShellAdmin_. |
| 67 | +To see a list of all **SPShellAdmin** cmdlets, from a PowerShell command prompt, type |
| 68 | +`Get-Command -Noun SPShellAdmin`. |
39 | 69 |
|
40 | 70 | ## Scripts and execution policies |
41 | 71 |
|
42 | | -Although you can use Microsoft PowerShell to perform a single administrative task, you can also use a script to automate a series of tasks. A script is a text file that contains one or more Microsoft PowerShell commands. Microsoft PowerShell scripts have a .ps1 file name extension. |
43 | | - |
44 | | -To run scripts, the minimum required execution policy for SharePoint Server is **RemoteSigned**, although the default policy for PowerShell is Restricted. If the policy is left as Restricted, the SharePoint Management Shell will change the policy for PowerShell to RemoteSigned. This means that you must select **Run as administrator** to start the SharePoint Management Shell with elevated administrative permission. This change will apply to all PowerShell sessions. For more information, see [ExecutionPolicy Enumeration](/dotnet/api/microsoft.powershell.executionpolicy). |
45 | | - |
46 | | -For additional information about scripts and execution policies, see [about_scripts](/powershell/module/microsoft.powershell.core/about/about_scripts) and [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). |
| 72 | +Although you can use Microsoft PowerShell to perform a single administrative task, you can also use |
| 73 | +a script to automate a series of tasks. A script is a text file that contains one or more Microsoft |
| 74 | +PowerShell commands. Microsoft PowerShell scripts have a `.ps1` file name extension. |
| 75 | + |
| 76 | +To run scripts, the minimum required execution policy for SharePoint Server is **RemoteSigned**, |
| 77 | +although the default policy for PowerShell is **Restricted**. If the policy is left as |
| 78 | +**Restricted**, the SharePoint Management Shell changes the policy for PowerShell to |
| 79 | +**RemoteSigned**. This means that you must select **Run as administrator** to start the SharePoint |
| 80 | +Management Shell with elevated administrative permission. This change applies to all PowerShell |
| 81 | +sessions. For more information about scripts and execution policies, see [about_scripts][03] and |
| 82 | +[About Execution Policies][02]. |
| 83 | + |
| 84 | +<!-- link references --> |
| 85 | +[01]: /dotnet/api/system.management.automation.runspaces.psthreadoptions |
| 86 | +[02]: /powershell/module/microsoft.powershell.core/about/about_execution_policies |
| 87 | +[03]: /powershell/module/microsoft.powershell.core/about/about_scripts |
| 88 | +[04]: /powershell/module/microsoft.sharepoint.powershell |
| 89 | +[05]: /powershell/module/microsoft.sharepoint.powershell/add-spshelladmin?view=sharepoint-ps&preserve-view=true |
0 commit comments