Save-Help
En yeni yardım dosyalarını indirir ve bir dosya sistemi dizinine kaydeder.
Sözdizimi
Path EnterprisePublishing
Save-Help
[-DestinationPath] <String[]>
[[-Module] <PSModuleInfo[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[<CommonParameters>]
LiteralPath
Save-Help
[[-Module] <PSModuleInfo[]>]
[[-UICulture] <CultureInfo[]>]
-LiteralPath <String[]>
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[<CommonParameters>]
Description
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 kullanarak Export-Clixml nesnesini kaydetmek, nesneyi İnternet erişimi olan bir bilgisayarda içeri aktarmak ve ardından Save-Help nesnesinde ç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 Update-Help parametresiyle çalıştırın.
Update-Help arşivden yardım dosyalarını ayıklar ve uygun konuma yükler.
Örnekler
Örnek 1: DhcpServer modülü için yardımı kaydetme
Bu örnekte, Save-Help 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 üç 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"
Örnek 2: DhcpServer modülü için yardım yükleme
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
Örnek 3: Tüm modüller için yardım kaydetme
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
Örnek 4: Bilgisayardaki modül için yardım kaydetme
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.
Örnek 5: Farklı bir bilgisayardaki modül için yardım kaydetme
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 Invoke-Command cmdlet'ine aktaran bir Save-Help 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.
Örnek 6: Birden çok dilde bir modül için yardım kaydetme
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.
Örnek 7: Yardımı her gün birden fazla kez kaydetme
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.
Parametreler
-Credential
Kullanıcı kimlik bilgilerini belirtir. Bu cmdlet, DestinationPath parametresi tarafından belirtilen dosya sistemi konumuna erişim izni olan bir kullanıcının kimlik bilgilerini kullanarak komutunu çalıştırır. Bu parametre yalnızca DestinationPath veya LiteralPath parametresi komutunda kullanıldığında geçerlidir.
Bu parametre, uzak bilgisayarlarda Save-Help parametresini kullanan komutları çalıştırmanızı 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\User01gibi bir kullanıcı adı yazın veya cmdlet'i tarafından oluşturulan Get-Credential nesnesi girin. Bir kullanıcı adı yazarsanız parolayı girmeniz istenir.
Kimlik bilgileri bir PSCredential nesnesinde depolanır ve parola SecureStringolarak depolanır.
Uyarı
SecureString veri koruması hakkında daha fazla bilgi için bkz. SecureString ne kadar güvenli?.
Parametre özellikleri
| Tür: | PSCredential |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-DestinationPath
Yardım dosyalarının kaydedildiği klasörün yolunu belirtir. Dosya adı veya dosya adı uzantısı belirtmeyin.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | Yol |
Parametre kümeleri
Path
| Position: | 0 |
| Zorunlu: | True |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | 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 komutuna izin verilir, indirme işlemleri modül başına 1 GB sıkıştırılmamış içerikle sınırlıdır ve modül için 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 bir Save-Help komutu eklemenizi pratik hale getirir.
Force parametresi olmadan birden çok kullanıcı arabirimi kültüründeki bir modül için yardım kaydetmek için, tüm kullanıcı arabirimi kültürlerini aynı komuta ekleyin, örneğin: Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | False |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-FullyQualifiedModule
Değer bir modül adı, tam modül belirtimi veya modül dosyasının yolu olabilir.
Değer bir yol olduğunda, yol tam veya göreli olabilir. Göreli yol, using deyimini içeren betike göre çözümlenir.
Değer bir ad veya modül belirtimi olduğunda PowerShell, belirtilen modülü psmodulepath
Modül belirtimi, aşağıdaki anahtarlara sahip bir karma tablodur.
-
ModuleName- Gerekli Modül adını belirtir. -
GUID- İsteğe bağlı Modülün GUID değerini belirtir. - Ayrıca aşağıdaki üç anahtardan en az birini belirtmek için Gerekli
. -
ModuleVersion- Modülün kabul edilebilir en düşük sürümünü belirtir. -
MaximumVersion- Modülün kabul edilebilir en yüksek sürümünü belirtir. -
RequiredVersion- Modülün tam ve gerekli bir sürümünü belirtir. Bu, diğer Sürüm anahtarlarıyla kullanılamaz.
-
Modülü parametresiyle aynı komutta FullyQualifiedModule parametresini belirtemezsiniz. iki parametre birbirini dışlar.
Parametre özellikleri
| Tür: | |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | 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, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | PSPath, LP |
Parametre kümeleri
LiteralPath
| Position: | Named |
| Zorunlu: | True |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | 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 deseni girin. Joker karakterlere izin verilir. Modül nesnelerini Get-Module cmdlet'inden Save-Help'e de aktarabilirsiniz.
Varsayılan olarak, Güncelleştirilebilir Yardım'ı destekleyen ve yerel bilgisayarda Save-Help ortam değişkeninde listelenen bir konumda yüklü olan tüm modüller için indirme yardımı.
Bilgisayarda yüklü olmayan modüller için yardım kaydetmek için uzak bilgisayarda bir Get-Module komutu çalıştırın. Ardından, elde edilen modül nesnelerini Save-Help cmdlet'ine 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, Get-Module cmdlet'i tarafından döndürülen bir modül nesnesi gibi bir modül nesnesi girmeniz gerekir.
cmdlet'in Save-Help 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, Save-Help komutunu çalıştırmadan önce modülü geçerli oturuma aktarın.
"*" (tümü) 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ı desteklemeyen modülleri içerir. Komut Güncelleştirilebilir Yardımı desteklemeyen modüllerle karşılaştığında bu değer hata oluşturabilir.
Parametre özellikleri
| Tür: | |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
| Diğer adlar: | İsim |
Parametre kümeleri
(All)
| Position: | 1 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Scope
Bu parametre bu cmdlet'te hiçbir şey yapmaz.
Parametre özellikleri
| Tür: | UpdateHelpScope |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-UICulture
Bu cmdlet'in güncelleştirilmiş yardım dosyalarını aldığı kullanıcı arabirimi kültürü değerlerini belirtir.
es-ESgibi bir veya daha fazla dil kodu, kültür nesneleri içeren bir değişken veya Get-Culture veya Get-UICulture komutu gibi kültür nesnelerini alan bir komut girin. Joker karakterlere izin verilmez.
varsayılan olarak, Save-Help işletim sistemi 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 yalnızca belirtilen dil için yardım arar.
PowerShell 7.4'te başlayarak, herhangi bir bölge için İngilizce yardım indirmek için en gibi kısmi bir dil kodu kullanabilirsiniz.
Parametre özellikleri
| Tür: | |
| Default value: | Current UI culture |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | 2 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | 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, anlaşma veya Kerberos tabanlı kimlik doğrulaması kullandığında geçerlidir.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | False |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.
Girişler
PSModuleInfo
Bir modül nesnesini bu cmdlet'e aktarabilirsiniz.
Çıkışlar
None
Bu cmdlet çıkış döndürmez.
Notlar
- $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-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'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-Helpcmdlet yalnızca bilgisayarda yüklü 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ı 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-Helptüm modülleri ve temel PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez. -
Update-HelpveSave-Helpcmdlet'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-HelpveSave-Helpcmdlet'leri Windows Önyükleme Ortamı'nda (Windows PE) desteklenmez.
