Save-Help
En yeni yardım dosyalarını indirir ve bir dosya sistemi dizinine kaydeder.
Syntax
Save-Help
[-DestinationPath] <String[]>
[[-Module] <PSModuleInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[<CommonParameters>]Save-Help
-LiteralPath <String[]>
[[-Module] <PSModuleInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[<CommonParameters>]Description
Cmdlet, Save-Help 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ştirmenize olanak tanır ve birden çok bilgisayarda yardım dosyalarını güncelleştirmenizi kolaylaştırır.
Windows PowerShell 3.0'da, Save-Help yalnızca yerel bilgisayarda yüklü olan modüller için çalıştı. Uzak bir bilgisayardan bir modülü içeri aktarmak veya PowerShell uzaktan iletişimini kullanarak uzak bir bilgisayardan PSModuleInfo nesnesine başvuru almak mümkün olsa da, HelpInfoUri özelliği korunmadı ve Save-Help uzak modül Yardımı için çalışmaz.
Windows PowerShell 4.0'da HelpInfoUri özelliği, uzak bilgisayarlarda yüklü modüller için çalışmaya olanak tanıyan Save-Help PowerShell uzaktan iletişiminde korunur. PsModuleInfo nesnesini, İnternet erişimi olmayan bir bilgisayarda çalıştırarakExport-Clixml, nesneyi İnternet erişimi olan bir bilgisayarda içeri aktararak ve ardından PSModuleInfo nesnesinde çalıştırarak Save-Help diske veya çıkarılabilir medyaya kaydetmek de mümkündür. Kaydedilen yardım, USB sürücüsü gibi çıkarılabilir depolama medyası kullanılarak uzak bilgisayara taşınabilir. Yardımı, komutunu çalıştırarak Update-Helpuzak bilgisayara yükleyebilirsiniz. Bu işlem, herhangi bir ağ erişimi olmayan bilgisayarlara yardım yüklemek için kullanılabilir.
Kaydedilen yardım dosyalarını yüklemek için cmdlet'ini Update-Help çalıştırın. Yardım dosyalarını kaydettiğiniz klasörü belirtmek için SourcePath parametresini ekleyin.
Parametreler olmadan, komut Save-Help 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ı vermeden Güncelleştirilebilir Yardım'ın desteklenmediği modülleri atlar.
Cmdlet, Save-Help hedef klasördeki tüm yardım dosyalarının sürümünü denetler. Daha yeni yardım dosyaları varsa, bu cmdlet en yeni yardım dosyalarını İnternet'ten indirir ve sonra bunları klasöre kaydeder. Save-Help Cmdlet cmdlet'iyle aynı şekilde Update-Help çalışır, ancak yardım dosyalarını dolap dosyalarından ayıklamak ve bilgisayara yüklemek yerine indirilen dolap (.cab) dosyalarını kaydeder.
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 yardım dosyalarını ayıklar, XML'yi güvenlik için doğrular ve ardından yardım dosyalarını ve yardım bilgileri dosyasını modül klasörünün dile özgü bir alt klasörüne yükler.
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ğini kullanarak PowerShell'i başlatın. Bu modüllerin yardım dosyalarını indirmek için bilgisayardaki Administrators grubunun üyesi olmanız gerekir.
Bu cmdlet, Windows PowerShell 3.0'da sunulmuştur.
Örnekler
Örnek 1: DhcpServer modülü için yardımı kaydetme
# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module,
# save the PSModuleInfo object in the variable $m, and then run Save-Help.
$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock { Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath "C:\SavedHelp"
# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.
$s = New-PSSession -ComputerName "RemoteServer"
$m = Get-Module -PSSession $s -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"
# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.
$c = New-CimSession -ComputerName "RemoteServer"
$m = Get-Module -CimSession $c -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"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 kullanmanın Save-Help üç farklı yolu gösterilmektedir.
Örnek 2: DhcpServer modülü için yardım yükleme
# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.
$m = Get-Module -Name "DhcpServer" -ListAvailable
Export-CliXml -Path "E:\UsbFlashDrive\DhcpModule.xml" -InputObject $m
# Next, transport the removable media to a computer that has Internet access, and then import the
# PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer
# module PSModuleInfo object.
$deserialized_m = Import-CliXml "E:\UsbFlashDrive\DhcpModule.xml"
Save-Help -Module $deserialized_m -DestinationPath "E:\UsbFlashDrive\SavedHelp"
# Finally, transport the removable media back to the computer that does not have network access, and
# then install the help by running Update-Help.
Update-Help -Module DhcpServer -SourcePath "E:\UsbFlashDrive\SavedHelp"Bu örnekte, DhcpServer modülü için Örnek 1'de kaydettiğiniz yardımın İnternet erişimi olmayan bir bilgisayara nasıl yükleneceği gösterilmektedir.
Örnek 3: Tüm modüller için yardım kaydetme
Save-Help -DestinationPath "\\Server01\FileShare01"Bu komut, yerel bilgisayarda Windows için ayarlanan kullanıcı arabirimi kültüründeki tüm modüller için en yeni yardım dosyalarını indirir. Yardım dosyalarını klasörüne \\Server01\Fileshare01 kaydeder.
Örnek 4: Bilgisayardaki modül için yardım kaydetme
Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01Bu komut , ServerManager modülü için en yeni yardım dosyalarını indirir ve sonra bunları klasöre \\Server01\Fileshare01 kaydeder.
Bilgisayara bir modül yüklendiğinde, modül geçerli oturuma aktarılmasa bile modül adını Module parametresinin değeri olarak yazabilirsiniz.
Komut, dosya paylaşımına yazma izni olan bir kullanıcının kimlik bilgilerini sağlamak için Credential parametresini kullanır.
Örnek 5: Farklı bir bilgisayardaki modül için yardım kaydetme
Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01Bu komutlar CustomSQL modülü için en yeni yardım dosyalarını indirir ve klasöre \\Server01\Fileshare01 kaydeder.
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 cmdlet'ine Save-Help aktaran bir Invoke-Command komut içerir.
Bilgisayarda bir modül yüklü değilse, Save-Help en yeni yardım dosyalarının konumu hakkında bilgi içeren modül nesnesine ihtiyaç duyar.
Örnek 6: Birden çok dilde bir modül için yardım kaydetme
Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"Bu komut, dört farklı ui kültüründeki temel PowerShell modülleri için yardım kaydeder. Bu yerel ayarlar için dil paketlerinin bilgisayara yüklenmesi gerekmez.
Save-Help farklı kullanıcı arabirimi 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.
Örnek 7: Her gün birden fazla yardım kaydetme
Save-Help -Force -DestinationPath "\\Server3\AdminShare\Help"Bu komut, bilgisayarda yüklü olan tüm modüller için yardım kaydeder. komutu, cmdlet'in her 24 saatlik dönemde yardımı birden çok kez indirmesini engelleyen Save-Help kuralı geçersiz kılmaya zorla parametresini belirtir.
Force parametresi ayrıca 1 GB kısıtlamasını geçersiz kılar ve sürüm denetimini atlar. 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 cmdlet'ini kullanır Save-Help .
Bir komutu her gün birden fazla kez çalıştırmanız Save-Help gerektiğinde Force parametresi gereklidir.
Parametreler
-Credential
Kullanıcı kimlik bilgilerini belirtir. Bu cmdlet, DestinationPath parametresi tarafından belirtilen dosya sistemi konumuna erişme izni olan bir kullanıcının kimlik bilgilerini kullanarak komutunu çalıştırır. Bu parametre yalnızca komutunda DestinationPath veya LiteralPath parametresi kullanıldığında geçerlidir.
Bu parametre, uzak bilgisayarlarda DestinationPath parametresini kullanan komutları çalıştırmanızı Save-Help sağlar. Açık kimlik bilgileri sağlayarak uzak bir bilgisayarda komutunu çalıştırabilir ve üçüncü bir bilgisayardaki dosya paylaşımına erişim reddedildi hatasıyla karşılaşmadan veya kimlik bilgilerini temsilci olarak atamak için CredSSP kimlik doğrulamasını kullanmadan erişebilirsiniz.
User01 veya Domain01\User01 gibi bir kullanıcı adı yazın veya cmdlet tarafından Get-Credential oluşturulan PSCredential nesnesini girin. Bir kullanıcı adı yazarsanız parolayı girmeniz istenir.
Kimlik bilgileri bir PSCredential nesnesinde depolanır ve parola SecureString olarak depolanır.
Not
SecureString veri koruması hakkında daha fazla bilgi için bkz. SecureString ne kadar güvenli?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestinationPath
Yardım dosyalarının kaydedildiği klasörün yolunu belirtir. Dosya adı veya dosya adı uzantısı belirtmeyin.
| Type: | String[] |
| Aliases: | Path |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Bu cmdlet'in günde bir kez sınırlamaya uymadığını, sürüm denetimini atladığını ve 1 GB sınırını aşan dosyaları indirdiğini gösterir.
Bu parametre olmadan, her 24 saatlik süre içinde her modül için yalnızca bir Save-Help komuta izin verilir, indirmeler modül başına 1 GB sıkıştırılmamış içerikle sınırlıdır ve bir modülün yardım dosyaları yalnızca bilgisayardaki dosyalardan daha yeni olduklarında yüklenir.
Günde bir kez sınırı, yardım dosyalarını barındıran sunucuları korur ve PowerShell profilinize komut Save-Help eklemenizi pratik hale getirir.
Force parametresi olmadan birden çok ui kültüründeki bir modüle yönelik yardım kaydetmek için aşağıdakiler gibi tüm ui kültürlerini aynı komuta ekleyin:Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullyQualifiedModule
ModuleSpecification nesneleri biçiminde belirtilen adlara sahip modülleri belirtir. ModuleSpecification Constructor (Hashtable) öğesinin Açıklamalar bölümüne bakın.
Örneğin, FullyQualifiedModule parametresi şu biçimlerden birinde belirtilen bir modül adını kabul eder:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}
ModuleName ve ModuleVersion gereklidir, ancak Guid isteğe bağlıdır. Bir Module parametresiyle aynı komutta FullyQualifiedModule parametresini belirtemezsiniz. iki parametre birbirini dışlar.
| Type: | ModuleSpecification[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
Hedef klasörün yolunu belirtir. DestinationPath parametresinin değerinden farklı olarak, LiteralPath parametresinin değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, tek tırnak içine alın. Tek tırnak işaretleri PowerShell'e hiçbir karakteri kaçış dizisi olarak yorumlamaması gerektiğini söyler.
| Type: | String[] |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Module
Bu cmdlet'in yardım indirdiği modülleri belirtir. Virgülle ayrılmış bir listeye veya her satırda bir modül adı olan bir dosyaya bir veya daha fazla modül adı veya ad patters girin. Joker karakterlere izin verilir. Modül nesnelerini cmdlet'inden Save-Helpöğesine Get-Module de aktarabilirsiniz.
Varsayılan olarak, Save-Help Güncelleştirilebilir Yardım'ı destekleyen tüm modüller için yardım indirir ve yerel bilgisayara PSModulePath ortam değişkeninde listelenen bir konuma yüklenir.
Bilgisayarda yüklü olmayan modüller için yardım kaydetmek için uzak bilgisayarda bir Get-Module komut çalıştırın. Ardından, sonuçta elde edilen modül nesnelerini cmdlet'ine Save-Help aktarın veya modül nesnelerini Module veya InputObject parametrelerinin değeri olarak gönderin.
Belirttiğiniz modül bilgisayarda yüklüyse, modül adını veya modül nesnesini girebilirsiniz. Modül bilgisayarda yüklü değilse, cmdlet'i tarafından Get-Module döndürülen bir modül nesnesi gibi bir modül nesnesi girmeniz gerekir.
cmdlet'in Save-HelpModule parametresi bir modül dosyasının veya modül bildirim dosyasının tam yolunu kabul etmez. PSModulePath konumunda olmayan bir modülün yardımını kaydetmek için, komutu çalıştırmadan önce modülü geçerli oturuma aktarınSave-Help.
"*" (all) değeri, bilgisayarda yüklü olan tüm modüller için yardımı güncelleştirmeye çalışır. Bu, Güncelleştirilebilir Yardım'ın desteklenmediği modülleri içerir. Komut Güncelleştirilebilir Yardımı desteklemeyen modüllerle karşılaştığında bu değer hatalara neden olabilir.
| Type: | PSModuleInfo[] |
| Aliases: | Name |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Scope
Bu paramater bu cmdlet'te hiçbir şey yapmaz.
| Type: | UpdateHelpScope |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UICulture
Bu cmdlet'in güncelleştirilmiş yardım dosyalarını aldığı UI kültürü değerlerini belirtir. gibi es-ESbir veya daha fazla dil kodu, kültür nesneleri içeren bir değişken veya veya komutu gibi kültür nesnelerini alan bir Get-CultureGet-UICulture komut girin.
Joker karakterlere izin verilmez. "de" gibi kısmi bir dil kodu belirtmeyin.
Varsayılan olarak, Save-Help Windows veya geri dönüş kültürü için ayarlanan kullanıcı arabirimi kültüründeki yardım dosyalarını alır.
UICulture parametresini belirtirseniz, Save-Help herhangi bir geri dönüş kültüründe değil, yalnızca belirtilen UI kültürü için yardım arar.
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | Current UI culture |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Bu cmdlet'in geçerli kullanıcının kimlik bilgileriyle web indirmesi de dahil olmak üzere komutunu çalıştırdığını gösterir. Varsayılan olarak, komut açık kimlik bilgileri olmadan çalışır.
Bu parametre yalnızca web indirmesi NTLM, negotiate veya Kerberos tabanlı kimlik doğrulaması kullandığında etkilidir.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Girişler
Bir modül nesnesini cmdlet'inden Get-ModuleModule parametresine Save-Helpaktarabilirsiniz.
Çıkışlar
None
Bu cmdlet herhangi bir çıkış oluşturmaz.
Notlar
- $pshome\Modules klasörüne 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-Helpcmdlet'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-HelpCmdlet, bilgisayarda yüklü olmayan modüller için yardım kaydedebilir. Ancak, yardım dosyaları modül klasörüne yüklendiğindenUpdate-Help, cmdlet yalnızca bilgisayarda yüklü olan modüller için güncelleştirilmiş yardım dosyasını yükleyebilir.Save-HelpBir modülün güncelleştirilmiş yardım dosyalarını bulamazsa veya belirtilen dilde güncelleştirilmiş yardım dosyalarını bulamazsa, hata iletisi görüntülenmeden 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 içeren modülü bulmak için ModuleName özelliğini cmdlet'iyle
Get-Commandbirlikte kullanın, örneğin,(Get-Command \<cmdlet-name\>).ModuleName Save-Helptüm modülleri ve temel PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez.- ve
Save-Helpcmdlet'leriUpdate-Helpyardı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ı. - ve
Save-Helpcmdlet'leriUpdate-HelpWindows Önyükleme Ortamı'nda (Windows PE) desteklenmez.