about_Updatable_Help

  • Cikk

Rövid leírás

A PowerShell frissíthető súgórendszerét ismerteti.

Hosszú leírás

A PowerShell számos különböző módszert kínál a PowerShell-parancsmagok és -fogalmak legfrissebb súgótémaköreinek elérésére.

A PowerShell 3.0-ban bevezetett Frissíthető súgórendszert úgy tervezték, hogy biztosítsa, hogy mindig a legújabb súgótémakörök legyenek a helyi számítógépen, így a parancssorban olvashatja őket. Így egyszerűen letöltheti és telepítheti a súgófájlokat, és frissítheti őket, amikor újabb súgófájlok válnak elérhetővé.

Ha egy vállalat több számítógépéhez és az internethez nem hozzáférő számítógépekhez szeretne frissített segítséget nyújtani, az Frissíthető súgó segítségével letöltheti a súgófájlokat egy fájlrendszerkönyvtárba vagy fájlmegosztásba, majd telepítheti a súgófájlokat a fájlmegosztásból.

A PowerShell 4.0-ban a HelpInfoUri tulajdonság windowsos PowerShell-újratelepítéssel marad meg, amely lehetővé teszi Save-Help a távoli számítógépre telepített, de nem feltétlenül a helyi számítógépen telepített modulok használatát. A PSModuleInfo objektumokat lemezre vagy cserélhető adathordozóra (például USB-meghajtóra) mentheti úgy, hogy olyan számítógépen futExport-Clixml, amely nem rendelkezik internet-hozzáféréssel, importálja a PSModuleInfo objektumot egy olyan számítógépre, amely rendelkezik internetkapcsolattal, majd a PSModuleInfo objektumon futSave-Help. A mentett súgó cserélhető adathordozóval másolható a távoli, leválasztott számítógépre, majd a futtatással Update-Helptelepíthető. Ezekkel a funkciókkal Save-Help segítséget telepíthet olyan számítógépekre, amelyekhez nincs hálózati hozzáférése. Az új Save-Help funkciók használatára vonatkozó példa: Súgó frissítése fájlmegosztásból ebben a témakörben.

Az frissíthető súgó emellett támogatja a legújabb súgótémakörök és a parancsmagok alapszintű súgójának online elérését is, még akkor is, ha nincsenek súgófájlok a számítógépen.

A PowerShell nem tartalmaz súgófájlokat. Az Frissíthető súgó funkcióval telepítheti a PowerShellben és az összes Windows-modulban alapértelmezés szerint megtalálható összes parancs súgófájljait.

Frissíthető súgóparancsmagok

  • Update-Help: Letölti a legújabb súgófájlokat az internetről vagy egy fájlmegosztásból, és telepíti őket a helyi számítógépre.

  • Save-Help: Letölti a legújabb súgófájlokat az internetről, és egy fájlrendszerkönyvtárba vagy fájlmegosztásba menti őket. A súgófájlok számítógépekre való telepítéséhez használja a következőt Update-Help: .

  • Get-Help: Súgótémaköröket jelenít meg a parancssorban. Segítséget kér a számítógépen található súgófájloktól. Automatikusan létrehozott súgó megjelenítése olyan parancsmagokhoz és függvényekhez, amelyek nem rendelkeznek súgófájlokkal. Megnyitja a parancsmagok, függvények, szkriptek és munkafolyamatok online súgótémaköreit az alapértelmezett internetböngészőben.

Automatikusan létrehozott súgó: súgófájlok nélkül

Ha nem rendelkezik a parancsmaghoz, függvényhez vagy munkafolyamathoz tartozó súgófájllal a számítógépen, a Get-Help parancsmag automatikusan létrehozott súgót jelenít meg, és kéri, hogy töltse le a súgófájlokat, vagy olvassa el őket online.

Az automatikusan létrehozott súgó szintaxisokat és aliasokat, valamint megjegyzéseket tartalmaz, amelyek ismertetik az Frissíthető súgó parancsmagok használatát és az online súgótémakörök elérését.

Az alábbi parancs például alapszintű segítséget kap a Get-Culture parancsmaghoz. A kimenet akkor jelenik meg, Get-Help ha a számítógépen nincsenek súgófájlok.

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.

Modulok súgófájljai

Az Frissíthető súgó legkisebb egysége egy modul súgója. A modul súgója segítséget nyújt a modulban található parancsmagokhoz, függvényekhez, munkafolyamatokhoz, szolgáltatókhoz, szkriptekhez és fogalmakhoz. A számítógépre telepített összes modul súgóját frissítheti, még akkor is, ha azokat nem importálja az aktuális munkamenetbe.

A teljes modul súgóját frissítheti, de nem frissítheti az egyes parancsmagok súgóját.

