about_Updatable_Help

  • Makale
  • Okumak için 9 dakika

Kısa açıklama

PowerShell'de 4.

Uzun açıklama

PowerShell, PowerShell cmdlet'leri ve kavramları için en güncel yardım konularına erişmek için birkaç farklı yol sağlar.

PowerShell 3.0'da tanıtılan Bilgisayarınızda her zaman en yeni yardım konularını komut satırına okuyabilyebilirsiniz. Yardım dosyalarını indirmeyi ve yüklemeyi ve yeni yardım dosyaları kullanılabilir olduğunda bunları güncelleştirmeyi kolaylaştırır.

Bir kuruluşta birden çok bilgisayara ve internet erişimine sahip olan bilgisayarlar için güncelleştirilmiş yardım sağlamak için Güncelleştirilebilir Yardım, yardım dosyalarını bir dosya sistemi dizinine veya dosya paylaşımına indirmenizi ve ardından yardım dosyalarını dosya paylaşımından yüklemenize olanak sağlar.

PowerShell 4.0'da HelpInfoUri özelliği, uzak bilgisayarda yüklü olan ancak yerel bilgisayarda yüklü olması gerekmeyilen modüller için çalışmaya olanak sağlayan Windows PowerShell uzaktan bağlantısı üzerinden Save-Help korunur. İnternet erişimi olmayan bir bilgisayarda çalıştırarak, INTERNET erişimi olan bir bilgisayarda PSModuleInfo nesnesini içeri aktararak ve ardından Export-Clixml PSModuleInfo nesne üzerinde çalıştırarak bir PSModuleInfo nesnesini diske veya çıkarılabilir medyaya (USB sürücüsü gibi) kaydedebilirsiniz. Save-Help Kaydedilen yardım uzak bilgisayara kopyalanır, bağlantısı kesilmiş bilgisayara çıkarılabilir medya kullanılarak kopyalanır ve ardından çalıştırarak Update-Help yüklenir. İşlevselliğe yapılan Save-Help bu geliştirmeler, herhangi bir ağ erişimi olmayan bilgisayarlara yardım yüklemenize olanak sağlar. Yeni işlevselliğin nasıl kullanıla ilgili bir örnek için bu konudaki How to update help from a file share (Dosya paylaşımından yardım güncelleştirme) Save-Help başlığına bakın.

Bilgisayarınızda yardım dosyası olsa bile, bilgisayarınızda en yeni yardım konu başlıklarına çevrimiçi erişimi ve cmdlet'ler için temel yardımı da destekler.

PowerShell 3.0, Yardım dosyalarıyla birlikte gelir. PowerShell'de varsayılan olarak dahil edilen tüm komutların ve tüm komut modüllerinin yardım dosyalarını yüklemek için Güncelleştirmeyilebilir Yardım Windows kullanabilirsiniz.

Table help cmdlet'leri

  • Update-Help: En yeni yardım dosyalarını internetten veya bir dosya paylaşımından indirir ve yerel bilgisayara indirir.

  • Save-Help: En yeni yardım dosyalarını internetten indirir ve bir dosya sistemi dizinine veya dosya paylaşımına kaydeder. Bilgisayarlara yardım dosyalarını yüklemek için Update-Help kullanın.

  • Get-Help: Komut satırına yardım konularını görüntüler. Bilgisayarda yardım dosyalarından yardım alır. Yardım dosyaları olmayan cmdlet'ler ve işlevler için otomatik olarak oluşturulan yardımı görüntüler. Cmdlet'ler, işlevler, betikler ve iş akışları için çevrimiçi yardım konularını varsayılan İnternet tarayıcınızda açar.

Otomatik olarak oluşturulan yardım: yardım dosyaları olmadan yardım

Bilgisayarda bir cmdlet, işlev veya iş akışı için yardım dosyası yoksa, cmdlet otomatik olarak oluşturulan yardım görüntüler ve yardım dosyalarını indirmenizi veya çevrimiçi olarak Get-Help okumanızı ister.

