Remove-DscConfigurationDocument
DSC 構成ストアから構成ドキュメントを削除します。
構文
Default (既定)
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 のNovember 2014 更新プログラムのロールアップの一部としてのみ使用できます。
例
例 1: 現在の構成ドキュメントを削除する
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session
最初のコマンドは、New-CimSession コマンドレットを使用して CIM セッションを作成し、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」を参照してください。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CimSession
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。 コンピューター名またはセッション オブジェクト (New-CimSession または Get-CimSession コマンドレットの出力など) を入力します。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | セッション |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
このコマンドレットは、構成ドキュメントを削除する前に、実行中の構成ジョブを停止することを示します。 ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Stage
削除する構成ドキュメントを指定します。 複数のドキュメントを指定できます。 このパラメーターに使用できる値は次のとおりです。
-
Current- システムの現在の状態を説明する構成ドキュメントを削除します。 -
Pending- システムの保留中の状態を説明する構成ドキュメントを削除します。 -
Previous- システムの以前の状態を説明する構成ドキュメントを削除します。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| 規定値: | None |
| 指定可能な値: | Current, Pending, Previous |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ThrottleLimit
コマンドレットを実行するために確立できる同時実行操作の最大数を指定します。 このパラメーターを省略するか、0 の値を入力すると、Windows PowerShell は、コンピューターで実行されている CIM コマンドレットの数に基づいて、コマンドレットの最適なスロットル制限を計算します。 スロットル制限は、セッションまたはコンピューターではなく、現在のコマンドレットにのみ適用されます。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