Az adott parancsmagot tartalmazó modul megkereséséhez használja a következő parancsformátumot:

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

A parancsmagot tartalmazó modul megkereséséhez például írja be a Set-ExecutionPolicy következőt:

(Get-Command Set-ExecutionPolicy).ModuleName

Egy adott modul súgójának frissítéséhez írja be a következőt:

Update-Help -Module <ModuleName>

Ha például frissíteni szeretné a Set-ExecutionPolicy parancsmagot tartalmazó modul súgóját, írja be a következőt:

Update-Help -Module Microsoft.PowerShell.Security

Frissíthető súgó engedélyei

A címtárban $pshome/Modulestalálható modulok súgójának frissítéséhez a Rendszergazda istrators csoport tagjának kell lennie a számítógépen.

Ha nem tagja a Rendszergazda istrators csoportnak, nem frissítheti ezeknek a moduloknak a súgóját, de ha rendelkezik internet-hozzáféréssel, online is megtekintheti a súgót.

A címtárban vagy a könyvtár $HOME/Documents/PowerShell/Modules más alkönyvtáraiban található modulok súgójának $HOME frissítése nem igényel különleges engedélyeket.

A Update-Help parancsmagok useDefaultCredentials Save-Help paraméterrel rendelkeznek, amely az aktuális felhasználó explicit hitelesítő adatait biztosítja. Ez a paraméter biztonságos internetes helyek elérésére lett tervezve.

A Update-Help parancsmagok és Save-Help parancsmagok hitelesítő paraméterrel is rendelkeznek, amely lehetővé teszi a parancs távoli számítógépen való futtatását és a fájlmegosztás elérését egy harmadik számítógépen. A hitelesítő paraméter csak akkor érvényes, ha a SourcePath vagy a LiteralPath paramétertUpdate-Help, valamint a DestinationPath vagy a LiteralPath paramétert Save-Helphasználja.

Súgófájlok telepítése és frissítése

Ha először szeretné letölteni és telepíteni a súgófájlokat, vagy frissíteni szeretné a számítógépen lévő súgófájlokat, használja a Update-Help parancsmagot.

A Update-Help parancsmag minden munkát elvégez, beleértve az alábbi feladatokat is.

  • Meghatározza, hogy mely modulok támogatják az frissíthető súgót.
  • Megkeresi azt az internetes helyet, ahol az egyes modulok tárolják az frissíthető súgófájlokat.
  • Összehasonlítja a számítógép minden moduljának súgófájljait az egyes modulokhoz elérhető legújabb súgófájlokkal.
  • Letölti az új fájlokat az internetről.
  • Bontsa ki a súgófájl-csomagot.
  • Ellenőrzi, hogy a fájlok érvényes súgófájlok-e.
  • Telepíti a súgófájlokat a modulkönyvtár nyelvspecifikus alkönyvtárába.

Az új súgótémakörök eléréséhez használja a Get-Help parancsmagot. Nem kell újraindítania a PowerShellt.

Az frissíthető súgót támogató összes modul súgójának telepítéséhez vagy frissítéséhez írja be a következőt:

Update-Help

Az egyes modulok súgójának frissítéséhez adja hozzá a modul paraméterét Update-Help. A modul nevében helyettesítő karakterek használhatók.

A ServerManager modul súgójának frissítéséhez például írja be a következőt:

Update-Help -Module ServerManager

Paraméterek nélkül a Update-Help frissítések segítenek a munkamenet összes moduljában, valamint az frissíthető súgót támogató összes telepített modulban. A modulokat a PSModulePath környezeti változó értékében felsorolt könyvtárakba kell telepíteni. Ezek olyan modulok is, amelyeket egy Get-Module -ListAvailable parancs ad vissza.

Ha a Modul paraméter * értéke (az összes), Update-Help megpróbálja frissíteni az összes telepített modul súgóját, beleértve azokat a modulokat is, amelyek nem támogatják az frissíthető súgót. Ez a parancs általában sok hibát okoz, mivel a parancsmag olyan modulokkal találkozik, amelyek nem támogatják az frissíthető súgót.

Súgó frissítése fájlmegosztásból

Az internethez nem csatlakozó számítógépek támogatásához, illetve a vállalati frissítés szabályozásához vagy egyszerűsítéséhez használja a Save-Help parancsmagot. A Save-Help parancsmag letölti a súgófájlokat az internetről, és egy ön által megadott fájlrendszerkönyvtárba menti őket.

Save-Help összehasonlítja a megadott könyvtár súgófájljait az egyes modulokhoz elérhető legújabb súgófájlokkal. Ha a címtárban nincsenek súgófájlok, vagy újabb súgófájlok érhetők el a modulhoz, a Save-Help parancsmag letölti az új fájlokat az internetről. A súgófájlokat azonban nem bontja ki vagy telepíti.

Ha a számítógépen lévő súgófájlokat fájlrendszerkönyvtárba mentett súgófájlokból szeretné telepíteni vagy frissíteni, használja a Update-Help parancsmag SourcePath paraméterét. A Update-Help parancsmag azonosítja a legújabb súgófájlokat, feloldja és ellenőrzi őket, és telepíti őket a modulkönyvtárak nyelvspecifikus alkönyvtáraiban.

Ha például az összes telepített modul súgóját a könyvtárba szeretné menteni, írja be a \\Server\Share következőt:

Save-Help -DestinationPath \\Server\Share

Ezután a könyvtár súgójának frissítéséhez írja be a \\Server\Share következőt:

Update-Help -SourcePath \\Server\Share

Az alábbi példák azt mutatják be, hogy a Save-Help helyi számítógépen nem telepített modulokhoz kell menteni a súgót. Ebben a példában a rendszergazda a DhcpServer modul súgójának mentéséhez fut Save-Help egy internetkapcsolattal rendelkező ügyfélszámítógépről anélkül, hogy telepíti a DhcpServer modult vagy a DHCP-kiszolgálói szerepkört a helyi számítógépen.

1. lehetőség: Futtassa Invoke-Command a távoli modul PSModuleInfo objektumának lekéréséhez, mentse azt egy változóba, $mmajd futtassa Save-Help a PSModuleInfo objektumon a változó $m modulnévként való megadásával.

$invokeCommandSplat = @{
    ComputerName = 'RemoteServer'
    ScriptBlock = { Get-Module -Name DhcpServer -ListAvailable }
}
$m = Invoke-Command @invokeCommandSplat
Save-Help -Module $m -DestinationPath C:\SavedHelp

2. lehetőség: Nyisson meg egy PSSessiont a DHCP-kiszolgáló modult futtató számítógépre, hogy lekérje a modulHOZ tartozó PSModuleInfo objektumot, mentse egy változóba $m, majd futtassa Save-Help a változóban $m mentett objektumon.

$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

3. lehetőség: Nyisson meg egy CIM-munkamenetet, amely a DHCP-kiszolgáló modult futtató számítógépre irányul, hogy lekérje a modulHOZ tartozó PSModuleInfo objektumot, mentse egy változóba $m, majd futtassa Save-Help a változóban $m mentett objektumon.

$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Az alábbi példában a rendszergazda telepíti a DHCP-kiszolgáló modul súgóját egy olyan számítógépre, amely nem rendelkezik hálózati hozzáféréssel.

Először futtassa Export-Clixml a PSModuleInfo objektum exportálását egy megosztott mappába vagy cserélhető adathordozóra.

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

Ezután a cserélhető adathordozót egy internetkapcsolattal rendelkező számítógépre szállítsa, majd importálja a PSModuleInfo objektumot a következővel Import-Clixml: . Futtassa Save-Help az importált DhcpServer modul PSModuleInfo objektumának súgójának mentéséhez.

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

Végül helyezze vissza a cserélhető adathordozót a hálózati hozzáféréssel nem rendelkező számítógépre, majd futtassa Update-Helpa súgót.

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

Paraméterek nélkül a Save-Help letöltések segítséget nyújtanak a munkamenet összes modulja és az frissíthető súgót támogató összes telepített modul esetében. A modulokat telepíteni kell a környezeti változó értékében $env:PSModulePath felsorolt könyvtárakba a helyi számítógépen vagy egy távoli számítógépen, amelyhez menteni szeretné a súgót. Ezek olyan modulok is, amelyeket parancs Get-Help -ListAvailable futtatásával adnak vissza.

Súgófájlok frissítése különböző nyelveken

Alapértelmezés szerint a parancsmagok és Save-Help a Update-Help parancsmagok a helyi számítógépen a Windowshoz beállított felhasználói felületi kultúrában és nyelven töltik le a súgót. Ha a megadott modulok súgófájljai nem érhetők el a helyi felhasználói felületi kultúrában, Update-Help és Save-Help a Windows nyelvi tartalék szabályaival keresse meg a legjobban támogatott nyelvet.

Azonban a parancsmagok Update-HelpSave-Help UICulture paramétereit használva letöltheti és telepítheti a súgófájlokat minden olyan felhasználói felületi kultúrában, amelyben elérhetők.

Ha például japán (ja-Jp) és francia (fr-FR) nyelven szeretné menteni a munkamenet összes moduljának legújabb súgófájljait, írja be a következőt:

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

Ha a modulok súgófájljai nem érhetők el a megadott nyelveken, a Update-HelpSave-Help parancsmagok egy hibaüzenetet adnak vissza, amely felsorolja azokat a nyelveket, amelyekben az egyes modulok súgója elérhető, így kiválaszthatja az igényeinek leginkább megfelelő alternatívát.

Feljegyzés

Jelenleg a frissíthető súgótartalmak csak angol nyelven (en-US) jelennek meg.

Online súgó használata

Ha nem tudja vagy nem tudja frissíteni a helyi számítógépen található súgófájlokat, akkor is online állapotba helyezheti a legújabb súgófájlokat.

A parancsmag vagy függvény online súgótémakörének megnyitásához használja a Get-Help parancsmag Online paraméterét.

Az alábbi parancs például megnyitja a parancsmag online súgótémakörét az Get-Job alapértelmezett böngészőben:

Get-Help Get-Job -Online

Ha online segítséget szeretne kapni egy szkripthez, használja az Online paramétert és a szkript teljes elérési útját.

Az Online paraméter nem működik a Névjegy témakörökkel. A PowerShell témaköreiről, beleértve a PowerShell nyelvével kapcsolatos súgótémaköröket is, olvassa el a PowerShell témakörökről szóló témakörét.

Az internetes letöltések minimalizálása vagy megakadályozása

A parancsmaggal Save-Help minimalizálhatja az internetes letöltéseket, és frissíthető súgót biztosíthat az internethez nem csatlakozó felhasználóknak. Töltse le a súgót az internetről, és mentse egy hálózati megosztásba. Ezután hozzon létre egy csoportházirend-beállítást vagy ütemezett feladatot, amely parancsot Update-Help futtat az összes számítógépen. Állítsa a parancsmag SourcePath paraméterének Update-Help értékét a hálózati megosztásra.

Ha meg szeretné akadályozni, hogy az internethez hozzáférő felhasználók letöltsék az frissíthető súgót az internetről, használja az Update-Help csoportházirend alapértelmezett forrásútvonalának beállítását.

Ez a csoportházirend-beállítás implicit módon hozzáadja a SourcePath paramétert a megadott fájlrendszer-helyhez minden érintett számítógép minden Update-Help parancsához. A felhasználók explicit módon használhatják a SourcePath paramétert egy másik fájlrendszerhely megadására, de nem zárhatják ki a SourcePath paramétert , és nem tölthetik le a súgót az internetről.

Feljegyzés

Az Update-Help csoportházirend-beállítás alapértelmezett forrásútvonalának beállítása a Számítógép konfigurációja és a Felhasználói konfiguráció területen jelenik meg. Azonban csak a számítógép konfigurációja alatti házirend-beállítás érvényes. A rendszer figyelmen kívül hagyja a felhasználói konfiguráció alatti házirend-beállítást.

További információért lásd: about_Group_Policy_Settings.

Nem szabványos modulok súgójának frissítése

Ha olyan modul súgóját szeretné frissíteni vagy menteni, amelyet nem a parancsmag ListAvailable paramétere Get-Module ad vissza, importálja a modult az aktuális munkamenetbe egy vagy Save-Help több Update-Help parancs futtatása előtt. Távoli számítógépen a Save-Help parancs futtatása előtt importálja a modult a távoli számítógéphez csatlakoztatott aktuális munkamenetbe vagy Invoke-Command szkriptblokkba.

Ha a modul az aktuális munkamenetben van, futtassa a Update-HelpSave-Help parancsmagokat paraméterek nélkül, vagy használja a Modul paramétert a modul nevének megadásához.

A parancsmagok modulparamétereiUpdate-HelpSave-Help csak egy modulnevet fogadnak el. Nem fogadják el a modulfájl elérési útját.

Ezzel a technikával frissíthet vagy menthet segítséget a parancsmag ListAvailable paramétere Get-Module által nem visszaadott modulokhoz, például egy olyan modulhoz, amely a környezeti változóban $env:PSModulePath nem szereplő helyre van telepítve, vagy egy nem megfelelően formázott modulhoz (a modulkönyvtár nem tartalmaz legalább egy olyan fájlt, amelynek alapneve megegyezik a címtár nevével).

Frissíthető súgó támogatása

Ha modult készít, az online súgót és az frissíthető súgót is támogathatja a modulokhoz. További információkért tekintse meg az Frissíthető súgó és az Online támogatás támogatása című témakört.

Frissíthető súgó nem érhető el PowerShell-beépülő modulokhoz vagy megjegyzésalapú súgókhoz.

Megjegyzések

A Update-Help parancsmagok és Save-Help parancsmagok nem támogatottak a Windows előtelepítési környezetében (Windows PE).

Lásd még