This is the built-in help made by Microsoft for the command 'Test-DscConfiguration', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Tests whether the actual configuration on the nodes matches the desired configuration.
Test-DscConfiguration [[-ComputerName] [<String[]>]] [-AsJob] [-Credential [<PSCredential>]] [-Detailed] [-ThrottleLimit [<Int32>]] [<CommonParameters>]
Test-DscConfiguration [-Path] <String> [[-ComputerName] [<String[]>]] [-AsJob] [-Credential [<PSCredential>]] [-ThrottleLimit [<Int32>]] [<CommonParameters>]
Test-DscConfiguration [[-ComputerName] [<String[]>]] [-AsJob] [-Credential [<PSCredential>]] [-ThrottleLimit [<Int32>]] -ReferenceConfiguration <String> [<CommonParameters>]
Test-DscConfiguration [-AsJob] [-Detailed] [-ThrottleLimit [<Int32>]] -CimSession <CimSession[]> [<CommonParameters>]
Test-DscConfiguration [-AsJob] [-ThrottleLimit [<Int32>]] -CimSession <CimSession[]> -ReferenceConfiguration <String> [<CommonParameters>]
Test-DscConfiguration [-Path] <String> [-AsJob] [-ThrottleLimit [<Int32>]] -CimSession <CimSession[]> [<CommonParameters>]
The Test-DscConfiguration cmdlet tests whether the actual configuration on the nodes matches the desired configuration. Specify which computers for which you want to test
configurations by using computer names or Common Information Model (CIM) sessions. If you do not specify a target computer, the cmdlet tests configuration of the local
computer.
If the desired and actual configurations match, the cmdlet returns a value of $True. Otherwise, it returns a value of $False.
<
Online Version: http://go.microsoft.com/fwlink/?LinkID=294365
Windows PowerShell Desired State Configuration Overview
Get-DscConfiguration
Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
<
Example 1: Test configuration for the local computer
PS C:\> Test-DscConfiguration
This command tests configuration for the local computer.
Example 2: Test configuration for a specified computer
PS C:\> $Session = New-CimSession –ComputerName "Server01" –Credential ACCOUNTS\PattiFuller
PS C:\> Test-DscConfiguration -CimSession $Session
This example test configuration from a computer specified by a CIM session. The example creates a CIM session for a computer named Server01 for use with the cmdlet.
Alternatively, create an array of CIM sessions to apply the cmdlet to multiple specified computers.
The first command creates a CIM session by using the New-CimSession cmdlet, and then stores the CimSession object in the $Session variable. The command prompts you for a
password. For more information, type Get-Help New-CimSession.
The second command tests configuration for the computers identified by the CimSession objects stored in the $Session variable, in this case, the computer named Server01.
Example 3: Test configurations with detailed results
PS C:\>Test-DscConfiguration –ComputerName "Server01", "Server02", "Server03" -Detailed
This command tests configurations for a set of computers specified by the ComputerName parameter and returns detailed information including the overall state, resources that
are in the desired state, resources that are not in the desired state and computer name.
Example 4: Test configurations specified in a folder
PS C:\>Test-DscConfiguration –Path "C:\Dsc\Configurations"
This command tests configurations that are defined in a folder specified by the Path parameter. The configurations are tested against a set of computers, each identified by
the file name of the configuration file.
Example 5: Test configurations specified in a file
PS C:\>Test-DscConfiguration –ReferenceConfiguration "C:\Dsc\Configurations\WebServer.mof" –ComputerName "Server01", "Server02", "Server03"
This command tests a configuration defined in a file against a set of computers specified by the ComputerName parameter.