Save-Help

Başvuru

Modül:: Microsoft.PowerShell.Core

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ştirmenizi sağlar 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ü 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üklenebilir. 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 komutSave-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ı olmadan 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'i gibi Update-Help çalışır, ancak indirilen dolap (.cab) dosyalarını kaydeder, yardım dosyalarını dolap dosyalarından ayıklamak ve bilgisayara yüklemek yerine.

Her modül için kaydedilen yardım, bir yardım bilgisi (HelpInfo XML) dosyasından ve her kullanıcı arabirimi kültürünün 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ü 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 Yönetici istrators grubunun üyesi olmanız gerekir.

Bu cmdlet, Windows PowerShell 3.0'da kullanıma 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, İnternet erişimi olmayan bir bilgisayara DhcpServer modülü için Örnek 1'de kaydettiğiniz yardımın 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/Admin01

Bu 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 parametresinin değeri olarak modül adını yazabilirsiniz.

komutu, 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\Admin01

Bu 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ü olmadığında, Save-Help en yeni yardım dosyalarının konumu hakkında bilgi içeren modül nesnesi gerekir.

Ö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ı 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.

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: Yardımı her gün birden fazla kez 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 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 cmdlet'ini kullanır Save-Help . Her gün birden fazla komut ç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şim izni olan bir kullanıcının kimlik bilgilerini kullanarak komutunu çalıştırır. Bu parametre yalnızca komutta 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 bir PSCredential nesnesi 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 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 komut Save-Help 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, 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

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 , PSModulePath'de belirtilen modülü arar.

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 gerekir .
- 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, gerekli bir sürümünü belirtir. Bu, diğer Sürüm anahtarlarıyla kullanılamaz.

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 patter girin. Joker karakterlere izin verilir. Modül nesnelerini cmdlet'inden öğesine Get-ModuleSave-Helpde aktarabilirsiniz.

Varsayılan olarak, Save-Help Güncelleştirilebilir Yardım'ı destekleyen ve yerel bilgisayara PSModulePath ortam değişkeninde listelenen bir konumda yüklü olan tüm modüller için yardım indirir.

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 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-Help Module 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.

"*" (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'ın desteklenmediği modülleri içerir. Komut Güncelleştirilebilir Yardım'ın desteklenmediği modüllerle karşılaştığında bu değer hata oluşturabilir.

Type:	PSModuleInfo[]
Aliases:	Name
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Scope

Bu parametre 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ığı kullanıcı arabirimi kültürü değerlerini belirtir. gibi bir veya daha fazla dil kodu, es-ESkü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.

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 gibi en kısmi bir dil kodu kullanabilirsiniz.

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, anlaşma veya Kerberos tabanlı kimlik doğrulaması kullandığında geçerlidir.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Girişler

PSModuleInfo

Bir modül nesnesini bu cmdlet'e aktarabilirsiniz.

Çıkışlar

None

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

Notlar

modüllerin yardımını $pshome\Modules klasörüne kaydetmek için Yönetici olarak çalıştır seçeneğini kullanarak PowerShell'i başlatın. Yalnızca bilgisayardaki Yönetici istrators 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ından ve her kullanıcı arabirimi kültürünün 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 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, 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ü olan modüller için güncelleştirilmiş yardım dosyasını yükleyebilir.
Modül için güncelleştirilmiş yardım dosyaları bulunamıyorsa veya belirtilen dilde güncelleştirilmiş yardım dosyalarını bulamıyorsa Save-Help , bir 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 ModuleName özelliğini cmdlet ile Get-Command birlikte kullanın, örneğin,(Get-Command \<cmdlet-name\>).ModuleName
Save-Help tüm modülleri ve çekirdek PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez.
ve Save-Help cmdlet'leriUpdate-Help, 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ı.
ve Save-Help cmdlet'leri Update-Help Windows Önyükleme Ortamı'nda (Windows PE) desteklenmez.

Save-Help

Syntax

Description

Örnekler

Örnek 1: DhcpServer modülü için yardımı kaydetme

Örnek 2: DhcpServer modülü için yardım yükleme

Örnek 3: Tüm modüller için yardım kaydetme

Örnek 4: Bilgisayardaki modül için yardım kaydetme

Örnek 5: Farklı bir bilgisayardaki modül için yardım kaydetme

Örnek 6: Birden çok dilde bir modül için yardım kaydetme

Örnek 7: Yardımı her gün birden fazla kez kaydetme

Parametreler

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Scope

-UICulture

-UseDefaultCredentials

Girişler

Çıkışlar

Notlar

Geri Bildirim

Ek kaynaklar

Save-Help

Syntax

Description

Örnekler

Örnek 1: DhcpServer modülü için yardımı kaydetme

Örnek 2: DhcpServer modülü için yardım yükleme

Örnek 3: Tüm modüller için yardım kaydetme

Örnek 4: Bilgisayardaki modül için yardım kaydetme

Örnek 5: Farklı bir bilgisayardaki modül için yardım kaydetme

Örnek 6: Birden çok dilde bir modül için yardım kaydetme

Örnek 7: Yardımı her gün birden fazla kez kaydetme

Parametreler

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Scope

-UICulture

-UseDefaultCredentials

Girişler

Çıkışlar

Notlar

İlişkili Bağlantılar

Geri Bildirim

Ek kaynaklar