Remove-DscConfigurationDocument

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

DSC 構成ストアから構成ドキュメントを削除します。

構文

Remove-DscConfigurationDocument
      -Stage <Stage>
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットはRemove-DscConfigurationDocument、Windows PowerShell Desired State Configuration (DSC) 構成ストアから構成ドキュメント (.mof ファイル) を削除します。 構成時に、コマンドレットは Start-DscConfiguration ターゲット コンピューター上の .mof フォルダーにファイルをコピーします。 このコマンドレットは、その構成ドキュメントを削除し、追加のクリーンアップを行います。

このコマンドレットは、Windows RT 8.1、Windows 8.1、Windows Server 2012 R2 の 2014 年 11 月の更新プログラムのロールアップの一部としてのみ使用できます。

例

例 1: 現在の構成ドキュメントを削除する

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session

最初のコマンドは、 コマンドレットを使用して CIM セッションを New-CimSession 作成し、 CimSession オブジェクトを $Session 変数に格納します。 コマンドはパスワードの入力をユーザーに求めます。 詳細を表示するには「Get-Help New-CimSession」を入力します。

2 番目のコマンドは、$Sessionに格納されている CimSession で指定されたコンピューターの現在の構成ドキュメントを削除します。

パラメーター

-AsJob

このコマンドレットがバックグラウンド ジョブとしてコマンドを実行することを示します。

AsJob パラメーターを指定した場合、コマンドはジョブを表す オブジェクトを返し、コマンド プロンプトを表示します。 ジョブが完了するまで、セッションで作業を続けることができます。 ジョブは、ローカル コンピューターで作成され、リモート コンピューターでの結果は自動的にローカル コンピューターに返されます。 ジョブを管理するには、Job コマンドレットを使用します。 ジョブの結果を取得するには、Receive-Job コマンドレットを使用します。

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

Windows PowerShellバックグラウンド ジョブの詳細については、「about_Jobsとabout_Remote_Jobs」を参照してください。

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

-CimSession

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

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Stage

削除する構成ドキュメントを指定します。 複数のドキュメントを指定できます。 このパラメーターの有効値は、次のとおりです。

  • Current - システムの現在の状態を説明する構成ドキュメントを削除します。
  • Pending - システムの保留中の状態を説明する構成ドキュメントを削除します。
  • Previous - システムの以前の状態を説明する構成ドキュメントを削除します。
Type:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
Accepted values:Current, Pending, Previous
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

コマンドレットを実行するために確立できる最大並行処理数を指定します。 このパラメーターを省略するか、 の0値を入力した場合、Windows PowerShellは、コンピューターで実行されている 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