Save-Help (Microsoft.PowerShell.Core)

Save-Help

Modül:: Microsoft.PowerShell.Core

En yeni yardım dosyalarını indirir ve bir dosya sistemi dizinine kaydeder.

Sözdizimi

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>]

Tanım

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üncellemenizi sağlar ve birden fazla bilgisayardaki yardım dosyalarının güncellenmesini kolaylaştırır.

Windows PowerShell 3.0'da Save-Help yalnızca yerel bilgisayarda yüklü modüller için çalışıyordu. Uzak bilgisayardan bir modülü içe aktarmak veya PowerShell uzaktan iletişimini kullanarak uzak bilgisayardan bir PSModuleInfo nesnesine referans 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 PowerShell uzaktan iletişimi üzerinden korunur; bu, Save-Help'in uzak bilgisayarlara yüklenen modüller için çalışmasını sağlar. İnternet erişimi olmayan bir bilgisayarda Export-Clixml'i çalıştırarak bir PSModuleInfo nesnesini diske veya çıkarılabilir medyaya kaydetmek de mümkündür; nesneyi İnternet erişimi olmayan bir bilgisayara içe aktarın. İnternet erişimi var ve ardından PSModuleInfo nesnesinde Save-Help komutunu çalıştırın. Kaydedilen yardım, USB sürücü gibi çıkarılabilir depolama ortamı kullanılarak uzaktaki bilgisayara taşınabilir. Yardım uzak bilgisayara Update-Help çalıştırılarak 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 Update-Help cmdlet'ini çalıştırın. Yardım dosyalarını kaydettiğiniz klasörü belirtmek için SourcePath parametresini ekleyin.

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

Save-Help cmdlet'i, hedef klasördeki tüm yardım dosyalarının sürümünü kontrol eder. Daha yeni yardım dosyaları mevcutsa bu cmdlet, Internet'ten en yeni yardım dosyalarını indirir ve ardından bunları klasöre kaydeder. Save-Help cmdlet'i aynı Update-Help cmdlet'i gibi çalışır; tek farkı, yardım dosyalarını dolaptan çıkarmak yerine indirilen dolap (.cab) dosyalarını kaydetmesidir. dosyaları ve bunları bilgisayara yükleme.

Her modül için kaydedilen yardım, bir yardım bilgisi (HelpInfo XML) dosyasından ve her kullanıcı arayüzü kültüründeki yardım dosyaları için bir dolap (.cab) dosyasından oluşur. Yardım dosyalarını dolap dosyasından çıkarmanıza gerek yoktur. Update-Help cmdlet'i yardım dosyalarını çıkarır, XML'i güvenlik açısından 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üllere ilişkin 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üllere ilişkin yardım dosyalarını indirmek için bilgisayardaki Administrators grubunun üyesi olmanız gerekir.

Bu cmdlet, Windows PowerShell 3.0'da tanıtıldı.

Örnekler

Örnek 1: DhcpServer modülünün yardımını kaydedin

# 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 örnek, DhcpServer modülünün yardımını, DhcpServer'ı kurmadan İnternet bağlantılı bir istemci bilgisayardan kaydetmek için Save-Help'i kullanmanın üç farklı yolunu gösterir. modülü veya yerel bilgisayardaki DHCP Sunucusu rolü.

Ö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 örnek, DhcpServer modülü için Örnek 1'de kaydettiğiniz yardımın İnternet erişimi olmayan bir bilgisayara nasıl kurulacağını gösterir.

Örnek 3: Yardımı tüm modüller için kaydedin

Save-Help -DestinationPath "\\Server01\FileShare01"

Bu komut, yerel bilgisayardaki Windows için kullanıcı arayüzü kültüründeki tüm modüller için en yeni yardım dosyalarını indirir. Yardım dosyalarını \\Server01\Fileshare01 klasörüne kaydeder.

Örnek 4: Bir modüle ilişkin yardımı bilgisayara 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 ardından bunları \\Server01\Fileshare01 klasörüne kaydeder.

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

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

Örnek 5: Bir modüle ilişkin yardımı farklı bir bilgisayara 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 bunları \\Server01\Fileshare01 klasörüne kaydeder.

CustomSQL modülü bilgisayarda kurulu olmadığından, sıra, CustomSQL modülü için modül nesnesini Server02 bilgisayarından alan ve ardından veriyi yönlendiren bir Invoke-Command komutunu içerir. modül nesnesini Save-Help cmdlet'ine ekleyin.

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

Örnek 6: Bir modüle ilişkin yardımı birden çok dilde 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ı arayüzü kültüründeki temel PowerShell modüllerine yönelik yardımı kaydeder. Bu yerel ayarlara ilişkin dil paketlerinin bilgisayarda yüklü olması gerekmez.

Save-Help, farklı kullanıcı arayüzü kültürlerindeki modüllere ilişkin 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 kaydedin

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

Bu komut, bilgisayarda yüklü olan tüm modüllere ilişkin yardımı kaydeder. Komut, Save-Help cmdlet'inin her 24 saatlik dönemde birden fazla kez yardım indirmesini engelleyen kuralı geçersiz kılmak için Force 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 yeni olmasa bile dosyaları indirebilirsiniz.

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

