Save-Help

cmdlet Save-Help mengunduh file bantuan terbaru untuk modul PowerShell dan menyimpannya ke direktori yang Anda tentukan. Fitur ini memungkinkan Anda memperbarui file bantuan di komputer yang tidak memiliki akses ke internet, dan memudahkan untuk memperbarui file bantuan di beberapa komputer. Cmdlet ini diperkenalkan di Windows PowerShell 3.0.

Dimulai di Windows PowerShell 4.0, Anda dapat menggunakan Save-Help untuk mengunduh file bantuan untuk modul yang diinstal di komputer jarak jauh. Anda juga dapat menyimpan objek PSModuleInfo menggunakan Export-Clixml di komputer yang tidak memiliki akses internet, mengimpor objek di komputer yang memang memiliki akses internet, lalu menjalankan Save-Help pada objek PSModuleInfo. Setelah Anda memiliki bantuan yang disimpan, Anda dapat menyalinnya ke komputer jarak jauh dan menginstalnya dengan menjalankan Update-Help. Proses ini dapat digunakan untuk menginstal bantuan pada komputer yang tidak memiliki akses jaringan apa pun.

Tanpa parameter, perintah Save-Help mengunduh bantuan terbaru untuk semua modul dalam sesi dan untuk modul yang diinstal pada komputer di lokasi yang tercantum dalam variabel lingkungan PSModulePath. Tindakan ini melewati modul yang tidak mendukung Bantuan yang Dapat Diperbarui tanpa peringatan.

cmdlet Save-Help memeriksa versi file bantuan apa pun di folder tujuan. Jika file bantuan yang lebih baru tersedia, cmdlet ini mengunduh file bantuan terbaru dari internet, lalu menyimpannya di folder. Cmdlet Save-Help berfungsi seperti cmdlet Update-Help, kecuali bahwa cmdlet menyimpan konten yang diunduh, alih-alih mengekstrak file bantuan dan menginstalnya di komputer.

Bantuan yang disimpan untuk setiap modul terdiri dari satu file informasi bantuan (HELPInfo XML) dan arsip kabinet atau ZIP (.cab atau .zip) untuk file bantuan dalam setiap bahasa. Di Windows, perintah mengunduh file kabinet. Di Linux dan macOS, perintah mengunduh file ZIP.

Untuk menyimpan file bantuan untuk modul di folder penginstalan PowerShell ($PSHOME\Modules), mulai PowerShell dengan menggunakan opsi Jalankan sebagai administrator. Anda harus menjadi anggota grup Administrator di komputer untuk mengunduh file bantuan untuk modul ini.

Untuk menginstal file bantuan tersimpan, jalankan Update-Help dengan parameter SourcePath untuk menentukan folder yang berisi file Bantuan yang disimpan. Update-Help mengekstrak file bantuan dari arsip dan menginstalnya di lokasi yang sesuai.

Contoh ini menunjukkan tiga cara berbeda untuk menggunakan Save-Help untuk menyimpan bantuan untuk modul DhcpServer dari komputer klien yang terhubung ke internet, tanpa menginstal modul DhcpServer atau peran Server DHCP di komputer lokal.

# Option 1:
# 1. Run Invoke-Command to get the PSModuleInfo object for the DhcpServer module,
# 2. Save-Help on the PSModuleInfo object to save the help files to a folder on
#    the local computer.

$mod = Invoke-Command -ComputerName RemoteServer -ScriptBlock {
    Get-Module -Name DhcpServer -ListAvailable
}
Save-Help -Module $mod -DestinationPath C:\SavedHelp


# Option 2:
# 1. Open a PSSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object

$session = New-PSSession -ComputerName "RemoteServer"
$mod = Get-Module -PSSession $session -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath C:\SavedHelp


# Option 3:
# 1. Open a CimSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object
$cimsession = New-CimSession -ComputerName "RemoteServer"
$mod = Get-Module -CimSession $cimsession -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath "C:\SavedHelp"

Contoh ini memperlihatkan cara menginstal bantuan untuk komputer yang tidak tersambung ke jaringan. Untuk contoh ini, komputer pertama tidak tersambung ke jaringan yang dapat diakses. File harus disalin ke dalamnya menggunakan media yang dapat dilepas. Komputer kedua terhubung ke internet dan dapat mengunduh file bantuan.

# On the first computer, get the PSModuleInfo object for the module and save it to
# removable media.

Get-Module -Name "DhcpServer" -ListAvailable |
    Export-CliXml -Path E:\UsbFlashDrive\DhcpModule.xml

# Move the removable media to a computer that has internet access, and then import the
# PSModuleInfo object. Run Save-Help on the imported PSModuleInfo object and save the help
# files to the removable media.

$moduleInfo = Import-CliXml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $moduleInfo -DestinationPath E:\UsbFlashDrive\SavedHelp

# Finally, move the removable media back to the first computer and install the help.

Update-Help -Module DhcpServer -SourcePath E:\UsbFlashDrive\SavedHelp

Perintah ini mengunduh file bantuan terbaru untuk semua modul di komputer lokal. Ini menyimpan file bantuan di folder \\Server01\Fileshare01.

Save-Help -DestinationPath \\Server01\FileShare01

Perintah ini mengunduh file bantuan terbaru untuk modul ServerManager, lalu menyimpannya di folder \\Server01\Fileshare01.

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

Saat modul diinstal di komputer, Anda dapat mengetikkan nama modul sebagai nilai parameter Modul, bahkan jika modul tidak diimpor ke sesi saat ini.

Perintah menggunakan parameter Kredensial untuk memberikan kredensial pengguna yang memiliki izin untuk menulis ke berbagi file.

Perintah ini mengunduh file bantuan terbaru untuk modul CustomSQL dan menyimpannya di folder \\Server01\Fileshare01.

Invoke-Command -ComputerName Server02 { Get-Module -Name CustomSQL -ListAvailable } |
    Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Karena modul CustomSQL tidak diinstal di komputer, urutan menyertakan perintah Invoke-Command yang mendapatkan objek modul untuk modul CustomSQL dari komputer Server02 lalu menyalurkan objek modul ke cmdlet Save-Help.

Saat modul tidak diinstal di komputer, Save-Help memerlukan objek modul, yang mencakup informasi tentang lokasi file bantuan terbaru.

Perintah ini menyimpan bantuan untuk modul PowerShell inti dalam empat budaya UI yang berbeda. Paket bahasa untuk lokal ini tidak harus diinstal pada komputer.

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

Save-Help dapat mengunduh file bantuan untuk modul dalam budaya UI yang berbeda hanya ketika pemilik modul membuat file yang diterjemahkan tersedia di internet.

Perintah ini menyimpan bantuan untuk semua modul yang diinstal pada komputer. Perintah menentukan parameter Force untuk mengambil alih aturan yang mencegah cmdlet Save-Help mengunduh bantuan lebih dari sekali dalam setiap periode 24 jam.

Save-Help -Force -DestinationPath \\Server3\AdminShare\Help

Parameter Force juga mengambil alih pembatasan 1 GB dan menghindari pemeriksaan versi. Oleh karena itu, Anda dapat mengunduh file meskipun versinya tidak lebih baru dari versi di folder tujuan.

Perintah menggunakan cmdlet Save-Help untuk mengunduh dan menyimpan file bantuan ke folder yang ditentukan. Parameter Force diperlukan ketika Anda harus menjalankan perintah Save-Help lebih dari satu kali setiap hari.

PSModuleInfo

Anda dapat menyalurkan objek modul ke cmdlet ini.

None

Cmdlet ini tidak mengembalikan output.

• Untuk menyimpan bantuan untuk modul di folder $PSHOME\Modules, mulai PowerShell dengan menggunakan opsi Jalankan sebagai administrator. Hanya anggota grup Administrator di komputer yang dapat mengunduh bantuan untuk modul di folder $PSHOME\Modules.
• Bantuan yang disimpan untuk setiap modul terdiri dari satu file informasi bantuan (HELPInfo XML) dan satu file kabinet (.cab) untuk file bantuan setiap budaya UI. Anda tidak perlu mengekstrak file bantuan dari file kabinet. cmdlet Update-Help mengekstrak file bantuan, memvalidasi XML, lalu menginstal file bantuan dan file informasi bantuan dalam subfolder khusus bahasa folder modul.
• Cmdlet Save-Help dapat menyimpan bantuan untuk modul yang tidak diinstal di komputer. Namun, karena file bantuan diinstal di folder modul, cmdlet Update-Help dapat menginstal file bantuan yang diperbarui hanya untuk modul yang diinstal di komputer.
• Jika Save-Help tidak dapat menemukan file bantuan yang diperbarui untuk modul, atau tidak dapat menemukan file bantuan yang diperbarui dalam bahasa yang ditentukan, file tersebut berlanjut secara diam-diam tanpa menampilkan pesan kesalahan. Untuk melihat file mana yang disimpan oleh perintah, tentukan parameter Verbose.
• Modul adalah unit terkecil dari bantuan yang dapat diperbarui. Anda tidak dapat menyimpan bantuan untuk cmdlet tertentu, hanya untuk semua cmdlet dalam modul. Untuk menemukan modul yang berisi cmdlet tertentu, gunakan properti ModuleName bersama dengan cmdlet Get-Command, misalnya, (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help mendukung semua modul dan snap-in Inti PowerShell. Ini tidak mendukung snap-in lainnya.
• Cmdlet Update-Help dan Save-Help menggunakan port berikut untuk mengunduh file bantuan: Port 80 untuk HTTP dan port 443 untuk HTTPS.
• Cmdlet Update-Help dan Save-Help tidak didukung pada Windows Preinstallation Environment (Windows PE).