Remove-DscConfigurationDocument
从 DSC 配置存储中删除配置文档。
语法
Remove-DscConfigurationDocument
-Stage <Stage>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
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