共用方式為

Remove-DscConfigurationDocument

  • 參考
模組:
PSDesiredStateConfiguration

從 DSC 設定存放區移除設定文件。

Syntax

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

Description

Cmdlet Remove-DscConfigurationDocument 會從 Windows PowerShell Desired State Configuration (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 參數，此命令就會傳回代表工作的物件，然後顯示命令提示字元。 您可以繼續在工作階段中運作，直到工作完成。 工作會在本機電腦上建立，而來自遠端電腦的結果則會自動傳回到本機電腦。 若要管理工作，請使用各項 Job Cmdlet。 若要取得作業結果，請使用 Receive-Job Cmdlet。

若要使用這個參數，本機電腦和遠端電腦必須針對遠端執行功能進行設定，並且在 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

在遠端工作階段或遠端電腦上執行 Cmdlet。 輸入電腦名稱稱或會話物件，例如 或 Get-CimSession Cmdlet 的 New-CimSession 輸出。

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

-Confirm

在執行 Cmdlet 前提示您確認。

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

-Force

指出此 Cmdlet 會在移除設定文件之前，先停止執行中的設定工作。 強制執行命令而不要求使用者確認。

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

指定為執行 Cmdlet 可建立的最大並行作業數。 如果省略此參數或輸入 的值 0 ，則Windows PowerShell根據電腦上執行的 CIM Cmdlet 數目，計算 Cmdlet 的最佳節流限制。 節流限制僅適用於目前 Cmdlet，不適用於工作階段或電腦。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。

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

輸入

None

輸出

None