en-US/about_SPMinRoleCompliance.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.NAME
    SPMinRoleCompliance

# Description
    
    **Type:** Utility
    **Requires CredSSP:** No
    
    This resource will help manage compliance of MinRole based servers. Each time
    the resource runs it will investigate which service instances should be running
    based on the role of servers anywhere in the farm, and if they are not in a
    compliant state it will tell SharePoint to create timer jobs to make the
    necesssary modifications to make the farm compliant again.
    
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'

.PARAMETER State
    Required - string
    Allowed values: Compliant,  NonCompliant
    Should the state be set to compliant

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example shows how to ensure the farm is always compliant with MinRole settings


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

        node localhost {
            SPMinRoleCompliance MinRoleCompliance
            {
                IsSingleInstance     = "Yes"
                State                = "Compliant"
                PSDscRunAsCredential = $SetupAccount
            }
        }
    }