Remove-DscConfigurationDocument
從 DSC 組態存放區移除設定檔。
語法
Default (預設值)
Remove-DscConfigurationDocument
-Stage <Stage>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove-DscConfigurationDocument Cmdlet 會從 Windows PowerShell 預期狀態設定 (DSC) 組態存放區中移除組態檔 (.mof 檔案)。 在設定期間,Start-DscConfiguration Cmdlet 會將 .mof 檔案複製到目標電腦上的資料夾。 此 Cmdlet 會移除該組態檔,並執行其他清除。
此 Cmdlet 僅適用於 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
第一個命令會使用 New-CimSession Cmdlet 建立 CIM 會話,然後將 CimSession 物件儲存在 $Session 變數中。 命令會提示您輸入密碼。 如需詳細資訊,請輸入 Get-Help New-CimSession。
第二個命令會移除儲存在 $Session CimSession 中指定的計算機目前組態檔。
參數
-AsJob
表示此 Cmdlet 會以背景工作的形式執行命令。
如果您指定 AsJob 參數,命令會傳回代表作業的物件,然後顯示命令提示字元。 您可以繼續在會話中工作,直到作業完成為止。
作業會在本機計算機上建立,而遠端計算機的結果會自動傳回至本機計算機。 若要管理作業,請使用作業 Cmdlet。 若要取得作業結果,請使用 Receive-Job Cmdlet。
若要使用此參數,本機和遠端電腦必須設定為遠端,而且在 Windows Vista 和更新版本的 Windows 作業系統上,您必須使用 [以系統管理員身分執行] 選項開啟 Windows PowerShell。 如需詳細資訊,請參閱 about_Remote_Requirements。
如需 Windows PowerShell 背景工作的詳細資訊,請參閱 about_Jobs 和 about_Remote_Jobs。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-CimSession
在遠端會話或遠端電腦上執行 Cmdlet。 輸入計算機名稱或會話物件,例如 New-CimSession 或 Get-CimSession Cmdlet 的輸出。
參數屬性
| 類型: | |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 會期 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前,提示您進行確認。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
表示此 Cmdlet 會在移除組態檔之前停止執行中的組態作業。 強制命令執行,而不要求使用者確認。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Stage
指定要移除的組態檔。 您可以指定多個檔案。 此參數可接受的值為:
-
Current- 移除描述系統目前狀態的組態檔。 -
Pending- 移除描述系統暫止狀態的組態檔。 -
Previous- 移除描述系統先前狀態的組態檔。
參數屬性
| 類型: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| 預設值: | None |
| 接受的值: | Current, Pending, Previous |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ThrottleLimit
指定可以建立以執行 Cmdlet 的並行作業數目上限。 如果省略此參數或輸入 0 的值,則 Windows PowerShell 會根據計算機上執行的 CIM Cmdlet 數目,計算 Cmdlet 的最佳節流限制。 節流限制僅適用於目前的 Cmdlet,不適用於工作階段或電腦。
參數屬性
| 類型: | Int32 |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 指令未執行。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 無線 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。