-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/PowerShell/SharePointDsc …
…into release-3.0
- v5.6.0-preview0001
- v5.5.0
- v5.5.0-preview0003
- v5.5.0-preview0002
- v5.5.0-preview0001
- v5.4.0
- v5.3.1-preview0003
- v5.3.1-preview0002
- v5.3.1-preview0001
- v5.3.0
- v5.2.1-preview0001
- v5.2.0
- v5.2.0-preview0004
- v5.2.0-preview0003
- v5.2.0-preview0002
- v5.2.0-preview0001
- v5.1.1-preview0001
- v5.1.0
- v5.1.0-preview0006
- v5.1.0-preview0005
- v5.1.0-preview0004
- v5.1.0-preview0003
- v5.1.0-preview0002
- v5.1.0-preview0001
- v5.0.1-preview0002
- v5.0.1-preview0001
- v5.0.0
- v5.0.0-preview0001
- v4.9.0
- v4.8.1-preview0003
- v4.8.1-preview0002
- v4.8.1-preview0001
- v4.8.0
- v4.8.0-preview0006
- v4.8.0-preview0005
- v4.8.0-preview0004
- v4.8.0-preview0003
- v4.8.0-preview0002
- v4.8.0-preview0001
- v4.7.0
- v4.6.1-preview0004
- v4.6.1-preview0003
- v4.6.1-preview0002
- v4.6.1-preview0001
- v4.6.0
- v4.6.0-preview0002
- v4.6.0-preview0001
- v4.5.1
- v4.5.1-preview0001
- v4.5.0
- v4.5.0-preview0002
- v4.5.0-preview0001
- v4.4.1-preview0002
- v4.4.1-preview0001
- v4.4.0
- v4.4.0-preview0004
- v4.4.0-preview0003
- v4.4.0-preview0002
- v4.4.0-preview0001
- v4.3.1-preview0001
- v4.3.0
- v4.3.0-preview0003
- v4.3.0-preview0002
- v4.3.0-preview0001
- v4.2.1-preview0003
- v4.2.1-preview0002
- v4.2.1-preview0001
- v4.2.0
- v4.2.0-preview0001
- v4.1.1
- v4.1.0
- v4.1.0-preview0003
- v4.1.0-preview0002
- v4.1.0-preview0001
- v4.0.1-preview0001
- v4.0.0
- v4.0.0-preview0004
- v4.0.0-preview0003
- v4.0.0-preview0002
- v4.0.0-preview0001
- v3.9.0-preview0001
- v3.8.0
- v3.8.0-preview0006
- v3.8.0-preview0005
- v3.8.0-preview0004
- v3.8.0-preview0003
- v3.8.0-preview0002
- v3.8.0-preview0001
- v3.7.0
- v3.6.0
- v3.5.0
- v3.4.0
- v3.3.0
- v3.2.0
- v3.1.0
- v3.0.0
- 3.7.0.0-PSGallery
- 3.6.0.0-PSGallery
- 3.5.0.0-PSGallery
- 3.4.0.0-PSGallery
- 3.3.0.0-PSGallery
- 3.2.0.0-PSGallery
- 3.1.0.0-PSGallery
- 3.0.0.0-PSGallery
Showing
114 changed files
with
11,484 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
.NAME | ||
SPAccessServiceApp | ||
|
||
# Description | ||
|
||
**Type:** Distributed | ||
|
||
This resource is responsible for creating Access Services Application instances | ||
within the local SharePoint farm. The resource will provision and configure the | ||
Access Services Service Application. | ||
|
||
The default value for the Ensure parameter is Present. When not specifying this | ||
parameter, the service application is provisioned. | ||
|
||
.PARAMETER Name | ||
Key - string | ||
The name of the service application | ||
|
||
.PARAMETER ApplicationPool | ||
Required - string | ||
The name of the application pool to run the service app in | ||
|
||
.PARAMETER DatabaseServer | ||
Required - string | ||
The name of the database server to host Access Services databases | ||
|
||
.PARAMETER Ensure | ||
Write - string | ||
Allowed values: Present, Absent | ||
Present ensures service app exists, absent ensures it is removed | ||
|
||
.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 Access Services 2013 to the local SharePoint farm. | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAccessServiceApp AccessServices | ||
{ | ||
Name = "Access Services Service Application" | ||
ApplicationPool = "SharePoint Service Applications" | ||
DatabaseServer = "SQL.contoso.local\SQLINSTANCE" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
||
.EXAMPLE | ||
|
||
This example shows how to remove a specific Access Services 2013 from the local | ||
SharePoint farm. Because Application pool and database server are both required | ||
parameters, but are not acutally needed to remove the app, any text value can | ||
be supplied for these as they will be ignored. | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAccessServiceApp AccessServices | ||
{ | ||
Name = "Access Services Service Application" | ||
ApplicationPool = "n/a" | ||
DatabaseServer = "n/a" | ||
Ensure = "Absent" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
117 changes: 117 additions & 0 deletions
117
Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
.NAME | ||
SPAlternateUrl | ||
|
||
# Description | ||
|
||
**Type:** Distributed | ||
|
||
This resource is used to define an alternate access mapping URL for a specified | ||
web application. These can be assigned to specific zones for each web | ||
application. Alternatively a URL can be removed from a zone to ensure that it | ||
will remain empty and have no alternate URL. | ||
|
||
The default value for the Ensure parameter is Present. When not specifying this | ||
parameter, the setting is configured. | ||
|
||
## Central Administration | ||
|
||
To select the Central Administration site, use the following command to retrieve | ||
the correct web application name: | ||
(Get-SPWebApplication -IncludeCentralAdministration | Where-Object { | ||
$_.IsAdministrationWebApplication | ||
}).DisplayName | ||
|
||
To update the existing Default Zone AAM for Central Administration (e.g. to | ||
implement HTTPS), use the above command to retrieve the web application name | ||
(by default, it will be "SharePoint Central Administration v4") and specify | ||
"Default" as the Zone. If you wish to add AAM's instead, you may use the other | ||
zones to do so. | ||
|
||
Using SPAlternateUrl to update the Default Zone AAM for Central Administration | ||
will update the AAM in SharePoint as well as the CentralAdministrationUrl value | ||
in the registry. It will not, however, update bindings in IIS. It is recommended | ||
to use the xWebsite resource from the xWebAdministration module to configure the | ||
appropriate bindings in IIS. | ||
|
||
.PARAMETER WebAppName | ||
Key - String | ||
The name of the web application to apply the alternate URL to | ||
|
||
.PARAMETER Zone | ||
Key - String | ||
Allowed values: Default, Intranet, Extranet, Custom, Internet | ||
The Zone to use for the alternate URL | ||
|
||
.PARAMETER Url | ||
Key - String | ||
The new alternate URL | ||
|
||
.PARAMETER Internal | ||
Write - Boolean | ||
Specifies if the URL has to be configured as internal | ||
|
||
.PARAMETER Ensure | ||
Write - string | ||
Allowed values: Present, Absent | ||
Present ensures the URL is set for this zone on this web app, Absent ensures it is removed | ||
|
||
.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 add a new alternate URL to a specific web application | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAlternateUrl CentralAdminAAM | ||
{ | ||
WebAppName = "SharePoint - www.domain.com80" | ||
Zone = "Intranet" | ||
Url = "https://admin.sharepoint.contoso.com" | ||
Internal = $false | ||
Ensure = "Present" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
||
.EXAMPLE | ||
This example shows how to remove an alternate URL from a specified zone for a specific | ||
web application. | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAlternateUrl CentralAdminAAM | ||
{ | ||
WebAppName = "SharePoint - www.domain.com80" | ||
Zone = "Intranet" | ||
Url = "http://www.externaldomain.com" | ||
Internal = $false | ||
Ensure = "Absent" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
67 changes: 67 additions & 0 deletions
67
Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
.NAME | ||
SPAntivirusSettings | ||
|
||
# Description | ||
|
||
**Type:** Distributed | ||
|
||
This resource is used to set the global antivirus settings for the local farm. | ||
These settings will be used to control the behavior of an external anti-virus | ||
scanning tool that is able to integrate with SharePoint. Note that this will | ||
not scan documents for viruses on it's own, an external tool still needs to be | ||
installed on the servers that integrates with SharePoint. | ||
|
||
.PARAMETER ScanOnDownload | ||
Key - Boolean | ||
Should documents be scanned before being downloaded | ||
|
||
.PARAMETER ScanOnUpload | ||
Write - Boolean | ||
Should documents be scanned on upload | ||
|
||
.PARAMETER AllowDownloadInfected | ||
Write - Boolean | ||
Should documents that are infected be allowed to be downloaded | ||
|
||
.PARAMETER AttemptToClean | ||
Write - Boolean | ||
Should infected documents be handed to the AV engine to attempt cleaning | ||
|
||
.PARAMETER TimeoutDuration | ||
Write - Uint16 | ||
What is the timeout for an AV scan in seconds | ||
|
||
.PARAMETER NumberOfThreads | ||
Write - Uint16 | ||
How many concurrent threads should the AV engine be able to run on a server | ||
|
||
.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 apply specific anti-virus configuration to the farm | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAntivirusSettings AVSettings | ||
{ | ||
ScanOnDownload = $true | ||
ScanOnUpload = $true | ||
AllowDownloadInfected = $false | ||
AttemptToClean = $false | ||
} | ||
} | ||
} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.NAME | ||
SPAppCatalog | ||
|
||
# Description | ||
|
||
**Type:** Distributed | ||
|
||
This resource will ensure that a specific site collection is marked as the app | ||
catalog for the web application that the site is in. The catalog site needs to | ||
have been created using the correct template (APPCATALOG#0). | ||
|
||
This resource should NOT be run using the farm account. The resource will | ||
retrieve the farm credentials from SharePoint and use that to update the | ||
AppCatalog. This does mean it requires CredSSP to be setup! | ||
|
||
.PARAMETER SiteUrl | ||
Key - string | ||
The URL of the site collection that will be the app catalog for the web app that it is in | ||
|
||
.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 configure the AppCatalog in the farm | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAppCatalog MainAppCatalog | ||
{ | ||
SiteUrl = "https://content.sharepoint.contoso.com/sites/AppCatalog" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.NAME | ||
SPAppDomain | ||
|
||
# Description | ||
|
||
**Type:** Distributed | ||
|
||
This resource will set the value for the app domain settings at the farm level. | ||
You can set the domain name and the prefix that is to be used for app URLs. | ||
|
||
.PARAMETER AppDomain | ||
Key - string | ||
The domain name for apps to use in this farm | ||
|
||
.PARAMETER Prefix | ||
Required - string | ||
The prefix to go on to app URLs | ||
|
||
.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 apply app URLs to the current farm. | ||
|
||
|
||
Configuration Example | ||
{ | ||
param( | ||
[Parameter(Mandatory = $true)] | ||
[PSCredential] | ||
$SetupAccount | ||
) | ||
Import-DscResource -ModuleName SharePointDsc | ||
|
||
node localhost { | ||
SPAppDomain LocalFarmAppUrls | ||
{ | ||
AppDomain = "contosointranetapps.com" | ||
Prefix = "app" | ||
PsDscRunAsCredential = $SetupAccount | ||
} | ||
} | ||
} | ||
|
||
|
Oops, something went wrong.