Parametreler

-Credential

Bir kullanıcı kimlik bilgisini belirtir. Bu cmdlet, DestinationPath parametresi tarafından belirtilen dosya sistemi konumuna erişim iznine sahip bir kullanıcının kimlik bilgilerini kullanarak komutu ç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 Save-Help komutlarını çalıştırmanıza olanak tanır. Açık kimlik bilgileri sağlayarak, erişim reddedildi hatasıyla karşılaşmadan veya kimlik bilgilerini devretmek için CredSSP kimlik doğrulamasını kullanmadan, uzak bir bilgisayarda komutu çalıştırabilir ve üçüncü bir bilgisayardaki dosya paylaşımına erişebilirsiniz.

User01 veya Domain01\User01 gibi bir kullanıcı adı yazın veya Get-Credential tarafından oluşturulan bir PSCredential nesnesi girin kod > cmdlet'i seçin. Bir kullanıcı adı yazarsanız parolayı girmeniz istenir.

Kimlik bilgileri bir PSCredential nesnesinde, parola ise SecureString olarak depolanır.

Not

SecureString veri koruması hakkında daha fazla bilgi için bkz. SecureString ne kadar güvenli?.

Tip :: PSC kimlik bilgisi
Konum:: Adlandırılmış
Varsayılan değer:: None
Gerekli:: False
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

-DestinationPath

Yardım dosyalarının kaydedildiği klasörün yolunu belirtir. Bir dosya adı veya dosya adı uzantısı belirtmeyin.

Tip :: String[]
Takma adlar:: Path
Konum:: 0
Varsayılan değer:: None
Gerekli:: True
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

-Force

Bu cmdlet'in günde bir kez sınırlamasına uymadığını, sürüm denetimini atladığını ve 1 GB sınırını aşan dosyaları indirdiğini belirtir.

Bu parametre olmadan, her 24 saatlik dönemde her modül için yalnızca bir Kaydet-Yardım komutuna izin verilir, indirmeler modül başına 1 GB sıkıştırılmamış içerikle sınırlıdır ve yalnızca bir modülün yardım dosyaları yüklenir bilgisayardaki dosyalardan daha yeni olduklarında.

Günde bir kez sınırı, yardım dosyalarını barındıran sunucuları korur ve PowerShell profilinize Save-Help komutunu eklemenizi pratik hale getirir.

Bir modüle ilişkin yardımı Force parametresi olmadan birden çok kullanıcı arayüzü kültürüne kaydetmek için, tüm kullanıcı arayüzü kültürlerini aynı komuta dahil edin, örneğin: Save-Help -Module PSScheduledJobs -UICulture en-US, fr -FR, pt-BR

Tip :: SwitchParameter
Konum:: Adlandırılmış
Varsayılan değer:: False
Gerekli:: False
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

-FullyQualifiedModule

Değer bir modül adı, tam modül spesifikasyonu veya modül dosyasının yolu olabilir.

Değer bir yol olduğunda yol tamamen nitelenmiş veya göreceli olabilir. Göreli bir yol, use deyimini içeren betiğe göre çözümlenir.

Değer bir ad veya modül spesifikasyonu olduğunda PowerShell, belirtilen modül için PSModulePath'te arama yapar.

Bir modül spesifikasyonu, aşağıdaki anahtarlara sahip bir hash tablosudur.

ModuleName - Gerekli Modül adını belirtir.
GUID - İsteğe bağlı Modülün GUID'sini belirtir.
Ayrıca aşağıdaki üç anahtardan en az birinin belirtilmesi de gereklidir.
- ModuleVersion - Modülün kabul edilebilir minimum sürümünü belirtir.
- MaksimumVersiyon - Modülün kabul edilebilir maksimum sürümünü belirtir.
- RequiredVersion - Modülün tam, gerekli sürümünü belirtir. Bu, diğer Sürüm anahtarlarıyla kullanılamaz.

FullyQualifiedModule parametresini, Module parametresiyle aynı komutta belirtemezsiniz. iki parametre birbirini dışlar.

Tip :: Modül Şartnamesi[]
Konum:: Adlandırılmış
Varsayılan değer:: None
Gerekli:: False
Boru hattı girişini kabul edin:: True
Joker karakterleri kabul et:: 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 yorumlanmaz. Yol kaçış karakterleri içeriyorsa, onu tek tırnak işaretleri içine alın. Tek tırnak işaretleri PowerShell'e hiçbir karakteri kaçış dizisi olarak yorumlamamasını söyler.

Tip :: String[]
Takma adlar:: PSPath, LP
Konum:: Adlandırılmış
Varsayılan değer:: None
Gerekli:: True
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

-Module

Bu cmdlet indirmelerinin yardım edeceği modülleri belirtir. Virgülle ayrılmış bir listeye veya her satırında bir modül adı bulunan bir dosyaya bir veya daha fazla modül adı veya ad kalıbı girin. Joker karakterlere izin verilir. Ayrıca modül nesnelerini Get-Module cmdlet'inden Save-Help'e aktarabilirsiniz.

