From 565c274257f4d6facdd1edda823dbcefcc2a2ba1 Mon Sep 17 00:00:00 2001 From: stehlih Date: Fri, 16 Dec 2022 15:32:11 +0100 Subject: [PATCH] Complete YAML documentation --- CHANGELOG.md | 2 +- ...onfigurationManagerDistributionGroups.adoc | 105 ++++++ doc/DscPullServerSql.adoc | 19 +- doc/README.adoc | 344 +++++++++++------- doc/RemoteDesktopCertificates.adoc | 70 ++++ doc/ScomComponents.adoc | 85 +++++ doc/ScomManagementPacks.adoc | 74 ++++ doc/ScomSettings.adoc | 71 ++++ doc/SharePointCacheAccounts.adoc | 69 ++++ doc/SharePointContentDatabases.adoc | 78 ++++ doc/SharePointManagedAccounts.adoc | 70 ++++ doc/SharePointManagedPaths.adoc | 78 ++++ doc/SharePointPrereq.adoc | 62 ++++ doc/SharePointProvisioning.adoc | 51 +++ doc/SharePointServiceAppPools.adoc | 70 ++++ doc/SharePointServiceInstances.adoc | 69 ++++ doc/SharePointSetup.adoc | 65 ++++ doc/SharePointSites.adoc | 80 ++++ doc/SharePointWebApplications.adoc | 84 +++++ doc/SqlAgentAlerts.adoc | 131 +++++++ doc/SqlAgentOperators.adoc | 117 ++++++ doc/SqlDatabaseMailSetups.adoc | 187 ++++++++++ doc/SqlScriptQueries.adoc | 163 +++++++++ doc/VSTSAgents.adoc | 73 ++++ doc/VirtualMemoryFiles.adoc | 100 +++++ doc/WebConfigProperties.adoc | 99 +++++ doc/WebConfigPropertyCollections.adoc | 147 ++++++++ doc/WindowsFeatures.adoc | 87 ++++- 28 files changed, 2512 insertions(+), 138 deletions(-) create mode 100644 doc/ConfigurationManagerDistributionGroups.adoc create mode 100644 doc/RemoteDesktopCertificates.adoc create mode 100644 doc/ScomComponents.adoc create mode 100644 doc/ScomManagementPacks.adoc create mode 100644 doc/ScomSettings.adoc create mode 100644 doc/SharePointCacheAccounts.adoc create mode 100644 doc/SharePointContentDatabases.adoc create mode 100644 doc/SharePointManagedAccounts.adoc create mode 100644 doc/SharePointManagedPaths.adoc create mode 100644 doc/SharePointPrereq.adoc create mode 100644 doc/SharePointProvisioning.adoc create mode 100644 doc/SharePointServiceAppPools.adoc create mode 100644 doc/SharePointServiceInstances.adoc create mode 100644 doc/SharePointSetup.adoc create mode 100644 doc/SharePointSites.adoc create mode 100644 doc/SharePointWebApplications.adoc create mode 100644 doc/SqlAgentAlerts.adoc create mode 100644 doc/SqlAgentOperators.adoc create mode 100644 doc/SqlDatabaseMailSetups.adoc create mode 100644 doc/SqlScriptQueries.adoc create mode 100644 doc/VSTSAgents.adoc create mode 100644 doc/VirtualMemoryFiles.adoc create mode 100644 doc/WebConfigProperties.adoc create mode 100644 doc/WebConfigPropertyCollections.adoc diff --git a/CHANGELOG.md b/CHANGELOG.md index 119a9800..a53df237 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,7 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `AddsTrusts` Composite for establishing Forest trusts with more configuration options than using AddsDomain-property DomainTrusts. - `FilesAndFolder` Add property to embed binary files into MOF. - `SmbShares` Add check and remove of duplicates from access properties in MOF. -- Update documentation +- Complete YAML documentation - `FileContents` Composite for managing file content. - `RemoteDesktopDeployment` Composite to configure a remote desktop deployment - `RemoteDesktopCollections` Composite to configure RD session collections, including their settings diff --git a/doc/ConfigurationManagerDistributionGroups.adoc b/doc/ConfigurationManagerDistributionGroups.adoc new file mode 100644 index 00000000..53dc0216 --- /dev/null +++ b/doc/ConfigurationManagerDistributionGroups.adoc @@ -0,0 +1,105 @@ +// CommonTasks YAML Reference: ConfigurationManagerDistributionGroups +// ================================================================== + +:YmlCategory: ConfigurationManagerDistributionGroups + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_configurationmanagerdistributiongroups] += DSC Resource '{YmlCategory}' + +[[dscyml_configurationmanagerdistributiongroups_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ConfigurationManagerDistributionGroups +| DSC Resource | https://github.com/dsccommunity/ConfigMgrCBDsc[ConfigMgrCBDsc] +| Documentation | https://github.com/dsccommunity/ConfigMgrCBDsc#resources[CMDistributionGroup] +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| SiteCode +| Mandatory +| String +| +| + +| [[dscyml_configurationmanagerdistributiongroups_distributiongroups, {YmlCategory}/DistributionGroups]]<> +| +| Hashtable[] +| set of distribution groups +| + +|=== + + +[[dscyml_configurationmanagerdistributiongroups_distributiongroups_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +ConfigurationManagerDistributionGroups: + SiteCode: AL1 + DistributionGroups: + - DistributionGroup: DG1 + #Collections: # 1:1 match, supported in future release of ConfigMgrCBDsc + # - Collection 1 + # - Collection 2 + DistributionPointsToExclude: + - DP2 + DistributionPointsToInclude: + - DP1 + SecurityScopesToExclude: + - Scope1 + SecurityScopesToInclude: + - Scope2 + - DistributionGroup: DG2 + #CollectionsToExclude: # supported in future release of ConfigMgrCBDsc + # - Collection 1 + #CollectionsToInclude: # supported in future release of ConfigMgrCBDsc + # - Collection 2 + DistributionPoints: # 1:1 match + - DP1 + - DP2 + SecurityScopes: # 1:1 match + - Scope1 + - Scope2 + - DistributionGroup: DG3 + SiteCode: AL2 # Override SiteCode for individual groups + DistributionPointsToExclude: + - DP2 + DistributionPointsToInclude: + - DP1 + SecurityScopesToExclude: + - Scope1 + SecurityScopesToInclude: + - Scope2 +---- \ No newline at end of file diff --git a/doc/DscPullServerSql.adoc b/doc/DscPullServerSql.adoc index 250708fe..fe2d5a28 100644 --- a/doc/DscPullServerSql.adoc +++ b/doc/DscPullServerSql.adoc @@ -16,19 +16,18 @@ :ref_xDscWebService: https://github.com/dsccommunity/xPSDesiredStateConfiguration#xdscwebservice[xDscWebService] - [cols="1,3a" options="autowidth" caption=] |=== | Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DscPullServerSql -| DSC Resource | https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration], - https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/[PSDesiredStateConfiguration], - https://github.com/dsccommunity/xWebAdministration[xWebAdministration], - https://docs.microsoft.com/de-de/powershell/scripting/dsc/reference/resources/windows/fileresource[File], - https://github.com/dsccommunity/NetworkingDsc[NetworkingDsc] -| Documentation | {ref_xDscWebService}, - https://github.com/dsccommunity/xWebAdministration#xwebconfigkeyvalue-deprecated[xWebConfigKeyValue], - https://github.com/dsccommunity/xWebAdministration#xwebapppool[xWebAppPool], - https://github.com/dsccommunity/NetworkingDsc/wiki/Firewall[Firewall] +| DSC Resource | - https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration] + - https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/[PSDesiredStateConfiguration] + - https://github.com/dsccommunity/xWebAdministration[xWebAdministration] + - https://docs.microsoft.com/de-de/powershell/scripting/dsc/reference/resources/windows/fileresource[File] + - https://github.com/dsccommunity/NetworkingDsc[NetworkingDsc] +| Documentation | - {ref_xDscWebService} + - https://github.com/dsccommunity/xWebAdministration#xwebconfigkeyvalue-deprecated[xWebConfigKeyValue] + - https://github.com/dsccommunity/xWebAdministration#xwebapppool[xWebAppPool] + - https://github.com/dsccommunity/NetworkingDsc/wiki/Firewall[Firewall] |=== diff --git a/doc/README.adoc b/doc/README.adoc index 65393554..99235a5b 100644 --- a/doc/README.adoc +++ b/doc/README.adoc @@ -87,6 +87,7 @@ ifdef::env-github[] - <> - <> - <> +- <> - <> - <> - <> @@ -145,32 +146,53 @@ ifdef::env-github[] - <> - <> - <> +- <> - <> - <> - <> - <> - <> - <> +- <> +- <> +- <> - <> - <> - <> +- <> +- <> +- <> +- <> +- <> +- <> +- <> +- <> +- <> +- <> +- <> - <> - <> - <> +- <> +- <> - <> - <> - <> - <> - <> - <> +- <> - <> - <> - <> - <> - <> +- <> - <> - <> - <> +- <> +- <> - <> - <> - <> @@ -178,6 +200,8 @@ ifdef::env-github[] - <> - <> - <> +- <> +- <> - <> - <> - <> @@ -200,130 +224,154 @@ ifndef::env-github[] .Reference of DSC Resouces [cols="1,2a" options="autowidth" caption=] |=== -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> -| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> +| <> | <> |=== @@ -381,6 +429,8 @@ include::ConfigurationManagerConfiguration.adoc[leveloffset=+1] <<<< include::ConfigurationManagerDeployment.adoc[leveloffset=+1] <<<< +include::ConfigurationManagerDistributionGroups.adoc[leveloffset=+1] +<<<< include::DfsNamespaces.adoc[leveloffset=+1] <<<< include::DhcpScopeOptions.adoc[leveloffset=+1] @@ -497,6 +547,8 @@ include::RegistryPolicies.adoc[leveloffset=+1] <<<< include::RegistryValues.adoc[leveloffset=+1] <<<< +include::RemoteDesktopCertificates.adoc[leveloffset=+1] +<<<< include::RemoteDesktopCollections.adoc[leveloffset=+1] <<<< include::RemoteDesktopDeployment.adoc[leveloffset=+1] @@ -509,18 +561,50 @@ include::Robocopies.adoc[leveloffset=+1] <<<< include::ScheduledTasks.adoc[leveloffset=+1] <<<< +include::ScomComponents.adoc[leveloffset=+1] +<<<< +include::ScomManagementPacks.adoc[leveloffset=+1] +<<<< +include::ScomSettings.adoc[leveloffset=+1] +<<<< include::Scripts.adoc[leveloffset=+1] <<<< include::SecurityBase.adoc[leveloffset=+1] <<<< include::SecurityPolicies.adoc[leveloffset=+1] <<<< +include::SharePointCacheAccounts.adoc[leveloffset=+1] +<<<< +include::SharePointContentDatabases.adoc[leveloffset=+1] +<<<< +include::SharePointManagedAccounts.adoc[leveloffset=+1] +<<<< +include::SharePointManagedPaths.adoc[leveloffset=+1] +<<<< +include::SharePointPrereq.adoc[leveloffset=+1] +<<<< +include::SharePointProvisioning.adoc[leveloffset=+1] +<<<< +include::SharePointServiceAppPools.adoc[leveloffset=+1] +<<<< +include::SharePointServiceInstances.adoc[leveloffset=+1] +<<<< +include::SharePointSetup.adoc[leveloffset=+1] +<<<< +include::SharePointSites.adoc[leveloffset=+1] +<<<< +include::SharePointWebApplications.adoc[leveloffset=+1] +<<<< include::SmbShares.adoc[leveloffset=+1] <<<< include::SoftwarePackages.adoc[leveloffset=+1] <<<< include::SqlAGDatabases.adoc[leveloffset=+1] <<<< +include::SqlAgentAlerts.adoc[leveloffset=+1] +<<<< +include::SqlAgentOperators.adoc[leveloffset=+1] +<<<< include::SqlAGListeners.adoc[leveloffset=+1] <<<< include::SqlAGReplicas.adoc[leveloffset=+1] @@ -531,6 +615,8 @@ include::SqlAliases.adoc[leveloffset=+1] <<<< include::SqlAlwaysOnServices.adoc[leveloffset=+1] <<<< +include::SqlDatabaseMailSetups.adoc[leveloffset=+1] +<<<< include::SqlConfigurations.adoc[leveloffset=+1] <<<< include::SqlDatabases.adoc[leveloffset=+1] @@ -543,12 +629,18 @@ include::SqlPermissions.adoc[leveloffset=+1] <<<< include::SqlRoles.adoc[leveloffset=+1] <<<< +include::SqlScriptQueries.adoc[leveloffset=+1] +<<<< include::SqlServer.adoc[leveloffset=+1] <<<< include::SwitchLcmMode.adoc[leveloffset=+1] <<<< include::UpdateServices.adoc[leveloffset=+1] <<<< +include::VirtualMemoryFiles.adoc[leveloffset=+1] +<<<< +include::VSTSAgents.adoc[leveloffset=+1] +<<<< include::WaitForAllNodes.adoc[leveloffset=+1] <<<< include::WaitForAnyNode.adoc[leveloffset=+1] @@ -563,6 +655,10 @@ include::WebApplications.adoc[leveloffset=+1] <<<< include::WebBrowser.adoc[leveloffset=+1] <<<< +include::WebConfigProperties.adoc[leveloffset=+1] +<<<< +include::WebConfigPropertyCollections.adoc[leveloffset=+1] +<<<< include::WebSites.adoc[leveloffset=+1] <<<< include::WebVirtualDirectories.adoc[leveloffset=+1] diff --git a/doc/RemoteDesktopCertificates.adoc b/doc/RemoteDesktopCertificates.adoc new file mode 100644 index 00000000..f84bbeeb --- /dev/null +++ b/doc/RemoteDesktopCertificates.adoc @@ -0,0 +1,70 @@ +// CommonTasks YAML Reference: RemoteDesktopCertificates +// ===================================================== + +:YmlCategory: RemoteDesktopCertificates + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_remotedesktopcertificates] += DSC Resource '{YmlCategory}' + +[[dscyml_remotedesktopcertificates_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RemoteDesktopCertificates +| DSC Resource | https://github.com/dsccommunity/xRemoteDesktopSessionHost[xRemoteDesktopSessionHost] +| Documentation | https://github.com/dsccommunity/xRemoteDesktopSessionHost/tree/master/source/DSCResources/MSFT_xRDCertificateConfiguration[xRDCertificateConfiguration] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_remotedesktopcertificates_certificates, {YmlCategory}/Certificates]]<> +| Mandatory +| Hashtable[] +| set of remote desktop certificates +| + +|=== + + +[[dscyml_remotedesktopcertificates_certificates_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +RemoteDesktopCertificates: +Certificates: + - Role: RDRedirector + ConnectionBroker: RDCB1 + ImportPath: C:\RDSFARM.pfx + Credential: '[ENC=PE9ianMgVmVy...=]' +---- \ No newline at end of file diff --git a/doc/ScomComponents.adoc b/doc/ScomComponents.adoc new file mode 100644 index 00000000..9bac3ed7 --- /dev/null +++ b/doc/ScomComponents.adoc @@ -0,0 +1,85 @@ +// CommonTasks YAML Reference: ScomComponents +// ========================================== + +:YmlCategory: ScomComponents + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_scomcomponents] += DSC Resource '{YmlCategory}' + +[[dscyml_scomcomponents_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ScomComponents +| DSC Resource | https://github.com/nyanhp/cScom[cScom] +| Documentation | https://github.com/nyanhp/cScom/blob/main/cScom/DscResources/JHP_ScomComponent.psm1[ScomComponent] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_scomcomponents_components, {YmlCategory}/Components]]<> +| Mandatory +| Hashtable[] +| set of SCOM components +| + +|=== + + +[[dscyml_scomcomponents_components_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +ScomComponents: + Components: + - Role: NativeConsole # No more properties + SourcePath: X:\ + - Role: FirstManagementServer + SourcePath: X:\ + ManagementGroupName : MG1 + DataReader : '[ENC=PE9ianMgVmVy...=]' + DataWriter : '[ENC=PE9ianMgVmVy...=]' + SqlServerInstance : SQ1 + SqlInstancePort : 1234 + DwSqlInstancePort : 4567 + DwSqlServerInstance : SQ2 + ProductKey : AAA-BBB-CCC-DDD + InstallLocation : C:\SCOM + ManagementServicePort : 5723 + ActionAccount : '[ENC=PE9ianMgVmVy...=]' + DASAccount : '[ENC=PE9ianMgVmVy...=]' + DatabaseName : OpsManagerDB + DwDatabaseName : DwOpsManagerDB + UseMicrosoftUpdate : false +---- \ No newline at end of file diff --git a/doc/ScomManagementPacks.adoc b/doc/ScomManagementPacks.adoc new file mode 100644 index 00000000..16d327b4 --- /dev/null +++ b/doc/ScomManagementPacks.adoc @@ -0,0 +1,74 @@ +// CommonTasks YAML Reference: ScomManagementPacks +// =============================================== + +:YmlCategory: ScomManagementPacks + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_scommanagementpacks] += DSC Resource '{YmlCategory}' + +[[dscyml_scommanagementpacks_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ScomManagementPacks +| DSC Resource | https://github.com/nyanhp/cScom[cScom] +| Documentation | https://github.com/nyanhp/cScom/blob/main/cScom/DscResources/JHP_ScomManagementPack.psm1[ScomManagementPack] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_scommanagementpacks_managementpacks, {YmlCategory}/ManagementPacks]]<> +| Mandatory +| Hashtable[] +| set of SCOM management packs +| + +|=== + + +[[dscyml_scommanagementpacks_managementpacks_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +ScomManagementPacks: + ManagementPacks: + - Name: CustomPack1 + ManagementPackPath: \\SomeShare\SomePath\MyCustomPack.mp + - Name: Dsc.ManagedNodes + ManagementPackContent : | + + + ... + +---- \ No newline at end of file diff --git a/doc/ScomSettings.adoc b/doc/ScomSettings.adoc new file mode 100644 index 00000000..02172a49 --- /dev/null +++ b/doc/ScomSettings.adoc @@ -0,0 +1,71 @@ +// CommonTasks YAML Reference: ScomSettings +// ======================================== + +:YmlCategory: ScomSettings + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_scomsettings] += DSC Resource '{YmlCategory}' + +[[dscyml_scomsettings_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ScomSettings +| DSC Resource | https://github.com/nyanhp/cScom[cScom] +| Documentation | + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +ScomSettings: + ApprovalSetting: AutoApprove + AlertResolutionSetting: + AlertAutoResolveDays: 4 + HealthyAlertAutoResolveDays: 1 + DatabaseGroomingSetting: + AlertDaysToKeep: 7 + AvailabilityHistoryDaysToKeep: 7 + EventDaysToKeep: 7 + JobStatusDaysToKeep: 7 + MaintenanceModeHistoryDaysToKeep: 7 + MonitoringJobDaysToKeep: 7 + PerformanceDataDaysToKeep: 7 + PerformanceSignatureDaysToKeep: 7 + StateChangeEventDaysToKeep: 7 + DataWarehouseSetting: + DatabaseName: SCOM2019 + ServerName: SCBD1\SomeInstance + ErrorReportSetting: OptOut + HeartbeatSetting: + MissingHeartbeatThreshold: 10 + HeartbeatIntervalSeconds: 60 + ReportingServerUrl: http://SCRS1:80/ReportServer + WebAddressSetting: + WebConsoleUrl: http://OM01.contoso.com/OperationsManager + OnlineProductKnowledgeUrl: http://OM01.contoso.com/Knowledge +---- \ No newline at end of file diff --git a/doc/SharePointCacheAccounts.adoc b/doc/SharePointCacheAccounts.adoc new file mode 100644 index 00000000..4f2c974b --- /dev/null +++ b/doc/SharePointCacheAccounts.adoc @@ -0,0 +1,69 @@ +// CommonTasks YAML Reference: SharePointCacheAccounts +// =================================================== + +:YmlCategory: SharePointCacheAccounts + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointcacheaccounts] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointcacheaccounts_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointCacheAccounts +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPCacheAccounts[SPCacheAccounts] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointcacheaccounts_cacheaccounts, {YmlCategory}/CacheAccounts]]<> +| Mandatory +| Hashtable[] +| set of cache accounts +| + +|=== + + +[[dscyml_sharepointcacheaccounts_cacheaccounts_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointCacheAccounts: + CacheAccounts: + - SuperReaderAlias: contoso\SP_SuperReader + SuperUserAlias: contoso\SP_SuperUser + WebAppUrl: https://content.contoso.com/ +---- \ No newline at end of file diff --git a/doc/SharePointContentDatabases.adoc b/doc/SharePointContentDatabases.adoc new file mode 100644 index 00000000..dc2db988 --- /dev/null +++ b/doc/SharePointContentDatabases.adoc @@ -0,0 +1,78 @@ +// CommonTasks YAML Reference: SharePointContentDatabases +// ====================================================== + +:YmlCategory: SharePointContentDatabases + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointcontentdatabases] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointcontentdatabases_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointContentDatabases +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPContentDatabase[SPContentDatabase] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointcontentdatabases_contentdatabases, {YmlCategory}/ContentDatabases]]<> +| Mandatory +| Hashtable[] +| set of content databases +| + +|=== + + +[[dscyml_sharepointcontentdatabases_contentdatabases_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointContentDatabases: + ContentDatabases: + - Name: SP2016_Content_My_02 + DatabaseServer: SqlServer001 + WebAppUrl: https://my.contoso.com/ + Enabled: true + WarningSiteCount: 2000 + MaximumSiteCount: 5000 + - Name: SP2016_Content_CTH + DatabaseServer: SqlServer001 + WebAppUrl: https://content.contoso.com + Enabled: true + WarningSiteCount: 2000 + MaximumSiteCount: 5000 +---- \ No newline at end of file diff --git a/doc/SharePointManagedAccounts.adoc b/doc/SharePointManagedAccounts.adoc new file mode 100644 index 00000000..59a98d7f --- /dev/null +++ b/doc/SharePointManagedAccounts.adoc @@ -0,0 +1,70 @@ +// CommonTasks YAML Reference: SharePointManagedAccounts +// ===================================================== + +:YmlCategory: SharePointManagedAccounts + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointmanagedaccounts] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointmanagedaccounts_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointManagedAccounts +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPManagedAccount[SPManagedAccount] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointmanagedaccounts_managedaccounts, {YmlCategory}/ManagedAccounts]]<> +| Mandatory +| Hashtable[] +| set of managed accounts +| + +|=== + + +[[dscyml_sharepointmanagedaccounts_managedaccounts_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointManagedAccounts: + ManagedAccounts: + - AccountName: contoso\sp_farm + Account: '[ENC=PE9ianMgVmVy...=]' + - AccountName: contoso\sp_contentAppPool + Account: '[ENC=PE9ianMgVmVy...=]' +---- \ No newline at end of file diff --git a/doc/SharePointManagedPaths.adoc b/doc/SharePointManagedPaths.adoc new file mode 100644 index 00000000..eb44ebd4 --- /dev/null +++ b/doc/SharePointManagedPaths.adoc @@ -0,0 +1,78 @@ +// CommonTasks YAML Reference: SharePointManagedPaths +// ================================================== + +:YmlCategory: SharePointManagedPaths + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointmanagedpaths] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointmanagedpaths_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointManagedPaths +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPManagedPath[SPManagedPath] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointmanagedpaths_managedpaths, {YmlCategory}/ManagedPaths]]<> +| Mandatory +| Hashtable[] +| set of managed accounts +| + +|=== + + +[[dscyml_sharepointmanagedpaths_managedpaths_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointManagedPaths: + ManagedPaths: + - WebAppUrl: t1 #https://content.contoso.com + RelativeUrl: mp1 + Explicit: false + HostHeader: false + - WebAppUrl: t2 #https://content.contoso.com + RelativeUrl: mp2 + Explicit: false + HostHeader: false + - WebAppUrl: t3 #https://my.contoso.com + RelativeUrl: personal + Explicit: false + HostHeader: false +---- \ No newline at end of file diff --git a/doc/SharePointPrereq.adoc b/doc/SharePointPrereq.adoc new file mode 100644 index 00000000..533f78a6 --- /dev/null +++ b/doc/SharePointPrereq.adoc @@ -0,0 +1,62 @@ +// CommonTasks YAML Reference: SharePointPrereq +// ============================================ + +:YmlCategory: SharePointPrereq + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointprereq] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointprereq_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointPrereq +| DSC Resource | - https://github.com/dsccommunity/StorageDsc[StorageDSC] + - https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | - https://github.com/dsccommunity/StorageDsc/wiki/MountImage[MountImage] + - https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPInstall[SPInstall] + - https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPInstallPrereqs[SPInstallPrereqs] +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointPrereq: + SQLNCli: C:\Install\sqlncli.msi + Sync: C:\Install\Synchronization.msi + AppFabric: C:\Install\WindowsServerAppFabricSetup_x64.exe + IDFX11: C:\Install\MicrosoftIdentityExtensions-64.msi + MSIPCClient: C:\Install\setup_msipc_x64.exe + WCFDataServices56: C:\Install\WcfDataServices.exe + MSVCRT11: C:\Install\vcredist_x64.exe + MSVCRT141: C:\Install\vc_redist.x64.exe + KB3092423: C:\Install\AppFabric-KB3092423-x64-ENU.exe + DotNet472: C:\Install\NDP472-KB4054530-x86-x64-AllOS-ENU.exe + InstallerPath: Z:\PrerequisiteInstaller.exe + IsoFilePath: C:\Install\en_sharepoint_server_2019_x64_dvd_68e34c9e.iso + IsoDriveLetter: 'Z:' + ProductKey: YourProductKey +---- \ No newline at end of file diff --git a/doc/SharePointProvisioning.adoc b/doc/SharePointProvisioning.adoc new file mode 100644 index 00000000..870e3abe --- /dev/null +++ b/doc/SharePointProvisioning.adoc @@ -0,0 +1,51 @@ +// CommonTasks YAML Reference: SharePointProvisioning +// ================================================== + +:YmlCategory: SharePointProvisioning + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointprovisioning] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointprovisioning_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointProvisioning +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPFarm[SPFarm] +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointProvisioning: + FarmConfigDatabaseName: SP2019_Config + AdminContentDatabaseName: SP2019_AdminDb + DatabaseServer: SqlServer001 + FarmAccount: '[ENC=PE9ianMgVmVyc...=]' + Passphrase: '[ENC=PE9ianMgVmVyc...=]' + RunCentralAdmin: true +---- \ No newline at end of file diff --git a/doc/SharePointServiceAppPools.adoc b/doc/SharePointServiceAppPools.adoc new file mode 100644 index 00000000..8a4559da --- /dev/null +++ b/doc/SharePointServiceAppPools.adoc @@ -0,0 +1,70 @@ +// CommonTasks YAML Reference: SharePointServiceAppPools +// ===================================================== + +:YmlCategory: SharePointServiceAppPools + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointserviceapppools] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointserviceapppools_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointServiceAppPools +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPServiceAppPool[SPServiceAppPool] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointserviceapppools_serviceapppools, {YmlCategory}/ServiceAppPools]]<> +| Mandatory +| Hashtable[] +| set of service app pools +| + +|=== + + +[[dscyml_sharepointserviceapppools_serviceapppools_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointServiceAppPools: + ServiceAppPools: + - Name: SharePoint - Service Applications + ServiceAccount: contoso\sp_serviceAppAppPool + - Name: SP2019-Search + ServiceAccount: contoso\sp_searchService +---- \ No newline at end of file diff --git a/doc/SharePointServiceInstances.adoc b/doc/SharePointServiceInstances.adoc new file mode 100644 index 00000000..3cc706b4 --- /dev/null +++ b/doc/SharePointServiceInstances.adoc @@ -0,0 +1,69 @@ +// CommonTasks YAML Reference: SharePointServiceInstances +// ====================================================== + +:YmlCategory: SharePointServiceInstances + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointserviceinstances] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointserviceinstances_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointServiceInstances +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPServiceInstance[SPServiceInstance] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointserviceinstances_serviceinstances, {YmlCategory}/ServiceInstances]]<> +| Mandatory +| Hashtable[] +| set of service instances +| + +|=== + + +[[dscyml_sharepointserviceinstances_serviceinstances_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointServiceInstances: + ServiceInstances: + - Name: Managed Metadata Web Service + - Name: User Profile Service + - Name: SharePoint Server Search +---- \ No newline at end of file diff --git a/doc/SharePointSetup.adoc b/doc/SharePointSetup.adoc new file mode 100644 index 00000000..acbb37b1 --- /dev/null +++ b/doc/SharePointSetup.adoc @@ -0,0 +1,65 @@ +// CommonTasks YAML Reference: SharePointSetup +// =========================================== + +:YmlCategory: SharePointSetup + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointsetup] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointsetup_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointSetup +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | - https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPInstall[SPInstall] + - https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPInstallLanguagePack[SPInstallLanguagePack] + - https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPInstallPrereqs[SPInstallPrereqs] +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointSetup: + InstallerPath: 'C:\SharePoint Server 2019\Setup\PrerequisiteInstaller.exe' + OnlineMode: false + KB3092423: 'C:\SharePoint Server 2019\Prerequisite Installer Files\AppFabric-KB3092423-x64-ENU.exe' + DotNet472: 'C:\SharePoint Server 2019\Prerequisite Installer Files\NDP472-KB4054530-x86-x64-AllOS-ENU.exe' + IDFX11: 'C:\\SharePoint Server 2019\Prerequisite Installer Files\MicrosoftIdentityExtensions-64.msi' + MSIPCClient: 'C:\SharePoint Server 2019\Prerequisite Installer Files\setup_msipc_x64.exe' + SQLNCli: 'C:\SharePoint Server 2019\Prerequisite Installer Files\sqlncli.msi' + Sync: 'C:\SharePoint Server 2019\Prerequisite Installer Files\Synchronization.msi' + WCFDataServices56: 'C:\SharePoint Server 2019\Prerequisite Installer Files\WcfDataServices.exe' + MSVCRT11: 'C:\SharePoint Server 2019\Prerequisite Installer Files\vc11redist_x64.exe' + MSVCRT141: 'C:\SharePoint Server 2019\Prerequisite Installer Files\vc_redist.x64.exe' + AppFabric: 'C:\SharePoint Server 2019\Prerequisite Installer Files\WindowsServerAppFabricSetup_x64.exe' + BinaryDir: 'C:\SharePoint Server 2019\Setup\' + ProductKey: key-key-key-key-key + InstallPath: 'C:\Program Files\Microsoft Office Servers' + DataPath: 'C:\Program Files\Microsoft Office Servers' + LanguagePacks: + - BinaryDir: 'C:\SharePoint Server 2019\Language Pack DE' +---- \ No newline at end of file diff --git a/doc/SharePointSites.adoc b/doc/SharePointSites.adoc new file mode 100644 index 00000000..5798ef67 --- /dev/null +++ b/doc/SharePointSites.adoc @@ -0,0 +1,80 @@ +// CommonTasks YAML Reference: SharePointSites +// =========================================== + +:YmlCategory: SharePointSites + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointsites] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointsites_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointSites +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPSite[SPSite] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointsites_sites, {YmlCategory}/Sites]]<> +| Mandatory +| Hashtable[] +| set of sites +| + +|=== + + +[[dscyml_sharepointsites_sites_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointSites: + Sites: + - Name: Contoso Content + Url: https://content.contoso.com + OwnerAlias: contoso\sp_setup + ContentDatabase: SP2016_Content_01 + Description: Root site for content + Language: 1033 + Template: STS#0 + - Name: App Catalog + Url: https://content.contoso.com/sites/AppCatalog + OwnerAlias: contoso\sp_setup + ContentDatabase: SP2016_Content_01 + Description: App Catalog + Language: 1033 + Template: APPCATELOG#0 +---- \ No newline at end of file diff --git a/doc/SharePointWebApplications.adoc b/doc/SharePointWebApplications.adoc new file mode 100644 index 00000000..26c770f5 --- /dev/null +++ b/doc/SharePointWebApplications.adoc @@ -0,0 +1,84 @@ +// CommonTasks YAML Reference: SharePointWebApplications +// ===================================================== + +:YmlCategory: SharePointWebApplications + +:abstract: {YmlCategory} is used to ###TBD### + +[#dscyml_sharepointwebapplications] += DSC Resource '{YmlCategory}' + +[[dscyml_sharepointwebapplications_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SharePointWebApplications +| DSC Resource | https://github.com/dsccommunity/SharePointDsc[SharePointDsc] +| Documentation | https://github.com/dsccommunity/SharePointDsc/tree/master/SharePointDsc/DSCResources/MSFT_SPWebApplication[SPWebApplication] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_sharepointwebapplications_webapplications, {YmlCategory}/WebApplications]]<> +| Mandatory +| Hashtable[] +| set of web applications +| + +|=== + + +[[dscyml_sharepointwebapplications_webapplications_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +SharePointWebApplications: + WebApplications: + - Name: SharePoint - Content + ApplicationPool: SharePoint - Content + ApplicationPoolAccount: contoso\sp_contentAppPool + AllowAnonymous: false + WebAppUrl: https://content.contoso.com/ + HostHeader: content.contoso.com + DatabaseName: SP2016_Content_01 + DatabaseServer: SqlServer001 + Port: 443 + - Name: SharePoint - MySite + ApplicationPool: SharePoint - MySite + ApplicationPoolAccount: contoso\sp_contentAppPool + AllowAnonymous: false + WebAppUrl: https://my.contoso.com/ + HostHeader: content.contoso.com + DatabaseName: SP2016_Content_My_02 + DatabaseServer: SqlServer001 + Port: 443 +---- \ No newline at end of file diff --git a/doc/SqlAgentAlerts.adoc b/doc/SqlAgentAlerts.adoc new file mode 100644 index 00000000..300030d9 --- /dev/null +++ b/doc/SqlAgentAlerts.adoc @@ -0,0 +1,131 @@ +// CommonTasks YAML Reference: SqlAgentAlerts +// ========================================== + +:YmlCategory: SqlAgentAlerts + +:abstract: {YmlCategory} is used to add/remove SQL Agent Alerts. + +[#dscyml_sqlagentalerts] += DSC Resource '{YmlCategory}' + +[[dscyml_sqlagentalerts_abstract, {abstract}]] +{abstract} + +The resource can also update the severity or message id. + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SqlAgentAlerts +| DSC Resource | https://github.com/dsccommunity/SqlServerDsc[SqlServerDsc] +| Documentation | - https://github.com/dsccommunity/SqlServerDsc/wiki[SqlServerDsc Wiki] + - https://github.com/dsccommunity/SqlServerDsc/wiki/SqlAgentAlert[SqlAgentAlert] + +|=== + + +.Requirements + +- Target machine must be running Windows Server 2012 or later. +- Target machine must be running SQL Server Database Engine 2012 or later. + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| DefaultInstanceName +| +| String +| Default SQL InstanceName +| Default: `MSSQLSERVER` + +| [[dscyml_sqlagentalerts_alerts, {YmlCategory}/Alerts]]<> +| Mandatory +| Hashtable[] +| List of SQL Agent Alerts. +| + +|=== + + +[[dscyml_sqlagentalerts_alerts_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| Name +| Key +| String +| The name of the SQL Server Agent alert. +| + +| ServerName +| Key +| String +| The host name of the SQL Server to be configured. + +Default value is the current computer name. +| + +| InstanceName +| Key +| String +| The name of the SQL Server instance to be configured. +| + +| Severity +| +| String +| The severity of the SQL Server Agent alert. +| + +| MessageId +| +| String +| The message id of the SQL Server Agent alert. +| + +| Ensure +| +| String +| Specifies if the SQL Server Agent alert should be present or absent. +| - *Present* (default) + - Absent + +|=== + + +.Example +[source, yaml] +---- +SqlAgentAlerts: + DefaultInstanceName: MSSQLSERVER + Alerts: + - Name: 'Sev17' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + Severity: '17' + - Name: 'Sev16' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + Severity: '16' + - Name: 'Msg825' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + MessageId: '825' + - Name: 'Msg123' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + MessageId: '123' +---- diff --git a/doc/SqlAgentOperators.adoc b/doc/SqlAgentOperators.adoc new file mode 100644 index 00000000..d8d2e96c --- /dev/null +++ b/doc/SqlAgentOperators.adoc @@ -0,0 +1,117 @@ +// CommonTasks YAML Reference: SqlAgentOperators +// ============================================= + +:YmlCategory: SqlAgentOperators + +:abstract: {YmlCategory} is used to add/remove SQL Agent Operators. + +[#dscyml_sqlagentoperators] += DSC Resource '{YmlCategory}' + +[[dscyml_sqlagentoperators_abstract, {abstract}]] +{abstract} + +The resource can also update the operators email address. + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SqlAgentOperators +| DSC Resource | https://github.com/dsccommunity/SqlServerDsc[SqlServerDsc] +| Documentation | - https://github.com/dsccommunity/SqlServerDsc/wiki[SqlServerDsc Wiki] + - https://github.com/dsccommunity/SqlServerDsc/wiki/SqlAgentOperator[SqlAgentOperator] + +|=== + + +.Requirements + +- Target machine must be running Windows Server 2012 or later. +- Target machine must be running SQL Server Database Engine 2012 or later. + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| DefaultInstanceName +| +| String +| Default SQL InstanceName +| Default: `MSSQLSERVER` + +| [[dscyml_sqlagentoperators_agentoperators, {YmlCategory}/AgentOperators]]<> +| Mandatory +| Hashtable[] +| List of SQL Agent Operators. +| + +|=== + + +[[dscyml_sqlagentoperators_agentoperators_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| Name +| Key +| String +| The name of the SQL Server Agent operator. +| + +| ServerName +| Key +| String +| The host name of the SQL Server to be configured. + +Default value is the current computer name. +| + +| InstanceName +| Key +| String +| The name of the SQL Server instance to be configured. +| + +| EmailAddress +| +| String +| The email address to be used for the SQL Server Agent operator. +| + +| Ensure +| +| String +| Specifies if the SQL Server Agent operator should be present or absent. +| - *Present* (default) + - Absent + +|=== + + +.Example +[source, yaml] +---- +SqlAgentOperators: + DefaultInstanceName: MSSQLSERVER + AgentOperators: + - Name: 'DbaTeam' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + EmailAddress: 'dbateam@company.com' + - Name: 'APPTeam' + ServerName: 'TestServer' + InstanceName: 'MSSQLServer' + EmailAddress: 'appteam@company.com' +---- diff --git a/doc/SqlDatabaseMailSetups.adoc b/doc/SqlDatabaseMailSetups.adoc new file mode 100644 index 00000000..47feedab --- /dev/null +++ b/doc/SqlDatabaseMailSetups.adoc @@ -0,0 +1,187 @@ +// CommonTasks YAML Reference: SqlDatabaseMailSetups +// ================================================= + +:YmlCategory: SqlDatabaseMailSetups + +:abstract: {YmlCategory} is used to manage SQL Server Database Mail. + +[#dscyml_sqldatabasemailsetups] += DSC Resource '{YmlCategory}' + +[[dscyml_sqldatabasemailsetups_abstract, {abstract}]] +{abstract} + +[NOTE] +==== +Database Mail XPs can be enabled using the resource <>. +==== + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SqlDatabaseMailSetups +| DSC Resource | https://github.com/dsccommunity/SqlServerDsc[SqlServerDsc] +| Documentation | - https://github.com/dsccommunity/SqlServerDsc/wiki[SqlServerDsc Wiki] + - https://github.com/dsccommunity/SqlServerDsc/wiki/SqlDatabaseMail[SqlDatabaseMail] + +|=== + + +.Requirements + +- Target machine must be running Windows Server 2012 or later. +- Target machine must be running SQL Server Database Engine 2012 or later. +- Target machine must be running SQL Server Agent. +- Target machine must have enabled Database Mail XPs. + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| DefaultInstanceName +| +| String +| Default SQL InstanceName +| Default: `MSSQLSERVER` + +| [[dscyml_sqldatabasemailsetups_mailsetups, {YmlCategory}/MailSetups]]<> +| Mandatory +| Hashtable[] +| List of SQL database mail setups. +| + +|=== + + +[[dscyml_sqldatabasemailsetups_mailsetups_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| AccountName +| Key +| String +| The name of the Database Mail account. +| + +| InstanceName +| Key +| String +| The name of the SQL Server instance to be configured. +| + +| ServerName +| +| String +| The host name of the SQL Server to be configured. + +Default value is the current computer name. +| + +| EmailAddress +| Mandatory +| String +| The e-mail address from which mail will originate. +| + +| MailServerName +| Mandatory +| String +| The fully qualified domain name (FQDN) of the mail server name to which e-mail are sent. +| + +| ProfileName +| Mandatory +| String +| The name of the Database Mail profile. +| + +| DisplayName +| +| String +| The display name of the originating email address. + +Default value is the same value assigned to the parameter `EmailAddress`. +| + +| ReplyToAddress +| +| String +| The e-mail address to which the receiver of e-mails will reply to. + +Default value is the same value assigned to the parameter `EmailAddress`. +| + +| Description +| +| String +| The description for the Database Mail profile and account. +| + +| LoggingLevel +| +| String +| The logging level that the Database Mail will use. +| - Normal + - *Extended* (default) + - Verbose + +| TcpPort +| +| UInt16 +| The TCP port used for communication. +| Default: `25` + +| Ensure +| +| String +| Specifies the desired state of the Database Mail account. + +When set to `Present` the Database Mail account will be created. +When set to `Absent` the Database Mail account will be removed. +| - *Present* (default) + - Absent + +|=== + + +.Example +[source, yaml] +---- +SqlDatabaseMailSetups: + DefaultInstanceName: MSSQLSERVER + MailSetups: + - ServerName: 'Servername' + InstanceName: 'DSCSQLTEST' + AccountName : 'MyMail' + ProfileName : 'MyMailProfile' + EmailAddress: 'NoReply@company.local' + ReplyToAddress: 'NoReply@company.local' + DisplayName : 'mail.company.local' + MailServerName: 'mail.company.local' + Description : 'Default mail account and profile.' + LoggingLevel: 'Normal' + TcpPort: 25 + - ServerName: 'Servername' + InstanceName: 'DSCSQLTEST' + AccountName : 'MyMail2' + ProfileName : 'MyMailProfile2' + EmailAddress: 'NoReply2@company.local' + ReplyToAddress: 'NoReply2@company.local' + DisplayName : 'mail.company.local' + MailServerName: 'mail.company.local' + Description : 'Second Default mail account and profile.' + LoggingLevel: 'Normal' + TcpPort: 25 +---- diff --git a/doc/SqlScriptQueries.adoc b/doc/SqlScriptQueries.adoc new file mode 100644 index 00000000..d502a15f --- /dev/null +++ b/doc/SqlScriptQueries.adoc @@ -0,0 +1,163 @@ +// CommonTasks YAML Reference: SqlScriptQueries +// ============================================ + +:YmlCategory: SqlScriptQueries + +:abstract: {YmlCategory} is used to to run a user generated T-SQL script on the SQL Server instance. + +[#dscyml_sqlscriptqueries] += DSC Resource '{YmlCategory}' + +[[dscyml_sqlscriptqueries_abstract, {abstract}]] +{abstract} + +Three scripts are required: Get T-SQL script, Set T-SQL script and the Test T-SQL script. + + +// reference links as variables for using more than once +:ref_invokesqlcmd: https://learn.microsoft.com/en-us/powershell/module/sqlserver/invoke-sqlcmd?view=sqlserver-ps[InvokeSqlCmd] + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/SqlScriptQueries +| DSC Resource | https://github.com/dsccommunity/SqlServerDsc[SqlServerDsc] +| Documentation | - https://github.com/dsccommunity/SqlServerDsc/wiki[SqlServerDsc Wiki] + - https://github.com/dsccommunity/SqlServerDsc/wiki/SqlScriptQuery[SqlScriptQuery] + +|=== + + +.Requirements + +- Target machine must be running Windows Server 2012 or later. +- Target machine must be running SQL Server Database Engine 2012 or later. +- Target machine must have access to the SQLPS PowerShell module or the SqlServer PowerShell module. + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| DefaultInstanceName +| +| String +| Default SQL InstanceName +| Default: `MSSQLSERVER` + +| [[dscyml_sqlscriptqueries_queries, {YmlCategory}/Queries]]<> +| Mandatory +| Hashtable[] +| List of SQL queries. +| + +|=== + + +[[dscyml_sqlscriptqueries_queries_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| InstanceName +| Key +| String +| Specifies the name of the SQL Server Database Engine instance. +| + +| GetQuery +| Key +| String +| Full T-SQL query that will perform Get action. + +Any values returned by the T-SQL queries will also be returned when calling Get (for example by using the cmdlet Get-DscConfiguration) through the `GetResult` property. +| + +| TestQuery +| Key +| String +| Full T-SQL query that will perform Test action. + +Any script that does not throw an error or returns NULL is evaluated to `$true`. +The cmdlet `{ref_invokesqlcmd}` treats T-SQL PRINT statements as verbose text, and will not cause the test to return `$false`. +| + +| SetQuery +| Key +| String +| Full T-SQL query that will perform Set action. +| + +| ServerName +| Key +| String +| The host name of the SQL Server to be configured. + +Default value is the current computer name. +| + +| Credential +| +| PSCredential +| The credentials to authenticate with, using _SQL Server Authentication_. + +To authenticate using _Windows Authentication_, assign the credentials to the built-in parameter `PsDscRunAsCredential`. +If neither of the parameters `Credential` and `PsDscRunAsCredential` are assigned then the `SYSTEM` account will be used to authenticate using _Windows Authentication_. +| + +| Variable +| +| String[] +| Specifies, as a string array, a scripting variable for use in the sql script, and sets a value for the variable. + +For more information how to use this, please go to the help documentation for `{ref_invokesqlcmd}`. +| + +| DisableVariables +| +| Boolean +| Specifies, as a boolean, whether or not PowerShell will ignore `{ref_invokesqlcmd}` scripting variables that share a format such as `$(variable_name)`. + +For more information how to use this, please go to the help documentation for `{ref_invokesqlcmd}`. +| - True + - False + +| QueryTimeout +| +| UInt32 +| Specifies, as an integer, the number of seconds after which the T-SQL script execution will time out. + +In some SQL Server versions there is a bug in `{ref_invokesqlcmd}` where the normal default value `0` (no timeout) is not respected and the default value is incorrectly set to 30 seconds. +| + +|=== + + +.Example +[source, yaml] +---- +SqlScriptQueries: + DefaultInstanceName: MSSQLSERVER + Queries: + - InstanceName: MSSQLSERVER + GetQuery: '--Get Query 1' + TestQuery: '--Test Query 1' + SetQuery: '--Set Query 1' + ServerName : 'ServerName' + QueryTimeout: 60 + - InstanceName: MSSQLSERVER + GetQuery: '--Get Query 2' + TestQuery: '--Test Query 2' + SetQuery: '--Set Query 2' + QueryTimeout: 60 +---- diff --git a/doc/VSTSAgents.adoc b/doc/VSTSAgents.adoc new file mode 100644 index 00000000..202975d9 --- /dev/null +++ b/doc/VSTSAgents.adoc @@ -0,0 +1,73 @@ +// CommonTasks YAML Reference: VSTSAgents +// ====================================== + +:YmlCategory: VSTSAgents + +:abstract: {YmlCategory} is used to manage and automate Visual Studio Team Services Agents. + +[#dscyml_vstsagents] += DSC Resource '{YmlCategory}' + +[[dscyml_vstsagents_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/VSTSAgents +| DSC Resource | https://github.com/microsoft/VSTSAgent.PowerShell[VSTSAgent] +| Documentation | https://github.com/microsoft/VSTSAgent.PowerShell/tree/develop/VSTSAgent/DSCResources/xVSTSAgent[xVSTSAgent] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_vstsagents_agents, {YmlCategory}/Agents]]<> +| Mandatory +| Hashtable[] +| set of web applications +| + +|=== + + +[[dscyml_vstsagents_agents_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| +| +| +| +| + +|=== + + +.Example +[source, yaml] +---- +VSTSAgents: + Agents: + - Name: Build + AccountCredential: "[ENC=PE9ianMgVmVy...=]" + LogonCredential: "[ENC=PE9ianMgVmVy...=]" + ServerUrl: https://dev.azure.com/abc/ + ProjectName: ABC + Pool: ABC + AgentDirectory: C:\VSTSAgent +---- \ No newline at end of file diff --git a/doc/VirtualMemoryFiles.adoc b/doc/VirtualMemoryFiles.adoc new file mode 100644 index 00000000..76c8a362 --- /dev/null +++ b/doc/VirtualMemoryFiles.adoc @@ -0,0 +1,100 @@ +// CommonTasks YAML Reference: VirtualMemoryFiles +// ============================================== + +:YmlCategory: VirtualMemoryFiles + +:abstract: {YmlCategory} allows configuration of properties of the paging file on the local computer. + +[#dscyml_virtualmemoryfiles] += DSC Resource '{YmlCategory}' + +[[dscyml_virtualmemoryfiles_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/VirtualMemoryFiles +| DSC Resource | https://github.com/dsccommunity/ComputerManagementDsc[ComputerManagementDsc] +| Documentation | https://github.com/dsccommunity/ComputerManagementDsc/wiki/VirtualMemory[VirtualMemory] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_virtualmemoryfiles_files, {YmlCategory}/Files]]<> +| Mandatory +| Hashtable[] +| set of web applications +| + +|=== + + +[[dscyml_virtualmemoryfiles_files_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| Drive +| Key +| String +| The drive letter for which paging settings should be set. + +Can be letter only, letter and colon or letter with colon and trailing slash. +| + +| Type +| Key +| String +| The type of the paging setting to use. + +If set to `AutoManagePagingFile`, the drive letter will be ignored. +If set to `SystemManagedSize`, the values for `InitialSize` and `MaximumSize` will be ignored +| - AutoManagePagingFile + - CustomSize + - SystemManagedSize + - NoPagingFile + +| InitialSize +| +| SInt64 +| The initial size of the page file in Megabyte +| + +| MaximumSize +| +| SInt64 +| +| The maximum size of the page file in Megabyte + +|=== + + +.Example +[source, yaml] +---- +VirtualMemoryFiles: + Files: + - Drive: C + Type: CustomSize + InitialSize: 4096 + MaximumSize: 4096 + - Drive: P + Type: CustomSize + InitialSize: 8192 + MaximumSize: 8192 +---- diff --git a/doc/WebConfigProperties.adoc b/doc/WebConfigProperties.adoc new file mode 100644 index 00000000..2a844e55 --- /dev/null +++ b/doc/WebConfigProperties.adoc @@ -0,0 +1,99 @@ +// CommonTasks YAML Reference: WebConfigProperties +// =============================================== + +:YmlCategory: WebConfigProperties + +:abstract: {YmlCategory} is used to ensure the value of an identified property in the web.config file. + +[#dscyml_webconfigproperties] += DSC Resource '{YmlCategory}' + +[[dscyml_webconfigproperties_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/WebConfigProperties +| DSC Resource | https://github.com/dsccommunity/xWebAdministration[xWebAdministration] +| Documentation | https://github.com/dsccommunity/WebAdministrationDsc/wiki/xWebConfigProperty[xWebConfigProperty] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_webconfigproperties_items, {YmlCategory}/Items]]<> +| Mandatory +| Hashtable[] +| set of web config properties +| + +|=== + + +[[dscyml_webconfigproperties_items_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| WebsitePath +| Key +| String +| Path to website location (IIS or WebAdministration format). +| + +| Filter +| Key +| String +| Filter used to locate property to update. +| + +| PropertyName +| Key +| String +| Name of the property to update. +| + +| Value +| +| String +| Value of the property to update. +| + +| Ensure +| +| String +| Indicates if the property and value should be present or absent. +| - *Present* (default) + - Absent + +|=== + + +.Example +[source, yaml] +---- +WebConfigProperties: + Items: + - WebsitePath: IIS:\Sites\Default Web Site\CertEnroll + Filter: system.webServer/directoryBrowse + PropertyName: enabled + Value: true + - WebsitePath: IIS:\Sites\Default Web Site\CertEnroll + Filter: system.webServer/security/requestFiltering + PropertyName: allowDoubleEscaping + Value: true +---- \ No newline at end of file diff --git a/doc/WebConfigPropertyCollections.adoc b/doc/WebConfigPropertyCollections.adoc new file mode 100644 index 00000000..ded1f988 --- /dev/null +++ b/doc/WebConfigPropertyCollections.adoc @@ -0,0 +1,147 @@ +// CommonTasks YAML Reference: WebConfigPropertyCollections +// ======================================================== + +:YmlCategory: WebConfigPropertyCollections + +:abstract: {YmlCategory} is used to ensure the value of an identified property collection item's property in the web.config file. + +[#dscyml_webconfigpropertycollections] += DSC Resource '{YmlCategory}' + +[[dscyml_webconfigpropertycollections_abstract, {abstract}]] +{abstract} + + +[cols="1,3a" options="autowidth" caption=] +|=== +| Source | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/WebConfigPropertyCollections +| DSC Resource | https://github.com/dsccommunity/xWebAdministration[xWebAdministration] +| Documentation | https://github.com/dsccommunity/WebAdministrationDsc/wiki/xWebConfigPropertyCollection[xWebConfigPropertyCollection] + +|=== + + +.Attributes of category '{YmlCategory}' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| [[dscyml_webconfigpropertycollections_items, {YmlCategory}/Items]]<> +| Mandatory +| Hashtable[] +| set of web config properties +| + +|=== + + +[[dscyml_webconfigpropertycollections_items_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| WebsitePath +| Key +| String +| Path to website location (IIS or WebAdministration format). +| + +| Filter +| Key +| String +| Filter used to locate property to update. +| + +| CollectionName +| Key +| String +| Name of the property collection to update. +| + +| ItemName +| Key +| String +| Name of the property collection item to update. +| + +| ItemKeyName +| Key +| String +| Name of the key of the property collection item to update. +| + +| ItemKeyValue +| Key +| String +| Value of the key of the property collection item to update. +| + +| ItemPropertyName +| Key +| String +| Name of the property of the property collection item to update. +| + +| ItemPropertyValue +| +| String +| Value of the property of the property collection item to update. +| + +| Ensure +| +| String +| Indicates if the property and value of the property collection item should be present or absent. +| - *Present* (default) + - Absent + +|=== + + +.Example +[source, yaml] +---- +WebConfigPropertyCollections: + Items: + - WebsitePath: MACHINE/WEBROOT/APPHOST + Filter: system.webServer/isapiFilters + CollectionName: . + ItemName: filter + ItemKeyName: name + ItemKeyValue: ASP.Net_2.0.50727-64 + ItemPropertyName: enabled + ItemPropertyValue: true + - WebsitePath: MACHINE/WEBROOT/APPHOST + Filter: system.webServer/isapiFilters + CollectionName: . + ItemName: filter + ItemKeyName: name + ItemKeyValue: ASP.Net_4.0_64bit + ItemPropertyName: enabled + ItemPropertyValue: true + - WebsitePath: MACHINE/WEBROOT/APPHOST + Filter: system.webServer/security/isapiCgiRestriction + CollectionName: . + ItemName: add + ItemKeyName: path + ItemKeyValue: C:\WINDOWS\Microsoft.NET\Framework64\v2.0.50727\aspnet_isapi.dll + ItemPropertyName: allowed + ItemPropertyValue: True + - WebsitePath: MACHINE/WEBROOT/APPHOST + Filter: system.webServer/security/isapiCgiRestriction + CollectionName: . + ItemName: add + ItemKeyName: path + ItemKeyValue: C:\WINDOWS\Microsoft.NET\Framework64\v2.0.50727\aspnet_isapi.dll + ItemPropertyName: groupId + ItemPropertyValue: ASP.NET v2.0.50727 +---- \ No newline at end of file diff --git a/doc/WindowsFeatures.adoc b/doc/WindowsFeatures.adoc index 2fe9bf9e..e72988b1 100644 --- a/doc/WindowsFeatures.adoc +++ b/doc/WindowsFeatures.adoc @@ -20,6 +20,13 @@ |=== +.Requirements + +- Target machine must be running Windows Server 2008 or later. +- Target machine must have access to the DISM PowerShell module. +- Target machine must have access to the ServerManager module (provided by default on Windows Server). + + .Attributes of category '{YmlCategory}' [cols="1,1,1,2a,1a" options="header"] |=== @@ -30,13 +37,77 @@ | Allowed Values | Names -| Mandatory -| string +| +| String[] | Indicates the name of the role or feature that you want to ensure is added or removed. -This is the same as the Name property from the Get-WindowsFeature cmdlet, and not the display name of the role or feature. +This is the same as the Name property from the `Get-WindowsFeature` cmdlet, and not the display name of the role or feature. | [+ \| -] +| [[dscyml_windowsfeatures_features, {YmlCategory}/Features]]<> +| +| Hashtable[] +| List windows features with additional properties +| + +|=== + + +[[dscyml_windowsfeatures_features_details]] +.Attributes of category '<>' +[cols="1,1,1,2a,1a" options="header"] +|=== +| Parameter +| Attribute +| DataType +| Description +| Allowed Values + +| Name +| Key +| +| Indicates the name of the role or feature that you want to ensure is added or removed. + +This is the same as the Name property from the `Get-WindowsFeature` cmdlet, and not the display name of the role or feature. +| + +| Credential +| +| PSCredential +| Indicates the credentials to use to add or remove the role or feature. +| + +| IncludeAllSubFeature +| +| Boolean +| Set this property to `True` to ensure the state of all required subfeatures with the state of the feature you specify with the Name property. +| - True + - False + +| Source +| +| String +| Specifies the path to feature files, if the files are not available in the local feature store of the target computer or VHD. + +Valid values for this parameter are either a network path or the path to a Windows image file (WIM). +| + +| LogPath +| +| String +| Indicates the path to a log file where you want the resource provider to log the operation. +| + +| Ensure +| +| String +| Indicates if the role or feature is added. + +To ensure that the role or feature is added, set this property to `Present`. +To ensure that the role or feature is removed, set the property to `Absent`. +| - *Present* (default) + - Absent + |=== @@ -49,6 +120,11 @@ WindowsFeatures: - +DHCP # installs WindowsFeature DHCP Server - -Web-Server # removes WindowsFeature Web-Server (IIS) - *Web-Server # installs WindowsFeature Web-Server (IIS) with all sub features. + Features: + - Name: NET-Framework-Core + Source: \\contoso.com\InstallationSources\WinSxs + - Name: RSAT-AD-Tools + IncludeAllSubFeature: true ---- @@ -63,4 +139,9 @@ lookup_options: merge_hash: deep WindowsFeatures\Names: merge_basetype_array: Unique + WindowsFeatures\Features: + merge_hash_array: UniqueKeyValTuples + merge_options: + tuple_keys: + - Name ----