en-US/about_SPFarmSolution.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
.NAME
    SPFarmSolution
 
# Description
     
    This resource is used to make sure that a specific farm solution is either
    present or absent in a farm. The solution can be deployed to one or more web
    application passing an array of URL's to the WebApplications property. If the
    solution contains resources scoped for web applications and no WebApplications
    are specified, the solution will be deployed to all web applications. If the
    solution does not contain resources scoped for web applications the property
     
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the solution is deployed.
     
.PARAMETER Name
    Key - string
    The filename of the WSP package
 
.PARAMETER LiteralPath
    Required - string
    The full path to the WSP file
 
.PARAMETER WebApplications
    Write - string
    A list of the web applications to deploy this to
 
.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the WSP should be deployed, or Absent if it should be removed
 
.PARAMETER Version
    Write - string
    The version of the package that is being modified
 
.PARAMETER Deployed
    Write - Boolean
    Should the solution be deployed to the farm, or just installed to the farm
 
.PARAMETER SolutionLevel
    Write - string
    Allowed values: 14, 15, All
    What compatability level should the WSP be deployed as?
 
.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 deploy a WSP to specific web applications.
 
 
    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc
 
        node localhost {
            SPFarmSolution SampleWsp
            {
                Name = "MySolution.wsp"
                LiteralPath = "C:\src\MySolution.wsp"
                Ensure = "Present"
                Version = "1.0.0"
                WebApplications = @("http://collaboration", "http://mysites")
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }