Save-Help

Save-Help cmdlet'i PowerShell modülleri için en yeni yardım dosyalarını indirir ve bunları belirttiğiniz bir dizine kaydeder. Bu özellik, İnternet erişimi olmayan bilgisayarlardaki yardım dosyalarını güncelleştirmenizi sağlar ve birden çok bilgisayarda yardım dosyalarını güncelleştirmenizi kolaylaştırır. Bu cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur.

Windows PowerShell 4.0'da başlayarak, Save-Help kullanarak uzak bilgisayarlara yüklenen modüllerin yardım dosyalarını indirebilirsiniz. İnternet erişimi olmayan bir bilgisayarda Export-Clixml kullanarak PSModuleInfo nesnesini kaydetmek, nesneyi İnternet erişimi olan bir bilgisayarda içeri aktarmak ve ardından PSModuleInfo nesnesinde Save-Help çalıştırmak da mümkündür. Kaydedilen yardımı aldıktan sonra, uzak bilgisayara kopyalayabilir ve Update-Helpkomutunu çalıştırarak yükleyebilirsiniz. Bu işlem, herhangi bir ağ erişimi olmayan bilgisayarlara yardım yüklemek için kullanılabilir.

Parametreler olmadan, Save-Help komutu oturumdaki tüm modüller ve PSModulePath ortam değişkeninde listelenen bir konumda bilgisayara yüklenen modüller için en yeni yardımı indirir. Bu eylem, uyarı olmadan Güncelleştirilebilir Yardımı desteklemeyen modülleri atlar.

Save-Help cmdlet'i hedef klasördeki tüm yardım dosyalarının sürümünü denetler. Daha yeni yardım dosyaları varsa, bu cmdlet İnternet'ten en yeni yardım dosyalarını indirir ve sonra bunları klasöre kaydeder. Save-Help cmdlet'i, yardım dosyalarını ayıklamak ve bilgisayara yüklemek yerine indirilen içeriği kaydetmesi dışında, Update-Help cmdlet'i gibi çalışır.

Her modül için kaydedilen yardım, her dildeki yardım dosyaları için bir yardım bilgisi (HelpInfo XML) dosyası ve bir dolap veya ZIP arşivi (.cab veya .zip) içerir. Windows'da, komut dolap dosyalarını indirir. Linux ve macOS'ta komutu ZIP dosyalarını indirir.

Modüllerin yardım dosyalarını PowerShell yükleme klasörüne ($PSHOME\Modules) kaydetmek için Yönetici olarak çalıştır seçeneğinikullanarak PowerShell'i başlatın. Bu modüllerin yardım dosyalarını indirmek için bilgisayardaki Administrators grubunun bir üyesi olmanız gerekir.

Kaydedilen yardım dosyalarını yüklemek için, kaydedilen Yardım dosyalarını içeren klasörü belirtmek üzere SourcePath parametresiyle Update-Help çalıştırın. Update-Help arşivden yardım dosyalarını ayıklar ve uygun konuma yükler.

Bu örnekte, DhcpServer modülünü veya dhcp sunucusu rolünü yerel bilgisayara yüklemeden İnternet'e bağlı bir istemci bilgisayardan DhcpServer modülüne yönelik yardımı kaydetmek için Save-Help kullanmanın üç farklı yolu gösterilmektedir.

# 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"

Bu örnekte, ağa bağlı olmayan bir bilgisayar için nasıl yardım yükleneceği gösterilmektedir. Bu örnekte, ilk bilgisayar erişilebilir bir ağa bağlı değildir. Dosyalar çıkarılabilir medya kullanılarak kopyalanmalıdır. İkinci bilgisayar İnternet'e bağlıdır ve yardım dosyalarını indirebilir.

# 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

Bu komut, yerel bilgisayardaki tüm modüller için en yeni yardım dosyalarını indirir. Yardım dosyalarını \\Server01\Fileshare01 klasörüne kaydeder.

Save-Help -DestinationPath \\Server01\FileShare01

Bu komut, ServerManager modülü için en yeni yardım dosyalarını indirir ve sonra bunları \\Server01\Fileshare01 klasörüne kaydeder.

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

Bilgisayara bir modül yüklendiğinde, modül geçerli oturuma aktarılmıyor olsa bile modül adını Modülü parametresinin değeri olarak yazabilirsiniz.

