dsc resources description

DscResources/GroupSet/GroupSet.schema.psm1

@@ -10,6 +10,10 @@ Import-Module -Name $script:resourceSetHelperFilePath
     .SYNOPSIS
         A composite DSC resource to configure a set of similar Group resources.
 
+    .DESCRIPTION
+    Provides a mechanism to manage local groups on the target node. Use this resource when you want to add and/or remove the same list of members to more than one group, remove more than one group, or add more than one group with the same list of members.
+
+
     .PARAMETER GroupName
         An array of the names of the groups to configure.
 
@@ -33,21 +37,25 @@ Configuration GroupSet
     [CmdletBinding()]
     param
     (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="The names of the groups for which you want to ensure a specific state.")]
         [ValidateNotNullOrEmpty()]
         [String[]]
         $GroupName,
 
+        [Parameter( HelpMessage="Indicates whether the groups exist. Set this property to Absent to ensure that the groups do not exist. Setting it to Present (the default value) ensures that the groups exist.")]
         [ValidateSet('Present', 'Absent')]
         [String]
         $Ensure,
 
+        [Parameter( HelpMessage="Use this property to add members to the existing membership of the group. The value of this property is an array of strings of the form Domain\UserName. If you set this property in a configuration, do not use the Members property. Doing so will generate an error.")]
         [String[]]
         $MembersToInclude,
 
+        [Parameter( HelpMessage="Use this property to remove members from the existing membership of the groups. The value of this property is an array of strings of the form Domain\UserName. If you set this property in a configuration, do not use the Members property. Doing so will generate an error.")]
         [String[]]
         $MembersToExclude,
 
+        [Parameter( HelpMessage="The credentials required to access remote resources. Note: This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error will occur.")]
         [ValidateNotNullOrEmpty()]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]

DscResources/ProcessSet/ProcessSet.schema.psm1

@@ -11,6 +11,9 @@ Import-Module -Name $script:resourceSetHelperFilePath
         A composite DSC resource to configure a set of similar WindowsProcess resources.
         No arguments can be passed into these WindowsProcess resources.
 
+    .DESCRIPTION
+        A composite DSC resource to configure a set of similar WindowsProcess resources.
+
     .PARAMETER Path
         The file paths to the executables of the processes to start or stop. Only the names of the
         files may be specified if they are all accessible through the environment path. Relative
@@ -48,32 +51,38 @@ Configuration ProcessSet
     [CmdletBinding()]
     param
     (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="The file paths to the executables of the processes to start or stop. Only the names of the files may be specified if they are all accessible through the environment path. Relative paths are not supported.")]
         [ValidateNotNullOrEmpty()]
         [String[]]
         $Path,
 
+        [Parameter(HelpMessage="Specifies whether or not the processes should exist. To start processes, set this property to Present. To stop processes, set this property to Absent.")]
         [ValidateSet('Present', 'Absent')]
         [String]
         $Ensure,
 
+        [Parameter(HelpMessage="The credential of the user account to start the processes under.")]
         [ValidateNotNullOrEmpty()]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]
         $Credential,
 
+        [Parameter(HelpMessage="The file path to write the standard output to. Any existing file at this path will be overwritten.This property cannot be specified at the same time as Credential when running the processes as a local user.")]
         [ValidateNotNullOrEmpty()]
         [String]
         $StandardOutputPath,
 
+        [Parameter(HelpMessage="The file path to write the standard error output to. Any existing file at this path will be overwritten.")]
         [ValidateNotNullOrEmpty()]
         [String]
         $StandardErrorPath,
 
+        [Parameter(HelpMessage="The file path to get standard input from. This property cannot be specified at the same time as Credential when running the processes as a local user.")]
         [ValidateNotNullOrEmpty()]
         [String]
         $StandardInputPath,
 
+        [Parameter(HelpMessage="The file path to use as the working directory for the processes. Any existing file at this path will be overwritten. This property cannot be specified at the same time as Credential when running the processes as a local user.")]
         [ValidateNotNullOrEmpty()]
         [String]
         $WorkingDirectory

DscResources/ServiceSet/ServiceSet.schema.psm1

@@ -10,6 +10,9 @@ Import-Module -Name $script:resourceSetHelperFilePath
     .SYNOPSIS
         A composite DSC resource to configure a set of similar Service resources.
 
+    .DESCRIPTION
+        A composite DSC resource to configure a set of similar Service resources.
+
     .PARAMETER Name
         An array of the names of the services to configure.
 
@@ -48,27 +51,32 @@ Configuration ServiceSet
     [CmdletBinding()]
     param
     (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="An array of the names of the services to configure.")]
         [ValidateNotNullOrEmpty()]
         [String[]]
         $Name,
 
+        [Parameter(HelpMessage="Specifies whether or not the set of services should exist. Set this property to Present to modify a set of services. Set this property to Absent to remove a set of services.")]
         [ValidateSet('Present', 'Absent')]
         [String]
         $Ensure,
 
+        [Parameter(HelpMessage="The startup type each service in the set should have.")]
         [ValidateSet('Automatic', 'Manual', 'Disabled')]
         [String]
         $StartupType,
 
+        [Parameter(HelpMessage="The built-in account each service in the set should start under. Cannot be specified at the same time as Credential. The user account specified by this property must have access to the service executable paths in order to start the services.")]
         [ValidateSet('LocalSystem', 'LocalService', 'NetworkService')]
         [String]
         $BuiltInAccount,
 
+        [Parameter(HelpMessage="The state each service in the set should be in. From the default value defined in Service, the default will be Running.")]
         [ValidateSet('Running', 'Stopped', 'Ignore')]
         [String]
         $State,
 
+        [Parameter(HelpMessage="he credential of the user account each service in the set should start under. Cannot be specified at the same time as BuiltInAccount. The user specified by this credential will automatically be granted the Log on as a Service right. The user account specified by this property must have access to the service executable paths in order to start the services.")]
         [ValidateNotNull()]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]

DscResources/WindowsFeatureSet/WindowsFeatureSet.schema.psm1

@@ -10,6 +10,9 @@ Import-Module -Name $script:resourceSetHelperFilePath
     .SYNOPSIS
         A composite DSC resource to configure a set of similar WindowsFeature resources.
 
+    .DESCRIPTION
+        A composite DSC resource to configure a set of similar WindowsFeature resources.
+
     .PARAMETER Name
         The name of the roles or features to install or uninstall.
 
@@ -38,27 +41,40 @@ Configuration WindowsFeatureSet
     [CmdletBinding()]
     param
     (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="The name of the roles or features to install or uninstall.")]
         [ValidateNotNullOrEmpty()]
         [String[]]
         $Name,
 
+        [Parameter(HelpMessage="Specifies whether the roles or features should be installed or uninstalled.
+
+        To install the features, set this property to Present.
+        To uninstall the features, set this property to Absent.")]
         [ValidateSet('Present', 'Absent')]
         [String]
         $Ensure,
 
+        [Parameter(HelpMessage="Specify the source")]
         [ValidateNotNullOrEmpty()]
         [String]
         $Source,
 
+        [Parameter(HelpMessage="Specifies whether or not all subfeatures should be installed or uninstalled alongside the specified roles or features.
+
+        If this property is true and Ensure is set to Present, all subfeatures will be installed.
+        If this property is false and Ensure is set to Present, subfeatures will not be installed or uninstalled.
+        If Ensure is set to Absent, all subfeatures will be uninstalled.")]
         [Boolean]
         $IncludeAllSubFeature,
 
+        [Parameter(HelpMessage="The credential of the user account under which to install or uninstall the roles or features.")]
         [ValidateNotNull()]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]
         $Credential,
 
+        [Parameter(HelpMessage="The custom file path to which to log this operation. 
+        If not passed in, the default log path will be used (%windir%\logs\ServerManager.log).")]
         [ValidateNotNullOrEmpty()]
         [String]
         $LogPath

DscResources/WindowsOptionalFeatureSet/WindowsOptionalFeatureSet.schema.psm1

@@ -10,6 +10,9 @@ Import-Module -Name $script:resourceSetHelperFilePath
     .SYNOPSIS
         A composite DSC resource to configure a set of similar WindowsOptionalFeature resources.
 
+    .DESCRIPTION
+        A composite DSC resource to configure a set of similar WindowsOptionalFeature resources.
+
     .PARAMETER Name
         The names of the Windows optional features to enable or disable.
 
@@ -38,26 +41,33 @@ Configuration WindowsOptionalFeatureSet
     [CmdletBinding()]
     param
     (
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="The names of the Windows optional features to enable or disable.")]
         [ValidateNotNullOrEmpty()]
         [String[]]
         $Name,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true, HelpMessage="Specifies whether the features should be enabled or disabled.
+
+        To enable a set of features, set this property to Present.
+        To disable a set of features, set this property to Absent.")]
         [ValidateSet('Present', 'Absent')]
         [String]
         $Ensure,
 
+        [Parameter(HelpMessage="Specifies whether or not to remove all files associated with the features when they are disabled.")]
         [Boolean]
         $RemoveFilesOnDisable,
 
+        [Parameter(HelpMessage="Specifies whether or not DISM should contact Windows Update (WU) when searching for the source files to restore Windows optional features on an online image.")]
         [Boolean]
         $NoWindowsUpdateCheck,
 
+        [Parameter(HelpMessage="The file path to which to log the opertation.")]
         [ValidateNotNullOrEmpty()]
         [String]
         $LogPath,
 
+        [Parameter(HelpMessage="The level of detail to include in the log.")]
         [ValidateSet('ErrorsOnly', 'ErrorsAndWarning', 'ErrorsAndWarningAndInformation')]
         [String]
         $LogLevel

README.md

@@ -577,6 +577,8 @@ The following parameters will be the same for each process in the set:
 
 ### Unreleased
 
+* Added Description and Parameter description for composite resources
+
 ### 2.8.0.0
 
 * Archive: