Stop-DscConfiguration

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

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

構文

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

説明

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

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

例

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

この例では、 コマンドレットを使用して CIM セッションを New-CimSession 作成します。 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」を参照してください。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

コマンドレットを実行するために確立できる最大並行処理数を指定します。

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 コマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

出力

None