Skip to content

Commit 978f0e0

Browse files
committed
Updated help files
1 parent 672e6cb commit 978f0e0

File tree

5 files changed

+148
-11
lines changed

5 files changed

+148
-11
lines changed

Modules/SharePointDsc/en-US/about_SPInstall.help.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,11 @@
1717
is not supported. For examples to install SharePoint Foundation using DSC, see:
1818
https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3)
1919

20-
## Installing from network locations
21-
22-
If you wish to install SharePoint from a network location this can
23-
be done, however you must disable User Account Control (UAC) on the server
24-
to allow DSC to run the executable from a remote location, and also set
25-
the PsDscRunAsCredential value to run as an account with local admin
26-
permissions as well as read access to the network location.
27-
28-
It is *not recommended* to disable UAC for security reasons. The recommended
29-
approach is to copy the installation media to the local nodes first and
30-
then execute the installation from there.
20+
NOTE 2:
21+
When files are downloaded from the Internet, a Zone.Identifier alternate data
22+
stream is added to indicate that the file is potentially from an unsafe source.
23+
To use these files, make sure you first unblock them using Unblock-File.
24+
SPInstall will throw an error when it detects the file is blocked.
3125

3226
## Multilingual support
3327

Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
You have to extract this package before installing, using the following command:
1818
.\serverlanguagepack.exe /extract:[Extract Folder]
1919

20+
NOTE:
21+
When files are downloaded from the Internet, a Zone.Identifier alternate data
22+
stream is added to indicate that the file is potentially from an unsafe source.
23+
To use these files, make sure you first unblock them using Unblock-File.
24+
SPInstallLanguagePack will throw an error when it detects the file is blocked.
25+
2026
.PARAMETER BinaryDir
2127
Key - String
2228
The directory that contains all of the SharePoint binaries

Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@
5353
Write - boolean
5454
Should this search service application be a cloud based service app
5555

56+
.PARAMETER AlertsEnabled
57+
Write - boolean
58+
Should alerts be enabled for this search service application
59+
5660
.PARAMETER Ensure
5761
Write - string
5862
Allowed values: Present, Absent

Modules/SharePointDsc/en-US/about_SPSelfServiceSiteCreation.help.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,19 @@
6868
Write - string
6969
Specifies a custom form URL to use for Self Service Site Creation. This is only used when CreateIndividualSite is true. Must be an absolute URL or empty to use built in form (_layouts/_layouts/15/scsignup.aspx)
7070

71+
.PARAMETER ManagedPath
72+
Write - string
73+
Specifies the managed path in which site collections have to be created (SP2019 only)
74+
75+
.PARAMETER AlternateUrl
76+
Write - string
77+
Specifies the URL of the web application in which site collections have to be created (SP2019 only)
78+
79+
.PARAMETER UserExperienceVersion
80+
Write - string
81+
Allowed values: Modern, Classic, Latest
82+
Specifies the if the site collection has to be created as modern or classic site (SP2019 only)
83+
7184
.PARAMETER InstallAccount
7285
Write - String
7386
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
@@ -153,3 +166,29 @@
153166
}
154167

155168

169+
.EXAMPLE
170+
This example shows how to configure self-service site creation with a custom form for a web application
171+
172+
173+
Configuration Example
174+
{
175+
param(
176+
[Parameter(Mandatory = $true)]
177+
[PSCredential]
178+
$SetupAccount
179+
)
180+
Import-DscResource -ModuleName SharePointDsc
181+
182+
node localhost {
183+
SPSelfServiceSiteCreation SSC
184+
{
185+
WebAppUrl = "http://example.contoso.local"
186+
Enabled = $true
187+
ManagedPath = "sites"
188+
UserExperienceVersion = "Modern"
189+
PsDscRunAsCredential = $SetupAccount
190+
}
191+
}
192+
}
193+
194+
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
.NAME
2+
SPSitePropertyBag
3+
4+
# Description
5+
6+
**Type:** Distributed
7+
**Requires CredSSP:** No
8+
9+
This resource is used to work with SharePoint Property Bags at the site
10+
collection level. The account that runs this resource (PsDscRunAsCredential
11+
or InstallAccount) must be a site collection administrator.
12+
13+
The default value for the Ensure parameter is Present. When not specifying
14+
this parameter, the property bag is configured.
15+
16+
.PARAMETER Url
17+
Key - string
18+
The URL of the site collection
19+
20+
.PARAMETER Key
21+
Key - string
22+
The key of the SPSite property
23+
24+
.PARAMETER Value
25+
Write - String
26+
Value of the SPSite property
27+
28+
.PARAMETER Ensure
29+
Write - string
30+
Allowed values: Present, Absent
31+
Set to present to ensure the SPSite property exists, or absent to ensure it is removed
32+
33+
.PARAMETER InstallAccount
34+
Write - String
35+
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
36+
37+
38+
.EXAMPLE
39+
This example shows how add property bag value in a site collection.
40+
41+
42+
Configuration Example
43+
{
44+
param
45+
(
46+
[Parameter(Mandatory = $true)]
47+
[PSCredential]
48+
$SetupAccount
49+
)
50+
51+
Import-DscResource -ModuleName SharePointDsc
52+
53+
node localhost
54+
{
55+
SPSitePropertyBag Site_APPCodeProperty
56+
{
57+
PsDscRunAsCredential = $SetupAccount
58+
Url = "https://web.contoso.com"
59+
Key = "KeyToAdd"
60+
Value = "ValueToAddOrModify"
61+
Ensure = "Present"
62+
}
63+
}
64+
}
65+
66+
67+
.EXAMPLE
68+
This example shows how remove a property bag value in a site collection.
69+
70+
71+
Configuration Example
72+
{
73+
param
74+
(
75+
[Parameter(Mandatory = $true)]
76+
[PSCredential]
77+
$SetupAccount
78+
)
79+
80+
Import-DscResource -ModuleName SharePointDsc
81+
82+
node localhost
83+
{
84+
SPSitePropertyBag Site_APPCodeProperty
85+
{
86+
PsDscRunAsCredential = $SetupAccount
87+
Url = "https://web.contoso.com"
88+
Key = "KeyToRemove"
89+
Ensure = "Absent"
90+
}
91+
}
92+
}
93+
94+

0 commit comments

Comments
 (0)