about_Updatable_Help
Deskripsi singkat
Menjelaskan sistem bantuan yang dapat diperbarui di PowerShell.
Deskripsi panjang
PowerShell menyediakan beberapa cara berbeda untuk mengakses topik bantuan terbaru untuk cmdlet dan konsep PowerShell.
Sistem Bantuan yang Dapat Diperbarui, yang diperkenalkan di PowerShell 3.0, dirancang untuk memastikan bahwa Anda selalu memiliki topik bantuan terbaru di komputer lokal Anda sehingga Anda dapat membacanya di baris perintah. Ini memudahkan untuk mengunduh dan menginstal file bantuan dan memperbaruinya setiap kali file bantuan yang lebih baru tersedia.
Untuk memberikan bantuan yang diperbarui untuk beberapa komputer di perusahaan dan untuk komputer yang tidak memiliki akses ke internet, Bantuan yang Dapat Diperbarui memungkinkan Anda mengunduh file bantuan ke direktori sistem file atau berbagi file, lalu menginstal file bantuan dari berbagi file.
Di PowerShell 4.0, properti HelpInfoUri dipertahankan melalui jarak jauh Windows PowerShell, yang memungkinkan Save-Help
untuk bekerja untuk modul yang diinstal di komputer jarak jauh, tetapi belum tentu diinstal di komputer lokal. Anda dapat menyimpan objek PSModuleInfo ke disk atau media yang dapat dilepas (seperti drive USB) dengan menjalankan Export-Clixml
di komputer yang tidak memiliki akses internet, mengimpor objek PSModuleInfo di komputer yang memang memiliki akses internet, lalu berjalan Save-Help
pada objek PSModuleInfo . Bantuan yang disimpan dapat disalin ke komputer jarak jauh yang terputus dengan menggunakan media yang dapat dilepas, lalu diinstal dengan menjalankan Update-Help
. Peningkatan Save-Help
fungsionalitas ini memungkinkan Anda menginstal bantuan di komputer yang tanpa akses jaringan apa pun. Untuk contoh cara menggunakan fungsionalitas baru Save-Help
, lihat Cara memperbarui bantuan dari berbagi file dalam topik ini.
Bantuan yang Dapat Diperbarui juga mendukung akses online ke topik bantuan terbaru dan bantuan dasar untuk cmdlet, bahkan ketika tidak ada file bantuan di komputer.
PowerShell tidak dilengkapi dengan file Bantuan. Anda dapat menggunakan fitur Bantuan yang Dapat Diperbarui untuk menginstal file bantuan untuk semua perintah yang disertakan secara default di PowerShell dan untuk semua modul Windows.
Cmdlet bantuan yang dapat diperbarui
Update-Help
: Mengunduh file bantuan terbaru dari internet atau berbagi file, dan menginstalnya di komputer lokal.Save-Help
: Mengunduh file bantuan terbaru dari internet dan menyimpannya dalam direktori sistem file atau berbagi file. Untuk menginstal file bantuan di komputer, gunakanUpdate-Help
.Get-Help
: Menampilkan topik bantuan di baris perintah. Mendapatkan bantuan dari file bantuan di komputer. Menampilkan bantuan yang dihasilkan secara otomatis untuk cmdlet dan fungsi yang tidak memiliki file bantuan. Membuka topik bantuan online untuk cmdlet, fungsi, skrip, dan alur kerja di browser internet default Anda.
Bantuan yang dihasilkan secara otomatis: bantuan tanpa file bantuan
Jika Anda tidak memiliki file bantuan untuk cmdlet, fungsi, atau alur kerja di komputer, Get-Help
cmdlet menampilkan bantuan yang dihasilkan secara otomatis dan meminta Anda untuk mengunduh file bantuan atau membacanya secara online.
Bantuan yang dihasilkan secara otomatis mencakup sintaks dan alias, dan komentar yang menjelaskan cara menggunakan cmdlet Bantuan yang Dapat Diperbarui dan untuk mengakses topik bantuan online.
Misalnya, perintah berikut mendapatkan bantuan dasar untuk Get-Culture
cmdlet. Output menunjukkan Get-Help
tampilan ketika tidak ada file bantuan di komputer.
Get-Help Get-Culture
NAME
Get-Culture
SYNTAX
Get-Culture [<CommonParameters>]
ALIASES
None
REMARKS
To get the latest Help content including descriptions and examples
type: Update-Help.
File bantuan untuk modul
Unit terkecil dari Bantuan yang Dapat Diperbarui adalah bantuan untuk modul. Bantuan modul mencakup bantuan untuk semua cmdlet, fungsi, alur kerja, penyedia, skrip, dan konsep dalam modul. Anda dapat memperbarui bantuan untuk semua modul yang diinstal di komputer, meskipun tidak diimpor ke sesi saat ini.
Anda dapat memperbarui bantuan untuk seluruh modul, tetapi Anda tidak dapat memperbarui bantuan untuk cmdlet individual.
Untuk menemukan modul yang berisi cmdlet tertentu, gunakan format perintah berikut:
(Get-Command <cmdlet-name>).ModuleName
Misalnya, untuk menemukan modul yang berisi Set-ExecutionPolicy
cmdlet, ketik:
(Get-Command Set-ExecutionPolicy).ModuleName
Untuk memperbarui bantuan untuk modul tertentu, ketik:
Update-Help -Module <ModuleName>
Misalnya, untuk memperbarui bantuan untuk modul yang berisi cmdlet Set-ExecutionPolicy, ketik:
Update-Help -Module Microsoft.PowerShell.Security
Izin untuk bantuan yang dapat diperbarui
Untuk memperbarui bantuan untuk modul di direktori $pshome/Modules
, Anda harus menjadi anggota grup Administrator di komputer.
Jika Anda bukan anggota grup Administrator, Anda tidak dapat memperbarui bantuan untuk modul ini; tetapi jika Anda memiliki akses internet, Anda dapat melihat bantuan secara online.
Memperbarui bantuan untuk modul di direktori $HOME/Documents/PowerShell/Modules
atau modul di subdirektori lain dari $HOME
direktori tidak memerlukan izin khusus.
Update-Help
cmdlet dan Save-Help
memiliki parameter UseDefaultCredentials yang menyediakan kredensial eksplisit pengguna saat ini. Parameter ini dirancang untuk mengakses lokasi internet yang aman.
Update-Help
cmdlet dan Save-Help
juga memiliki parameter Kredensial yang memungkinkan Anda menjalankan perintah di komputer jarak jauh dan mengakses berbagi file di komputer ketiga. Parameter Kredensial hanya valid saat Anda menggunakan parameter SourcePath atau LiteralPath dan Update-Help
parameter DestinationPath atau LiteralPath dari Save-Help
.
Cara menginstal dan memperbarui file bantuan
Untuk mengunduh dan menginstal file bantuan untuk pertama kalinya, atau memperbarui file bantuan di komputer Anda, gunakan Update-Help
cmdlet .
Update-Help
Cmdlet melakukan semua kerja keras untuk Anda, termasuk tugas-tugas berikut.
- Menentukan modul mana yang mendukung Bantuan yang Dapat Diperbarui.
- Menemukan lokasi internet tempat setiap modul menyimpan file Bantuan yang Dapat Diperbarui.
- Membandingkan file bantuan untuk setiap modul di komputer Anda dengan file bantuan terbaru yang tersedia untuk setiap modul.
- Mengunduh file baru dari internet.
- Membongkar paket file bantuan.
- Memverifikasi bahwa file adalah file bantuan yang valid.
- Menginstal file bantuan dalam subdirektori khusus bahasa direktori modul.
Untuk mengakses topik bantuan baru, gunakan Get-Help
cmdlet . Anda tidak perlu memulai ulang PowerShell.
Untuk menginstal atau memperbarui bantuan untuk semua modul di komputer yang mendukung Bantuan yang Dapat Diperbarui, ketik:
Update-Help
Untuk memperbarui bantuan untuk modul tertentu, tambahkan parameter Modul dari Update-Help
. Karakter kartubebas diizinkan dalam nama modul.
Misalnya, untuk memperbarui bantuan untuk modul ServerManager, ketik:
Update-Help -Module ServerManager
Tanpa parameter, Update-Help
pembaruan membantu untuk semua modul dalam sesi dan untuk semua modul yang diinstal yang mendukung Bantuan yang Dapat Diperbarui. Untuk disertakan, modul harus diinstal dalam direktori yang tercantum dalam nilai variabel lingkungan PSModulePath. Ini juga merupakan modul yang dikembalikan oleh Get-Module -ListAvailable
perintah.
Jika nilai parameter Modul adalah *
(semua), Update-Help
upaya untuk memperbarui bantuan untuk semua modul yang diinstal, termasuk modul yang tidak mendukung Bantuan yang Dapat Diperbarui. Perintah ini biasanya menghasilkan banyak kesalahan karena cmdlet menemukan modul yang tidak mendukung Bantuan yang Dapat Diperbarui.
Cara memperbarui bantuan dari berbagi file
Untuk mendukung komputer yang tidak tersambung ke internet, atau untuk mengontrol atau menyederhanakan bantuan memperbarui di perusahaan, gunakan Save-Help
cmdlet. Cmdlet Save-Help
mengunduh file bantuan dari internet dan menyimpannya dalam direktori sistem file yang Anda tentukan.
Save-Help
membandingkan file bantuan dalam direktori yang ditentukan dengan file bantuan terbaru yang tersedia untuk setiap modul. Jika direktori tidak memiliki file bantuan atau file bantuan yang lebih baru yang tersedia untuk modul, Save-Help
cmdlet mengunduh file baru dari internet. Namun, itu tidak membuka bungkus atau menginstal file bantuan.
Untuk menginstal atau memperbarui file bantuan di komputer dari file bantuan yang disimpan ke direktori sistem file, gunakan parameter SourcePath cmdlet Update-Help
. Update-Help
Cmdlet mengidentifikasi file bantuan terbaru, membongkar dan memvalidasinya, dan menginstalnya dalam subdirektori khusus bahasa direktori modul.
Misalnya, untuk menyimpan bantuan untuk semua modul yang diinstal ke \\Server\Share
direktori, ketik:
Save-Help -DestinationPath \\Server\Share
Kemudian, untuk memperbarui bantuan dari \\Server\Share
direktori, ketik:
Update-Help -SourcePath \\Server\Share
Contoh berikut menunjukkan penggunaan Save-Help
untuk menyimpan bantuan untuk modul yang tidak diinstal di komputer lokal. Dalam contoh ini, administrator menjalankan Save-Help
untuk menyimpan bantuan untuk modul DhcpServer dari komputer klien yang terhubung ke internet, tanpa menginstal modul DhcpServer atau peran DHCP Server di komputer lokal.
Opsi 1: Jalankan untuk mendapatkan objek PSModuleInfo untuk modul jarak jauh, simpan dalam variabel, $m
, lalu jalankan Invoke-Command
Save-Help
pada objek PSModuleInfo dengan menentukan variabel $m
sebagai nama modul.
$invokeCommandSplat = @{
ComputerName = 'RemoteServer'
ScriptBlock = { Get-Module -Name DhcpServer -ListAvailable }
}
$m = Invoke-Command @invokeCommandSplat
Save-Help -Module $m -DestinationPath C:\SavedHelp
Opsi 2: Buka PSSession yang ditargetkan di komputer yang menjalankan modul Server DHCP, untuk mendapatkan objek PSModuleInfo untuk modul, simpan dalam variabel $m
, lalu jalankan Save-Help
pada objek yang disimpan dalam $m
variabel.
$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp
Opsi 3: Buka sesi CIM, yang ditargetkan di komputer yang menjalankan modul Server DHCP, untuk mendapatkan objek PSModuleInfo untuk modul, simpan dalam variabel $m
, lalu jalankan Save-Help
pada objek yang disimpan dalam $m
variabel.
$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp
Dalam contoh berikut, administrator menginstal bantuan untuk modul Server DHCP di komputer yang tidak memiliki akses jaringan.
Pertama, jalankan Export-Clixml
untuk mengekspor objek PSModuleInfo ke folder bersama atau ke media yang dapat dilepas.
$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m
Selanjutnya, transportasikan media yang dapat dilepas ke komputer yang memiliki akses internet, lalu impor objek PSModuleInfo dengan Import-Clixml
. Jalankan Save-Help
untuk menyimpan Bantuan untuk objek PSModuleInfo modul DhcpServer yang diimpor.
$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp
Terakhir, angkut media yang dapat dilepas kembali ke komputer yang tidak memiliki akses jaringan, lalu instal bantuan dengan menjalankan Update-Help
.
Update-Help -Module DhcpServer -SourcePath E:\UsbDrive\SavedHelp
Tanpa parameter, Save-Help
unduhan membantu untuk semua modul dalam sesi dan untuk semua modul yang diinstal yang mendukung Bantuan yang Dapat Diperbarui. Untuk disertakan, modul harus diinstal dalam direktori yang tercantum dalam nilai $env:PSModulePath
variabel lingkungan, pada komputer lokal atau di komputer jarak jauh yang ingin Anda simpan bantuannya. Ini juga merupakan modul yang dikembalikan dengan menjalankan Get-Help -ListAvailable
perintah.
Cara memperbarui file bantuan dalam bahasa yang berbeda
Secara default, Update-Help
cmdlet dan Save-Help
mengunduh bantuan dalam budaya dan bahasa UI yang diatur untuk Windows di komputer lokal. Jika file bantuan untuk modul yang ditentukan tidak tersedia dalam budaya UI lokal, Update-Help
dan Save-Help
gunakan aturan fallback bahasa Windows untuk menemukan bahasa yang didukung terbaik.
Namun, Anda dapat menggunakan parameter UICulture dari Update-Help
cmdlet dan Save-Help
untuk mengunduh dan menginstal file bantuan di budaya UI mana pun di mana mereka tersedia.
Misalnya, untuk menyimpan file bantuan terbaru untuk semua modul pada sesi dalam bahasa Jepang (ja-Jp) dan Prancis (fr-FR), ketik:
Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr
Jika file bantuan untuk modul tidak tersedia dalam bahasa yang Anda tentukan, Update-Help
cmdlet dan Save-Help
mengembalikan pesan kesalahan yang mencantumkan bahasa tempat bantuan untuk setiap modul tersedia sehingga Anda dapat memilih alternatif yang paling sesuai dengan kebutuhan Anda.
Catatan
Saat ini, konten Bantuan yang Dapat Diperbarui hanya diterbitkan dalam bahasa Inggris (id-ID).
Cara menggunakan bantuan online
Jika Anda tidak bisa atau memilih untuk tidak memperbarui file bantuan di komputer lokal, Anda masih bisa mendapatkan file bantuan terbaru secara online.
Untuk membuka topik bantuan online untuk cmdlet atau fungsi apa pun, gunakan parameter Online cmdlet Get-Help
.
Misalnya, perintah berikut membuka topik bantuan online untuk Get-Job
cmdlet di browser internet default Anda:
Get-Help Get-Job -Online
Untuk mendapatkan bantuan online untuk skrip, gunakan parameter Online dan jalur lengkap ke skrip.
Parameter Online tidak berfungsi dengan topik Tentang. Untuk melihat topik tentang PowerShell, termasuk topik bantuan tentang bahasa PowerShell, lihat PowerShell Tentang Topik.
Cara meminimalkan atau mencegah unduhan internet
Untuk meminimalkan unduhan internet dan menyediakan Bantuan yang Dapat Diperbarui kepada pengguna yang tidak terhubung ke internet, gunakan Save-Help
cmdlet . Unduh bantuan dari internet dan simpan ke berbagi jaringan. Kemudian, buat pengaturan Kebijakan Grup atau pekerjaan terjadwal yang menjalankan Update-Help
perintah di semua komputer. Atur nilai parameter SourcePath cmdlet Update-Help
ke berbagi jaringan.
Untuk mencegah pengguna yang memiliki akses internet mengunduh Bantuan yang Dapat Diperbarui dari internet, gunakan pengaturan Atur jalur sumber default untuk Kebijakan Grup Pembaruan-Bantuan .
Pengaturan Kebijakan Grup ini secara implisit menambahkan parameter SourcePath , dengan lokasi sistem file yang Anda tentukan, ke setiap Update-Help
perintah di setiap komputer yang terpengaruh. Pengguna dapat menggunakan parameter SourcePath secara eksplisit untuk menentukan lokasi sistem file yang berbeda, tetapi mereka tidak dapat mengecualikan parameter SourcePath dan mengunduh bantuan dari internet.
Catatan
Pengaturan Atur jalur sumber default untuk kebijakan grup Pembaruan-Bantuan muncul di bawah Konfigurasi Komputer dan Konfigurasi Pengguna. Namun, hanya pengaturan kebijakan di bawah Konfigurasi Komputer yang efektif. Pengaturan kebijakan di bawah Konfigurasi Pengguna diabaikan.
Untuk mengetahui informasi selengkapnya, lihat about_Group_Policy_Settings.
Cara memperbarui bantuan untuk modul non-standar
Untuk memperbarui atau menyimpan bantuan untuk modul yang tidak dikembalikan oleh parameter Get-Module
cmdlet listAvailable, impor modul ke sesi saat ini sebelum menjalankan perintah Update-Help
atau Save-Help
. Pada komputer jarak jauh, sebelum menjalankan Save-Help
perintah, impor modul ke sesi saat ini, atau Invoke-Command
blok skrip, yang tersambung ke komputer jarak jauh.
Saat modul berada dalam sesi saat ini, jalankan Update-Help
cmdlet atau Save-Help
tanpa parameter, atau gunakan parameter Modul untuk menentukan nama modul.
Parameter Modul dari Update-Help
cmdlet dan Save-Help
hanya menerima nama modul. Mereka tidak menerima jalur ke file modul.
Gunakan teknik ini untuk memperbarui atau menyimpan bantuan untuk modul apa pun yang tidak dikembalikan oleh parameter Get-Module
cmdlet yang dapat tersedia, seperti modul yang diinstal di lokasi yang tidak tercantum dalam $env:PSModulePath
variabel lingkungan, atau modul yang tidak terbentuk dengan baik (direktori modul tidak berisi setidaknya satu file yang nama dasarnya sama dengan nama direktori).
Cara mendukung bantuan yang dapat diperbarui
Jika Anda menulis modul, Anda dapat mendukung bantuan online dan Bantuan yang Dapat Diperbarui untuk modul Anda. Untuk informasi selengkapnya, lihat Mendukung Bantuan yang Dapat Diperbarui dan Bantuan Online Pendukung.
Bantuan yang dapat diperbarui tidak tersedia untuk snap-in PowerShell atau bantuan berbasis komentar.
Keterangan
Update-Help
cmdlet dan Save-Help
tidak didukung pada Windows Preinstallation Environment (Windows PE).
Lihat juga
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk