PowerShell Logo Small

Stop-DscConfiguration



This is the built-in help made by Microsoft for the command 'Stop-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.

SYNOPSIS

Stops a running configuration.

SYNTAX


Stop-DscConfiguration [-AsJob] [-CimSession [<CimSession[]>]] [-Force] [-ThrottleLimit [<Int32>]] [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Stop-DscConfiguration cmdlet stops a configuration job that is currently running. Specify which computers this cmdlet applies to by using Common Information Model (CIM)
sessions. If there is no configuration job running, this cmdlet returns a warning message.


This cmdlet is available only as part of the November 2014 update rollup for Windows RT 8.1, Windows 8.1, and Windows Server 2012 R2
(http://support.microsoft.com/en-us/kb/3000850) from the Microsoft Support library. Before you use this cmdlet, review the information in What's New in Windows PowerShell
(http://technet.microsoft.com/library/hh857339.aspx) in the TechNet library.


Note that this cmdlet does not support the Confirm parameter.



<

RELATED LINKS

Windows PowerShell Desired State Configuration Overview
Get-DscConfiguration
Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration
Update-DscConfiguration

REMARKS

<

Examples


Example 1: Stop a configuration job

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



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 stops a currently running configuration job on the computer identified by the CimSession object stored in $Session.