Otomatik olarak oluşturulan yardım, söz dizimi ve diğer adlar ile Table Help cmdlet'lerini kullanmayı ve çevrimiçi yardım konularına erişmeyi açıklayan açıklamalar içerir.

Örneğin, aşağıdaki komut cmdlet için temel Get-Culture yardım alır. Çıktı, Get-Help bilgisayarda yardım dosyası görüntülenmezken ekranı gösterir.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Modüller için yardım dosyaları

En küçük Updatable Help birimi, bir modül için yardımdır. Modül yardımı, bir modülde yer alan tüm cmdlet'ler, işlevler, iş akışları, sağlayıcılar, betikler ve kavramlar için yardım içerir. Geçerli oturuma aktarılmış olsalar bile bilgisayarda yüklü olan tüm modüller için yardımı güncelleştirebilirsiniz.

Modülün tamamına ait yardımı güncelleştirin, ancak tek tek cmdlet'ler için yardımı güncelleştiresiniz.

Belirli bir cmdlet'i içeren modülü bulmak için aşağıdaki komut biçimini kullanın:

(Get-Command <cmdlet-name>).ModuleName

Örneğin, cmdlet'ini içeren modülü Set-ExecutionPolicy bulmak için yazın:

(Get-Command Set-ExecutionPolicy).ModuleName

Belirli bir modülün yardım güncelleştirmesini yapmak için şunları yazın:

Update-Help -Module <ModuleName>

Örneğin, Set-ExecutionPolicy cmdlet'ini içeren modülün yardım güncelleştirmesini yapmak için yazın:

Update-Help -Module Microsoft.PowerShell.Security

Zaman çizelgesine uygun yardım için izinler

dizininde modüllerin yardım güncelleştirmesini yapmak $pshome/Modules için, bilgisayarda Administrators grubunun üyesisiniz.

Yöneticiler grubunun üyesi değilseniz, bu modüller için yardımı güncelleştiresiniz; ancak İnternet erişiminiz varsa yardımı çevrimiçi görüntüebilirsiniz.

Dizin veya dizinin diğer alt $home/Documents/PowerShell/Modules dizinleri içinde yer alan modüller için yardım $home güncelleştiriliyorsa özel izinler gerekli değildir.

ve cmdlet'leri, geçerli kullanıcının açık kimlik bilgilerini sağlayan bir Update-Help Save-Help UseDefaultCredentials parametresine sahip. Bu parametre güvenli İnternet konumlara erişmek için tasarlanmıştır.

ve Update-Help cmdlet'leri, komutu uzak bir bilgisayarda çalıştırmanıza ve üçüncü bir bilgisayarda bir dosya paylaşımına erişmenizi sağlayan Save-Help bir Credential parametresine de sahip olur. Credential parametresi yalnızca, 'nin SourcePath veya LiteralPath parametrelerini ve Update-Help DestinationPath veya LiteralPath parametrelerini kullanırken Save-Help geçerlidir.

Yardım dosyalarını yükleme ve güncelleştirme

Yardım dosyalarını ilk kez indirip yüklemek veya bilgisayarınıza yardım dosyalarını güncelleştirmek için Update-Help cmdlet'ini kullanın.

Cmdlet, aşağıdaki görevler de dahil olmak üzere tüm Update-Help zor işi sizin için yapar.

  • Hangi modüllerin Updatable Yardım'ı destekleyeni olduğunu belirler.
  • Her modülün Table Help dosyalarını depolaya internet konumunu bulur.
  • Bilgisayarınıza her modül için yardım dosyalarını, her modül için kullanılabilen en yeni yardım dosyalarıyla karşılaştırıldığında.
  • Yeni dosyaları internetten indirir.
  • Yardım dosyası paketininrapırlarını açar.
  • Dosyaların geçerli yardım dosyaları olduğunu doğrular.
  • Yardım dosyalarını modül dizininin dile özgü alt dizinine ekler.

Yeni yardım konularına erişmek için Get-Help cmdlet'ini kullanın. PowerShell'i yeniden başlatmanız gerek değildir.

Güncelleştirilebilir Yardımı destekleyen bilgisayarda tüm modüllerin yardımlarını yüklemek veya güncelleştirmek için şunları yazın:

Update-Help

Belirli modüllerin yardım güncelleştirmesini yapmak için Modül parametresini Update-Help ekleyin. Modül adı içinde joker karakterlere izin verilir.

Örneğin, ServerManager modülünün yardım güncelleştirmesini yapmak için yazın:

Update-Help -Module ServerManager

Parametreler olmadan, oturumda yer alan tüm modüller ve Güncel Yardım'ı destekleyen tüm yüklü modüller Update-Help için güncelleştirme yardımı. Dahil etmek için, modüllerin PSModulePath ortam değişkeninin değerinde listelenen dizinlere yüklenmiş olması gerekir. Bunlar aynı zamanda "Get-Help -ListAvailable" komutu tarafından döndürülen modüllerdir.

Modül parametresinin değeri (hepsi) ise, Güncelleştirilebilir Yardımı desteklemeen modüller de dahil olmak üzere yüklü tüm modüller için * yardımı Update-Help güncelleştirmeye çalışır. Bu komut genellikle cmdlet Updatable Yardım'ı desteklemeen modüllerle karşılaştığında birçok hata üretir.

Dosya paylaşımından yardım güncelleştirme

İnternet'e bağlı olan bilgisayarları desteklemek veya bir kuruluşta güncelleştirmeye yardımcı olmak veya denetlemeyi basit hale getirmek için Save-Help cmdlet'ini kullanın. Save-HelpCmdlet, yardım dosyalarını internetten indirir ve belirttiğiniz bir dosya sistemi dizinine kaydeder.

Save-Help belirtilen dizinde yer alan yardım dosyalarını her modül için kullanılabilen en yeni yardım dosyalarıyla karşılaştırıldığında. Dizinde yardım dosyası yoksa veya modül için daha yeni yardım dosyaları mevcutsa, Save-Help cmdlet yeni dosyaları internetten indirir. Ancak, yardım dosyalarını kaydırmaz veya yüklemez.

Bir bilgisayara yardım dosyalarını bir dosya sistemi dizinine kaydedilmiş yardım dosyalarından yüklemek veya güncelleştirmek için cmdlet'in SourcePath Update-Help parametresini kullanın. cmdlet'i en yeni yardım dosyalarını tanımlar, bunları açar ve doğrular ve modül dizinlerinin dile özgü alt Update-Help dizinlerine yüklenir.

Örneğin, yüklü tüm modüllerin yardımlarını dizinine kaydetmek \\Server\Share için yazın:

Save-Help -DestinationPath \\Server\Share

Ardından, dizininden yardım güncelleştirmek \\Server\Share için yazın:

Update-Help -SourcePath \\Server\Share

Aşağıdaki örneklerde, yerel Save-Help bilgisayarda yüklü olan modüllerin yardımlarını kaydetmek için kullanımı göstermektedir. Bu örnekte yönetici, 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 Save-Help yardımı kaydetmek için çalışır.

  1. Seçenek: Uzak modülün PSModuleInfo nesnesini almak için çalıştırın, bir değişkenine kaydedin ve ardından modül adı olarak değişkeni belirterek Invoke-Command $m Save-Help PSModuleInfo $m nesnesi üzerinde çalıştırın.
$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath C:\SavedHelp
  1. Seçenek: DHCP Sunucusu modülünü çalıştıran bilgisayarda hedeflenen bir PSSession açın, modülün PSModuleInfo nesnesini almak için bir değişkene kaydedin ve ardından değişkende kaydedilen nesne üzerinde $m Save-Help $m çalıştırın.
$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp
  1. Seçenek: Modülün PSModuleInfo nesnesini almak için DHCP Sunucusu modülünü çalıştıran bilgisayarı hedef alan bir CIM oturumu açın, bir değişkenine kaydedin ve ardından değişkende kaydedilen nesne üzerinde $m Save-Help $m çalıştırın.
$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Aşağıdaki örnekte yönetici, ağ erişimine sahip bir bilgisayara DHCP Sunucusu modülü için yardım yüklemektedir.

İlk olarak, Export-Clixml PSModuleInfo nesnesini paylaşılan bir klasöre veya çıkarılabilir medyaya dışarı aktarın.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbFlashDrive\DhcpModule.xml -InputObject $m

Ardından, çıkarılabilir medyayı internet erişimi olan bir bilgisayara aktarın ve ardından ile PSModuleInfo nesnesini içeri aktarın. Import-Clixml İçe Save-Help aktarılan PSModuleInfo modülüne ait Yardım'ı kaydetmek için çalıştırın.

$deserialized_m = Import-Clixml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbFlashDrive\SavedHelp

Son olarak, çıkarılabilir medyayı ağ erişimi olmayan bilgisayara geri yükleyin ve ardından çalıştırarak yardımı Update-Help yükleyin.

Update-Help -Module DhcpServer -SourcePath E:\UsbFlashDrive\SavedHelp

Parametreler olmadan, oturumda yer alan tüm modüller ve Güncelleştirmeyi Destekleyen Save-Help tüm yüklü modüller için yardım indirir. Dahil etmek için, modüllerin yerel bilgisayarda veya yardım kaydetmek istediğiniz uzak bir bilgisayarda ortam değişkeninin değerinde listelenen $env:PSModulePath dizinlere yüklenmiş olması gerekir. Bunlar ayrıca bir komut çalıştırarak döndürülen Get-Help -ListAvailable modüllerdir.

Farklı dillerdeki yardım dosyalarını güncelleştirme

Varsayılan olarak, Update-Help ve cmdlet'leri yerel bilgisayarda kullanıcı arabirimi için ayarlanmış kullanıcı arabirimi Save-Help Windows yardım indirir. Belirtilen modüller için yardım dosyaları yerel kullanıcı arabirimi kültüründe kullanılamıyorsa ve desteklenen en iyi dili bulmak için Windows dil geri dönüş Update-Help Save-Help kurallarını kullanın.

Ancak, ve cmdlet'lerinin UICulture parametrelerini kullanarak yardım dosyalarını, kullanılabilir olduğu kullanıcı arabirimi kültürlerinde indirebilir Update-Help Save-Help ve yükleyebilirsiniz.

Örneğin, oturumda yer alan tüm modüllerin en yeni yardım dosyalarını Japonca (Ja-jp) ve Fransızca (fr-FR) olarak kaydetmek için yazın:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Modüllerin yardım dosyaları belirttiğiniz dillerde kullanılamıyorsa ve Update-Help cmdlet'leri, her modül için yardımın kullanılabilir olduğu dilleri listelemektedir ve bu nedenle, İhtiyaçlarınızı en iyi şekilde karşılayacak alternatifi Save-Help seçebilirsiniz.

Not

Şu anda Güncelleştirilebilir Yardım içeriği yalnızca İngilizce (en-US) olarak yayımlanmaktadır. İçeriği açıkça Windows bazı sistemlerde UICulture parametresini en-US kullanabilirsiniz.

Çevrimiçi yardımı kullanma

Yerel bilgisayarınızda yardım dosyalarını güncelleştirmez veya güncelleştirmezse, yine de en yeni yardım dosyalarını çevrimiçine alabilirsiniz.

Herhangi bir cmdlet veya işlev için çevrimiçi yardım konusunu açmak için cmdlet'in Online Get-Help parametresini kullanın.

Örneğin, aşağıdaki komut cmdlet için çevrimiçi yardım konusunu Get-Job varsayılan İnternet tarayıcınızda açar:

Get-Help Get-Job -Online

