en-US/about_SPProjectServerLicense.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.NAME
    SPProjectServerLicense

# Description
    
    **Type:** Distributed
    **Requires CredSSP:** No
    
    This resource is used to enable a Project Server license in to a SharePoint
    2016 or 2019 farm.
    
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Should a Project Server license be enabled or disabled

.PARAMETER ProductKey
    Write - string
    What is the product key for Project Server

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


.EXAMPLE
    This example enables Project Server in the current environment


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

    node localhost {
        SPProjectServerLicense ProjectLicense
        {
            IsSingleInstance     = "Yes"
            ProductKey           = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}


.EXAMPLE
    This example disables Project Server in the current environment


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

    node localhost {
        SPProjectServerLicense ProjectLicense
        {
            IsSingleInstance     = "Yes"
            Ensure               = "Absent"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}