Save-Help

A Save-Help parancsmag letölti a PowerShell-modulok legújabb súgófájljait, és menti őket egy ön által megadott könyvtárba. Ez a funkció lehetővé teszi a súgófájlok frissítését olyan számítógépeken, amelyek nem rendelkeznek internet-hozzáféréssel, és megkönnyíti a súgófájlok frissítését több számítógépen. Ezt a parancsmagot a Windows PowerShell 3.0-ban vezettük be.

A Windows PowerShell 4.0-tól kezdve a Save-Help segítségével letöltheti a távoli számítógépekre telepített modulok súgófájljait. Egy PSModuleInfoExport-Clixml objektumot is menthet olyan számítógépen, amely nem rendelkezik internet-hozzáféréssel, importálja az objektumot egy olyan számítógépre, amely rendelkezik internet-hozzáféréssel, majd futtathat Save-Help a PSModuleInfo objektumon. Miután megkapta a mentett súgót, átmásolhatja a távoli számítógépre, és telepítheti a Update-Helpfuttatásával. Ez a folyamat segítséget nyújthat olyan számítógépeken, amelyekhez nincs hálózati hozzáférése.

Paraméterek nélkül a Save-Help parancs letölti a legújabb súgót a munkamenet összes modulja és a számítógépre telepített modulok esetében a PSModulePath környezeti változóban felsorolt helyen. Ez a művelet kihagyja azokat a modulokat, amelyek figyelmeztetés nélkül nem támogatják az frissíthető súgót.

A Save-Help parancsmag ellenőrzi a célmappában található súgófájlok verzióját. Ha újabb súgófájlok érhetők el, ez a parancsmag letölti a legújabb súgófájlokat az internetről, majd menti őket a mappába. A Save-Help parancsmag ugyanúgy működik, mint a Update-Help parancsmag, azzal a kivételrel, hogy a letöltött tartalmat menti ahelyett, hogy kinyeri a súgófájlokat, és telepíti őket a számítógépre.

Az egyes modulok mentett súgója egy súgófájlból (HelpInfo XML) és egy kabinetből vagy ZIP-archívumból (.cab vagy .zip) áll az egyes nyelvek súgófájljaihoz. Windows rendszeren a parancs letölti a kabinetfájlokat. Linux és macOS rendszeren a parancs zip-fájlokat tölt le.

Ha a PowerShell telepítési mappájába ($PSHOME\Modules) szeretné menteni a modulok súgófájljait, indítsa el a PowerShellt a Rendszergazdaként beállítással. A modulok súgófájljainak letöltéséhez a számítógépen a Rendszergazdák csoport tagjának kell lennie.

Mentett súgófájlok telepítéséhez futtassa a Update-Help a SourcePath paraméterrel a mentett súgófájlokat tartalmazó mappa megadásához. Update-Help kinyeri a súgófájlokat az archívumból, és telepíti őket a megfelelő helyre.

Ez a példa három különböző módszert mutat be a Save-Help használatára a DhcpServer modul súgójának mentéséhez egy internetkapcsolattal rendelkező ügyfélszámítógépről anélkül, hogy telepíti a DhcpServer modult vagy a DHCP-kiszolgáló szerepkört a helyi számítógépen.

# 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"

Ez a példa bemutatja, hogyan telepíthet súgót olyan számítógépekhez, amelyek nem csatlakoznak hálózathoz. Ebben a példában az első számítógép nincs akadálymentes hálózathoz csatlakoztatva. A fájlokat cserélhető adathordozón kell átmásolni. A második számítógép csatlakozik az internethez, és letöltheti a súgófájlokat.

# 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

Ez a parancs letölti a helyi számítógép összes moduljának legújabb súgófájljait. Menti a súgófájlokat a \\Server01\Fileshare01 mappába.

Save-Help -DestinationPath \\Server01\FileShare01

Ez a parancs letölti a ServerManager modul legújabb súgófájljait, majd menti őket a \\Server01\Fileshare01 mappába.

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

Amikor egy modul telepítve van a számítógépre, akkor is beírhatja a modul nevét a Modul paraméter értékeként, még akkor is, ha a modul nincs importálva az aktuális munkamenetbe.

A parancs a Hitelesítő adatok paraméterrel adja meg a fájlmegosztásba írási engedéllyel rendelkező felhasználó hitelesítő adatait.

Ezek a parancsok letöltik a CustomSQL modul legújabb súgófájljait, és mentik őket a \\Server01\Fileshare01 mappába.

Invoke-Command -ComputerName Server02 { Get-Module -Name CustomSQL -ListAvailable } |
    Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Mivel a CustomSQL modul nincs telepítve a számítógépre, a sorozat tartalmaz egy Invoke-Command parancsot, amely lekéri a CustomSQL-modul modulobjektumát a Server02 számítógépről, majd a modulobjektumot a Save-Help parancsmagba irányítja.

Ha egy modul nincs telepítve a számítógépre, Save-Help szüksége van a modulobjektumra, amely információkat tartalmaz a legújabb súgófájlok helyéről.

Ez a parancs négy különböző felhasználói felületi kultúra alapvető PowerShell-moduljainak súgóját menti. Ezeknek a területi beállításoknak a nyelvi csomagjait nem kell telepíteni a számítógépre.

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

Save-Help csak akkor tölthet le súgófájlokat a különböző felhasználói felületi kultúrák moduljaihoz, ha a modul tulajdonosa elérhetővé teszi a lefordított fájlokat az interneten.

Ez a parancs a számítógépre telepített összes modulhoz menti a súgót. A parancs megadja a Force paramétert a szabály felülbírálásához, amely megakadályozza, hogy a Save-Help parancsmag minden 24 órás időszakban többször is letöltse a súgót.

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

A Force paraméter felülbírálja az 1 GB-os korlátozást, és megkerüli a verzióellenőrzést. Ezért akkor is letölthet fájlokat, ha a verzió nem későbbi, mint a célmappában lévő verzió.

A parancs a Save-Help parancsmaggal tölti le és menti a súgófájlokat a megadott mappába. A Force paraméterre akkor van szükség, ha naponta több alkalommal kell futtatnia egy Save-Help parancsot.

PSModuleInfo

Ehhez a parancsmaghoz modulobjektumot is csövezhet.

None

Ez a parancsmag nem ad vissza kimenetet.

• Ha a $PSHOME\Modules mappában lévő modulokhoz szeretne segítséget menteni, indítsa el a PowerShellt a Futtatás rendszergazdaként lehetőséggel. A $PSHOME\Modulok mappában lévő modulokhoz csak a számítógép Rendszergazdák csoportjának tagjai tölthetnek le súgót.
• Az egyes modulok mentett súgója egy súgóinformációs (HelpInfo XML) fájlból és egy kabinetfájlból (.cab) áll az egyes felhasználói felületi kultúra súgófájljaihoz. Nem kell kinyernie a súgófájlokat a kabinetfájlból. A Update-Help parancsmag kinyeri a súgófájlokat, ellenőrzi az XML-fájlt, majd telepíti a súgófájlokat és a súgóinformációs fájlt a modulmappa nyelvspecifikus almappájába.
• A Save-Help parancsmag segítséget tud menteni a számítógépre nem telepített modulokhoz. Mivel azonban a súgófájlok a modul mappájába vannak telepítve, a Update-Help parancsmag csak a számítógépre telepített modulokhoz tudja telepíteni a frissített súgófájlt.
• Ha Save-Help nem talál frissített súgófájlokat egy modulhoz, vagy nem találja a frissített súgófájlokat a megadott nyelven, a hibaüzenet megjelenítése nélkül is csendben folytatódik. A parancs által mentett fájlok megtekintéséhez adja meg a Részletes paramétert.
• A modulok az frissíthető súgó legkisebb egysége. Nem menthet segítséget egy adott parancsmaghoz, csak a modul összes parancsmagja számára. Az adott parancsmagot tartalmazó modul megkereséséhez használja a ModuleName tulajdonságot a Get-Command parancsmaggal együtt, például (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help támogatja az összes modult és az alapvető PowerShell-beépülő modulokat. Más beépülő modulokat nem támogat.
• A Update-Help és Save-Help parancsmagok a következő portokat használják a súgófájlok letöltéséhez: 80-os port HTTP-hez és 443-os port HTTPS-hez.
• A Update-Help és Save-Help parancsmagok nem támogatottak a Windows előtelepítési környezetében (Windows PE).