komut, dosya paylaşımına yazma izni olan bir kullanıcının kimlik bilgilerini sağlamak için Kimlik Bilgisi parametresini kullanır.

Bu komutlar, CustomSQL modülü için en yeni yardım dosyalarını indirir ve \\Server01\Fileshare01 klasörüne kaydeder.

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

CustomSQL modülü bilgisayarda yüklü olmadığından, sıra, Server02 bilgisayarından CustomSQL modülü için modül nesnesini alan ve ardından modül nesnesini Save-Help cmdlet'ine aktaran bir Invoke-Command komutu içerir.

Bilgisayarda bir modül yüklü olmadığında, Save-Help en yeni yardım dosyalarının konumu hakkında bilgi içeren modül nesnesine ihtiyaç duyar.

Bu komut, dört farklı kullanıcı arabirimi kültüründeki temel PowerShell modülleri için yardım kaydeder. Bu yerel ayarlar için dil paketlerinin bilgisayara yüklenmesi gerekmez.

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

Save-Help, farklı ui kültürlerindeki modüller için yardım dosyalarını yalnızca modül sahibi çevrilmiş dosyaları İnternet'te kullanılabilir hale getirdiğinde indirebilir.

Bu komut, bilgisayarda yüklü olan tüm modüller için yardım kaydeder. komutu, cmdlet'in her 24 saatlik süre içinde yardımı birden çok kez indirmesini engelleyen kuralı geçersiz kılmak için Save-Help parametresini belirtir.

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

Force parametresi de 1 GB kısıtlamasını geçersiz kılar ve sürüm denetimini atlatır. Bu nedenle, sürüm hedef klasördeki sürümden daha geç olmasa bile dosyaları indirebilirsiniz.

komut, yardım dosyalarını indirmek ve belirtilen klasöre kaydetmek için Save-Help cmdlet'ini kullanır. her gün birden fazla komutu çalıştırmanız gerektiğinde Save-Help parametresi gereklidir.

PSModuleInfo

Bir modül nesnesini bu cmdlet'e aktarabilirsiniz.

None

Bu cmdlet çıkış döndürmez.

• $PSHOME\Modules klasöründeki modüller için yardım kaydetmek için Yönetici olarak çalıştır seçeneğini kullanarak PowerShell'i başlatın. yalnızca bilgisayardaki Administrators grubunun üyeleri $PSHOME\Modules klasöründeki modüller için yardım indirebilir.
• Her modül için kaydedilen yardım, bir yardım bilgisi (HelpInfo XML) dosyası ve her ui kültürü için yardım dosyaları için bir dolap (.cab) dosyasından oluşur. Dolap dosyasından yardım dosyalarını ayıklamanız gerekmez. Update-Help cmdlet'i yardım dosyalarını ayıklar, XML'yi doğrular ve ardından yardım dosyalarını ve yardım bilgileri dosyasını modül klasörünün dile özgü alt klasörüne yükler.
• Save-Help cmdlet'i, bilgisayarda yüklü olmayan modüller için yardım kaydedebilir. Ancak, yardım dosyaları modül klasörüne yüklendiğinden, Update-Help cmdlet yalnızca bilgisayarda yüklü modüller için güncelleştirilmiş yardım dosyasını yükleyebilir.
• Save-Help bir modülün güncelleştirilmiş yardım dosyalarını bulamıyorsa veya belirtilen dilde güncelleştirilmiş yardım dosyalarını bulamıyorsa, hata iletisi görüntülemeden sessizce devam eder. Komutu tarafından hangi dosyaların kaydedildiğini görmek için Ayrıntılı parametresini belirtin.
• Modüller, güncelleştirilebilir yardımın en küçük birimidir. Belirli bir cmdlet için, yalnızca modüldeki tüm cmdlet'ler için yardım kaydedemezsiniz. Belirli bir cmdlet içeren modülü bulmak için cmdlet'iyle birlikte Get-Command özelliğini kullanın, örneğin, (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help tüm modülleri ve temel PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez.
• Update-Help ve Save-Help cmdlet'leri, yardım dosyalarını indirmek için aşağıdaki bağlantı noktalarını kullanır: HTTP için 80 numaralı bağlantı noktası ve HTTPS için 443 numaralı bağlantı noktası.
• Update-Help ve Save-Help cmdlet'leri Windows Önyükleme Ortamı'nda (Windows PE) desteklenmez.