通过

Remove-DscConfigurationDocument

  • 参考
模块:
PSDesiredStateConfiguration

从 DSC 配置存储中删除配置文档。

语法

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

说明

Remove-DscConfigurationDocument cmdlet 从 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 参数，该命令将返回一个代表作业的对象，然后显示命令提示符。 可以在会话中继续工作，直到作业完成。 作业在本地计算机上创建，远程计算机的结果会自动返回到本地计算机。 若要管理作业，请使用作业 cmdlet。 若要获取作业结果，请使用 Receive-Job cmdlet。

若要使用此参数，必须为本地和远程计算机配置远程处理，并且必须在 Windows Vista 及更高版本的 Windows作系统上打开 Windows PowerShell，并使用“以管理员身份运行”选项打开 Windows PowerShell。 有关详细信息，请参阅 about_Remote_Requirements。

有关 Windows PowerShell 后台作业的详细信息，请参阅 about_Jobs 和 about_Remote_Jobs。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CimSession

在远程会话或远程计算机上运行 cmdlet。 输入计算机名或会话对象，例如 New-CimSession 或 Get-CimSession cmdlet 的输出。

类型:CimSession[]
别名:Session
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Force

指示此 cmdlet 在删除配置文档之前停止正在运行的配置作业。 强制命令运行而不要求用户确认。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Stage

指定要删除的配置文档。 可以指定多个文档。 此参数的可接受值为：

  • Current - 删除描述系统当前状态的配置文档。
  • Pending - 删除描述系统挂起状态的配置文档。
  • Previous - 删除描述系统先前状态的配置文档。
类型:Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage
接受的值:Current, Pending, Previous
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-ThrottleLimit

指定可以建立以运行 cmdlet 的最大并发作数。 如果省略此参数或输入 0 值，则 Windows PowerShell 会根据计算机上运行的 CIM cmdlet 数计算 cmdlet 的最佳限制。 限制限制仅适用于当前 cmdlet，不适用于会话或计算机。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

None

输出

None