Remove-DscConfigurationDocument
Menghapus dokumen konfigurasi dari penyimpanan konfigurasi DSC.
Sintaks
Default (Default)
Remove-DscConfigurationDocument
-Stage <Stage>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Deskripsi
Cmdlet Remove-DscConfigurationDocument menghapus dokumen konfigurasi (file.mof) dari penyimpanan konfigurasi Windows PowerShell Desired State Configuration (DSC). Selama konfigurasi, cmdlet Start-DscConfiguration menyalin file .mof ke folder di komputer target. Cmdlet ini menghapus dokumen konfigurasi tersebut dan melakukan pembersihan tambahan.
Cmdlet ini hanya tersedia sebagai bagian dari rollup pembaruan November 2014 untuk Windows RT 8.1, Windows 8.1, dan Windows Server 2012 R2.
Contoh
Contoh 1: Menghapus dokumen konfigurasi saat ini
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session
Perintah pertama membuat sesi CIM dengan menggunakan cmdlet New-CimSession, lalu menyimpan objek CimSession dalam variabel $Session. Perintah meminta kata sandi kepada Anda. Untuk informasi selengkapnya, ketik Get-Help New-CimSession.
Perintah kedua menghapus dokumen konfigurasi saat ini untuk komputer yang ditentukan dalam CimSession disimpan di $Session.
Parameter
-AsJob
Menunjukkan bahwa cmdlet ini menjalankan perintah sebagai pekerjaan latar belakang.
Jika Anda menentukan parameter AsJob, perintah mengembalikan objek yang mewakili pekerjaan, lalu menampilkan prompt perintah. Anda dapat terus bekerja dalam sesi hingga pekerjaan selesai.
Pekerjaan dibuat pada komputer lokal dan hasil dari komputer jarak jauh secara otomatis dikembalikan ke komputer lokal. Untuk mengelola pekerjaan, gunakan cmdlet Pekerjaan. Untuk mendapatkan hasil pekerjaan, gunakan cmdlet Receive-Job.
Untuk menggunakan parameter ini, komputer lokal dan jarak jauh harus dikonfigurasi untuk jarak jauh, dan pada Windows Vista dan versi sistem operasi Windows yang lebih baru, Anda harus membuka Windows PowerShell dengan opsi Jalankan sebagai administrator. Untuk informasi lebih lanjut, lihat about_Remote_Requirements.
Untuk informasi selengkapnya tentang pekerjaan latar belakang Windows PowerShell, lihat about_Jobs dan about_Remote_Jobs.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-CimSession
Menjalankan cmdlet dalam sesi jarak jauh atau pada komputer jarak jauh. Masukkan nama komputer atau objek sesi, seperti output cmdlet New-CimSession atau Get-CimSession.
Properti parameter
| Jenis: | |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | Sesi |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Confirm
Meminta konfirmasi sebelum menjalankan cmdlet.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | Cf |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Force
Menunjukkan bahwa cmdlet ini menghentikan pekerjaan konfigurasi yang sedang berjalan sebelum menghapus dokumen konfigurasi. Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Stage
Menentukan dokumen konfigurasi mana yang akan dihapus. Anda dapat menentukan beberapa dokumen. Nilai yang dapat diterima untuk parameter ini adalah:
-
Current- Hapus dokumen konfigurasi yang menjelaskan status sistem saat ini. -
Pending- Hapus dokumen konfigurasi yang menjelaskan status sistem yang tertunda. -
Previous- Hapus dokumen konfigurasi yang menjelaskan status sistem sebelumnya.
Properti parameter
| Jenis: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| Nilai default: | None |
| Nilai yang diterima: | Current, Pending, Previous |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-ThrottleLimit
Menentukan jumlah maksimum operasi bersamaan yang dapat dibuat untuk menjalankan cmdlet. Jika parameter ini dihilangkan atau nilai 0 dimasukkan, maka Windows PowerShell menghitung batas pembatasan optimal untuk cmdlet berdasarkan jumlah cmdlet CIM yang berjalan di komputer. Batas pembatasan hanya berlaku untuk cmdlet saat ini, bukan ke sesi atau ke komputer.
Properti parameter
| Jenis: | Int32 |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-WhatIf
Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | wi |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
