PowerShell Logo Small

Test-DscConfiguration



This is the built-in help made by Microsoft for the command 'Test-DscConfiguration', in PowerShell version 4 - as retrieved from Windows version 'Microsoft Windows 8.1 Enterprise' 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.

SYNOPSIS

Tests whether the actual configuration on the nodes matches the desired configuration.

SYNTAX


Test-DscConfiguration [-CimSession [<CimSession[]>]] [-ThrottleLimit [<Int32>]] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Test-DscConfiguration cmdlet tests whether the actual configuration on the nodes matches the desired configuration. Specify computers by using 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.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=294365
Windows PowerShell Desired State Configuration Overview
Get-DscConfiguration
Restore-DscConfiguration
Start-DscConfiguration

REMARKS

<

Examples


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. A
lternatively, 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 fo
r 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 Server
01.