Varsayılan olarak Save-Help, Güncellenebilir Yardımı destekleyen tüm modüller için yardımı indirir ve yerel bilgisayarda PSModulePath ortam değişkeninde listelenen bir konuma yüklenir.

Bilgisayarda yüklü olmayan modüllere ilişkin yardımı kaydetmek için uzak bilgisayarda Get-Module komutunu çalıştırın. Daha sonra 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 kurulu değilse, Get-Module cmdlet'inin döndürdüğü gibi bir modül nesnesi girmeniz gerekir.

Save-Help cmdlet'inin 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, 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üncellemeye çalışır. Buna Güncellenebilir Yardımı desteklemeyen modüller de dahildir. Bu değer, komut Güncellenebilir Yardımı desteklemeyen modüllerle karşılaştığında hatalar üretebilir.

Tip :: PSModuleInfo[]
Takma adlar:: Name
Konum:: 1
Varsayılan değer:: None
Gerekli:: False
Boru hattı girişini kabul edin:: True
Joker karakterleri kabul et:: True

-Scope

Bu parametre bu cmdlet'te hiçbir şey yapmaz.

Tip :: Yardım Kapsamını Güncelle
Konum:: Adlandırılmış
Varsayılan değer:: None
Gerekli:: False
Boru hattı girişini kabul edin:: True
Joker karakterleri kabul et:: False

-UICulture

Bu cmdlet'in güncelleştirilmiş yardım dosyalarını alacağı UI kültür değerlerini belirtir. Kültür nesnelerini içeren bir değişken olan es-ES gibi bir veya daha fazla dil kodu veya Get-Culture veya < gibi kültür nesnelerini alan bir komut girin.Get-UICulture komutunu kullanın. Joker karakterlere izin verilmez.

Varsayılan olarak, Save-Help, işletim sistemi veya geri dönüş kültürü için ayarlanan kullanıcı arayüzü 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'ten başlayarak, herhangi bir bölge için İngilizce yardım indirmek için en gibi kısmi bir dil kodu kullanabilirsiniz.

Tip :: KültürBilgisi[]
Konum:: 2
Varsayılan değer:: Mevcut kullanıcı arayüzü kültürü
Gerekli:: False
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

-UseDefaultCredentials

Bu cmdlet'in, web indirmesi de dahil olmak üzere komutu geçerli kullanıcının kimlik bilgileriyle çalıştırdığını belirtir. Varsayılan olarak komut, açık kimlik bilgileri olmadan çalışır.

Bu parametre yalnızca web indirme işlemi NTLM, anlaşma veya Kerberos tabanlı kimlik doğrulama kullandığında etkilidir.

Tip :: SwitchParameter
Konum:: Adlandırılmış
Varsayılan değer:: False
Gerekli:: False
Boru hattı girişini kabul edin:: False
Joker karakterleri kabul et:: False

Girişler

PSModuleInfo

Bir modül nesnesini bu cmdlet'e yönlendirebilirsiniz.

Çıkışlar

Yok

Bu cmdlet hiçbir çıktı döndürmez.

Notlar

Modüllere ilişkin yardımı $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öneticiler grubunun üyeleri $pshome\Modules klasöründeki modüllere ilişkin yardımı indirebilir.
Her modül için kaydedilen yardım, bir yardım bilgisi (HelpInfo XML) dosyasından ve her kullanıcı arayüzü kültüründeki yardım dosyaları için bir dolap (.cab) dosyasından oluşur. Yardım dosyalarını dolap dosyasından çıkarmanıza gerek yoktur. Update-Help cmdlet'i yardım dosyalarını çıkarır, XML'i 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.
Save-Help cmdlet'i bilgisayarda yüklü olmayan modüllere ilişkin yardımı kaydedebilir. Ancak yardım dosyaları modül klasörüne yüklendiğinden, Update-Help cmdlet'i yalnızca bilgisayarda yüklü olan modüller için güncellenmiş yardım dosyasını yükleyebilir.
Save-Help bir modüle ait güncellenmiş yardım dosyalarını bulamazsa veya belirtilen dilde güncellenmiş yardım dosyalarını bulamazsa, hata mesajı vermeden sessizce devam eder. Komut tarafından hangi dosyaların kaydedildiğini görmek için Verbose parametresini belirtin.
Modüller güncellenebilir yardımın en küçük birimidir. Belirli bir cmdlet'e yönelik yardımı kaydedemezsiniz, yalnızca modüldeki tüm cmdlet'ler için kaydedebilirsiniz. Belirli bir cmdlet'i içeren modülü bulmak için ModuleName özelliğini Get-Command cmdlet'iyle birlikte kullanın; örneğin, (Get-Command \).ModülAdı
Save-Help tüm modülleri ve temel PowerShell ek bileşenlerini destekler. Başka hiçbir ek bileşeni 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 Bağlantı Noktası 80 ve HTTPS için bağlantı noktası 443.
Update-Help ve Save-Help cmdlet'leri Windows Önkurulum Ortamı'nda (Windows PE) desteklenmez.