en-US/about_SPFeature.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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
.NAME
    SPFeature

# Description
    
    **Type:** Distributed
    
    This resource is used to make sure that a specific feature is either enabled
    or disabled at a given URL/scope. The Ensure property will dictate if the
    feature should be on or off. The name property is the name of the feature
    based on its folder name in the FEATURES folder in the SharePoint hive
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the feature is enabled.
    
.PARAMETER Name
    Key - string
    The name of the feature

.PARAMETER FeatureScope
    Required - string
    Allowed values: Farm, WebApplication, Site, Web
    The scope to change the feature at - Farm, WebApplication, SiteCollection or Site

.PARAMETER Url
    Key - string
    The URL to change the feature at

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the feature is to be enabled, Absent if it is to be disabled

.PARAMETER Version
    Write - string
    The version of the feature to check against

.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 enable a site collection scoped feature 


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

        node localhost {
            SPFeature EnableViewFormsLockDown
            {
                Name                 = "ViewFormPagesLockDown"
                Url                  = "http://www.contoso.com"
                FeatureScope         = "Site"
                PsDscRunAsCredential = $SetupAccount
                Version              = "1.0.0.0"     
            }
        }
    }


.EXAMPLE
    This example shows how to disable a site collection scoped feature 


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

        node localhost {
            SPFeature EnableViewFormsLockDown
            {
                Name                 = "ViewFormPagesLockDown"
                Url                  = "http://www.contoso.com"
                FeatureScope         = "Site"
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
                Version              = "1.0.0.0"     
            }
        }
    }