Export (0) Print
Expand All

Test-DscConfiguration

Test-DscConfiguration

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

Syntax

Parameter Set: CimSessionAndPathSet
Test-DscConfiguration [-Path] <String> -CimSession <CimSession[]> [-AsJob] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: CimSessionAndReferenceConfigurationSet
Test-DscConfiguration -CimSession <CimSession[]> -ReferenceConfiguration <String> [-AsJob] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: CimSessionSet
Test-DscConfiguration -CimSession <CimSession[]> [-AsJob] [-Detailed] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ComputerNameAndPathSet
Test-DscConfiguration [-Path] <String> [[-ComputerName] <String[]> ] [-AsJob] [-Credential <PSCredential> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ComputerNameAndReferenceConfigurationSet
Test-DscConfiguration [[-ComputerName] <String[]> ] -ReferenceConfiguration <String> [-AsJob] [-Credential <PSCredential> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ComputerNameSet
Test-DscConfiguration [[-ComputerName] <String[]> ] [-AsJob] [-Credential <PSCredential> ] [-Detailed] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

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.

Parameters

-AsJob

Indicates that this cmdlet runs the command as a background job.

If you specify the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session until the job finishes. The job is created on the local computer and the results from remote computers are automatically returned to the local computer. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

To use this parameter, the local and remote computers must be configured for remoting, and on Windows Vista and later versions of the Windows operating system, you must open Windows PowerShell with the Run as administrator option. For more information, see about_Remote_Requirements (http://go.microsoft.com/fwlink/?LinkId=623526).

For more information about Windows PowerShell background jobs, see about_Jobs (http://go.microsoft.com/fwlink/?LinkID=113251) and about_Remote_Jobs (http://go.microsoft.com/fwlink/?LinkID=135184).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies an array of computer names on which this cmdlet tests the configuration. The cmdlet tests the configuration document in the location specified by the Path parameter to these computers.


Aliases

CN,ServerName

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies a user name and password, as a PSCredential object, for the target computer. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Detailed

Indicates that this cmdlet returns a detailed result of comparing the configuration document with the desired state of the nodes. The result includes information such as overall state, resources that are in the desired state, resources that are not in desired state, and computer name.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String>

Specifies the path of a folder that contains configuration document files. The cmdlet tests the configuration against the desired state of computers specified by the ComputerName or CimSession parameter.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReferenceConfiguration<String>

Specifies the path of the configuration document file. This cmdlet tests the configuration against the actual state of computers specified by the ComputerName or CimSession parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Test configuration for the local computer

This command tests configuration for the local computer.


PS C:\> Test-DscConfiguration

Example 2: Test configuration for a specified computer

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.


PS C:\> $Session = New-CimSession –ComputerName "Server01" –Credential ACCOUNTS\PattiFuller
PS C:\> Test-DscConfiguration -CimSession $Session

Example 3: Test configurations with detailed results

This command tests configurations for a set of computers specified by the ComputerName parameter and returns detailed information that includes the overall state, resources that are in the desired state, resources that are not in the desired state and computer name.


PS C:\> Test-DscConfiguration –ComputerName "Server01", "Server02", "Server03" -Detailed

Example 4: Test configurations specified in a folder

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.


PS C:\> Test-DscConfiguration –Path "C:\Dsc\Configurations"

Example 5: Test configurations specified in a file

This command tests a configuration defined in a file against a set of computers specified by the ComputerName parameter.


PS C:\> Test-DscConfiguration –ReferenceConfiguration "C:\Dsc\Configurations\WebServer.mof" –ComputerName "Server01", "Server02", "Server03"

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft