SPShellAdmins

SPShellAdmins

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	Name for the config, used for administration purposes
Members	Write	String[]	Exact list of accounts that will have to get Shell Admin permissions
MembersToInclude	Write	String[]	List of all accounts that must be in the Shell Admins group
MembersToExclude	Write	String[]	List of all accounts that are not allowed to have Shell Admin permissions
Databases	Write	String[]	Shell Admin configuration of Databases
AllDatabases	Write	Boolean	Specify if all databases must get the same config as the general config
ExcludeDatabases	Write	String[]	Specify all databases that must be excluded from AllDatabases
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed

This resource is used to manage the users with Shell Admin permissions. There are a number of approaches to how this can be implemented. The "Members" property will set a specific list of members for the group, making sure that every user/group in the list is in the group and all others that are members and who are not in this list will be removed. The "MembersToInclude" and "MembersToExclude" properties will allow you to control a specific set of users to add or remove, without changing any other members that are in the group already that may not be specified here, allowing for some manual management outside of this configuration resource. The "ContentDatabases" and "AllContentDatabases" properties will allow you to control the permissions on Content Databases.

Requirements:

• At least one of the Members, MemberToInclude or MembersToExclude properties needs to be specified.
• Do not combine the Members property with the MemberToInclude and MembersToExclude properties.
• Do not combine the ContentDatabase property with the AllContentDatabases property.

Required permissions:

The documentation of the Shell Admin cmdlets states that you need the following permissions to successfully run this resource: "When you run this cmdlet to add a user to the SharePoint_Shell_Access role, you must have membership in the securityadmin fixed server role on the SQL Server instance, membership in the db_owner fixed database role on all affected databases, and local administrative permission on the local computer." https://docs.microsoft.com/en-us/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps

Notes: 1.) If a content database is created using the Central Admin, the farm account is the owner of that content database in SQL Server. When this is true, you cannot add it to the Shell Admins (common for AllContentDatabases parameter) and the resource will throw an error. Workaround: Change database owner in SQL

Examples

Example 1

This example gives admin access to the specified users for the local farm as well as all content databases in the local farm.

    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPShellAdmins ShellAdmins
            {
                Name         = "Shell Admins"
                Members      = "CONTOSO\user1", "CONTOSO\user2"
                AllDatabases = $true
            }
        }
    }

Example 2

This example gives admin access to the specified users for the local farm as well as all content databases in the local farm.

    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPShellAdmins ShellAdmins
            {
                Name         = "Shell Admins"
                Members      = "CONTOSO\user1", "CONTOSO\user2"
                Databases    = @(
                    @(MSFT_SPDatabasePermissions {
                        Name = "SharePoint_Content_1"
                        Members = "CONTOSO\user2", "CONTOSO\user3"
                    })
                    @(MSFT_SPDatabasePermissions {
                        Name = "SharePoint_Content_2"
                        Members = "CONTOSO\user3", "CONTOSO\user4"
                    })
                )
            }
        }
    }

Example 3

This example gives admin access to the specified users for the local farm as well as all content databases in the local farm, with the exception of database WSS_Content_Portal.

    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPShellAdmins ShellAdmins
            {
                Name             = "Shell Admins"
                Members          = "CONTOSO\user1", "CONTOSO\user2"
                AllDatabases     = $true
                ExcludeDatabases = "WSS_Content_Portal"
            }
        }
    }