次の方法で共有

Stop-DscConfiguration

  • リファレンス
モジュール:
PSDesiredStateConfiguration

実行中の構成ジョブを停止します。

構文

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

説明

Stop-DscConfiguration コマンドレットは、実行中の構成ジョブを停止します。 共通情報モデル (CIM) セッションを使用して、このコマンドレットが適用されるコンピューターを指定します。 実行されている構成ジョブがない場合、このコマンドレットは警告メッセージを返します。

Stop-DscConfiguration は、Microsoft サポート ライブラリの Windows RT 8.1、Windows 8.1、および Windows Server 2012 R2 の 2014 年 11 月の更新プログラムロールアップの一部としてのみ使用できます。 このコマンドレットを使用する前に、「Windows PowerShell 5.0 の新機能

例

例 1: 構成ジョブを停止する

この例では、New-CimSession コマンドレットを使用して CIM セッションを作成します。 CimSession オブジェクトは、実行中の構成ジョブを停止するために使用されます。

$Session = New-CimSession -ComputerName Server01 -Credential ACCOUNTS\User01
Stop-DscConfiguration -CimSession $Session

New-CimSession は、ComputerName パラメーターを使用して Server01 コンピューターを指定します。 Credential パラメーターは、ユーザー アカウントを指定します。 CimSession オブジェクトは、$Session 変数に格納されます。 コマンドを実行すると、ユーザー アカウントのパスワードの入力を求められます。

Stop-DscConfiguration では、CimSession パラメーターと、$Session に格納されているオブジェクトを使用して構成ジョブを停止します。

パラメーター

-AsJob

このコマンドレットがバックグラウンド ジョブとしてコマンドを実行することを示します。 PowerShell バックグラウンド ジョブの詳細については、「about_Jobs と about_Remote_Jobs」を参照してください。

AsJob パラメーターを使用するには、リモート処理用にローカル コンピューターとリモート コンピューターを構成する必要があります。 Windows Vista 以降のバージョンの Windows オペレーティング システムでは、[管理者として実行] オプションを使用して PowerShell を開く必要があります。 詳細については、about_Remote_Requirementsを参照してください。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CimSession

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。 New-CimSession または Get-CimSessionからの出力など、コンピューター名またはセッション オブジェクトを入力します。

型:CimSession[]
Aliases:Session
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

Stop-DscConfiguration では、Confirm パラメーターはサポートされていません。 Confirm パラメーターを使用すると、エラーが表示されます。

Confirmをサポートする PowerShell コマンドレットの場合、パラメーターを使用すると、コマンドを実行する前に検証を求められます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ThrottleLimit

コマンドレットを実行するために確立できる同時実行操作の最大数を指定します。

このパラメーターを省略するか、0 の値を入力すると、コンピューターで実行されている CIM コマンドレットの数に基づいて最適なスロットル制限が計算されます。 スロットル制限は、セッションまたはコンピューターではなく、現在のコマンドレットにのみ適用されます。

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

None

出力

None