Bir betiğin çevrimiçi yardım almak için Çevrimiçi parametresini ve betiğin tam yolunu kullanın.

Çevrimiçi parametresi About topics ile birlikte çalışmıyor. PowerShell diliyle ilgili yardım konuları da dahil olmak üzere PowerShell ile ilgili konuları görmek için bkz. PowerShell Konular Hakkında.

İnternet indirmelerini en aza indirme veya önleme

İnternet indirmelerini en aza indirmek ve İnternet'e bağlı olan kullanıcılara 100.000'den fazla yardım sağlamak için Save-Help cmdlet'ini kullanın. İnternet'den yardım indirin ve bir ağ paylaşımına kaydedin. Ardından, tüm grup ilkesi bir komut çalıştıran zamanlanmış bir iş Update-Help veya bir ilke ayarı oluşturun. Cmdlet'in SourcePath Update-Help parametresinin değerini ağ paylaşımı olarak ayarlayın.

İnternet erişimi olan kullanıcıların Güncelleştirilebilir Yardım'ı internetten indirmesini önlemek için Update-Help için varsayılan kaynak yolunu ayarla ayarını grup ilkesi kullanın.

Bu grup ilkesi ayarı, SourcePath parametresini belirttiğiniz dosya sistemi konumuyla birlikte etkilenen her bilgisayarda komutlara örtülü Update-Help olarak ekler. Kullanıcılar Farklı bir dosya sistemi konumu belirtmek için SourcePath parametresini açıkça kullanabilir, ancak SourcePath parametresini dışlamaz ve internetten yardım indiremezseniz.

Not

Update-Help grup ilkesi için varsayılan kaynak yolunu ayarla ayarı Bilgisayar Yapılandırması ve Kullanıcı Yapılandırması altında görünür. Ancak, yalnızca Bilgisayar Yapılandırması altındaki ilke ayarı etkilidir. Kullanıcı Yapılandırması altındaki ilke ayarı yoksayılır.

Daha fazla bilgi için bkz. about_Group_Policy_Settings.

Standart olmayan modüller için yardım güncelleştirme

Cmdlet'in ListAvailable parametresi tarafından döndürülmeden bir modülün yardımını güncelleştirmek veya kaydetmek için veya komutunu çalıştırmadan önce modülü geçerli Get-Module Update-Help oturuma Save-Help aktarın. Uzak bir bilgisayarda, komutu çalıştırmadan önce, modülü uzak bilgisayara bağlı geçerli Oturuma Save-Help Invoke-Command veya betik bloğuna aktarın.

Modül geçerli oturumda olduğunda veya cmdlet'lerini parametre olmadan çalıştırın veya modül adını Update-Help Save-Help belirtmek için Module parametresini kullanın.

ve Update-Help Save-Help cmdlet'lerinin Module parametreleri yalnızca bir modül adı kabul eder. Bir modül dosyasının yolunu kabul etmezler.

Ortam değişkensinde listelanmayan bir konuma yüklenmiş bir modül veya iyi oluşturulmuş bir modül gibi cmdlet'in ListAvailable parametresi tarafından döndürülemeyen modüller için yardım güncelleştirmek veya kaydetmek için bu tekniği kullanın (modül dizini, temel adı dizin adıyla aynı olan en az bir dosya Get-Module içermez). $env:PSModulePath

Zaman çizelgesine göre yardım nasıl destekçi olur?

Bir modül yazarsanız, modülleriniz için çevrimiçi yardım ve 100.000'den fazla yardım alabilirsiniz. Daha fazla bilgi için bkz. Destek updatable Help and Supporting Online Help in the Microsoft Docs.

PowerShell ek bileşenleri veya açıklama tabanlı yardım için table yardımı kullanılamaz.

Açıklamalar

ve Update-Help Save-Help cmdlet'leri, Windows Önyükleme Ortamı'Windows desteklenmiyor.

Ayrıca bkz.

Get-Help

Kaydet-Yardım

Update-Help