Save-Help

  • Referencia
Modul:
Microsoft.PowerShell.Core

Letölti és menti a legújabb súgófájlokat egy fájlrendszerkönyvtárba.

Syntax

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [<CommonParameters>]
Save-Help
    -LiteralPath <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [<CommonParameters>]

Description

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.

A Windows PowerShell 3.0-ban Save-Help csak a helyi számítógépre telepített modulok esetében működött. Bár lehetséges volt egy modul importálása távoli számítógépről, vagy psModuleInfo objektumra mutató hivatkozás lekérése távoli számítógépről PowerShell-remoting használatával, a HelpInfoUri tulajdonság nem maradt meg, és Save-Help nem működött a távoli modul súgójában.

A Windows PowerShell 4.0-ban a HelpInfoUri tulajdonság PowerShell-újratelepítéssel marad meg, amely lehetővé teszi Save-Help a távoli számítógépekre telepített modulok használatát. A PSModuleInfo objektumokat lemezre vagy cserélhető adathordozóra is mentheti, ha olyan számítógépen futExport-Clixml, 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. A mentett súgó cserélhető tárolóeszközzel, például USB-meghajtóval szállítható a távoli számítógépre. A súgó a távoli számítógépre telepíthető a futtatással Update-Help. Ez a folyamat olyan számítógépekre telepíthető, amelyek nem rendelkeznek semmilyen hálózati hozzáféréssel.

A mentett súgófájlok telepítéséhez futtassa a Update-Help parancsmagot. Adja hozzá a SourcePath paramétert annak a mappának a megadásához, amelyben a súgófájlokat mentette.

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

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, kivéve, hogy a letöltött kabinetfájlokat (.cab) menti ahelyett, hogy kinyeri a súgófájlokat a kabinetfájlokból, és telepíti őket a számítógépre.

Az egyes modulok mentett súgója egy súgóinformációból (HelpInfo XML) é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-t a biztonság érdekében, majd telepíti a súgófájlokat és a súgóinformációs fájlt a modulmappa nyelvspecifikus almappájába.

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 Futtatás rendszergazdaként lehetőséggel. A modulok súgófájljainak letöltéséhez a Rendszergazda istrators csoport tagjának kell lennie a számítógépen.

Ezt a parancsmagot a Windows PowerShell 3.0-ban vezettük be.

Példák

1. példa: A DhcpServer modul súgójának mentése

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

Ez a példa három különböző módszert Save-Help mutat be a DhcpServer modul súgójának mentésére egy internethez csatlakoztatott ügyfélszámítógépről anélkül, hogy a DhcpServer modult vagy a DHCP-kiszolgálói szerepkört a helyi számítógépre telepítené.

2. példa: A DhcpServer modul súgójának telepítése

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

Ez a példa bemutatja, hogyan telepítheti az 1. példában mentett súgót a DhcpServer modulhoz olyan számítógépen, amely nem rendelkezik internet-hozzáféréssel.

3. példa: Segítség mentése az összes modulhoz

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

Ez a parancs letölti a windowsos felhasználói felületi kultúra összes moduljának legújabb súgófájljait a helyi számítógépen. Menti a súgófájlokat a \\Server01\Fileshare01 mappába.

4. példa: Súgó mentése egy modulhoz a számítógépen

Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01

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

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 modult nem importálja az aktuális munkamenetbe.

A parancs a Hitelesítő adatok paraméterrel adja meg egy olyan felhasználó hitelesítő adatait, aki engedéllyel rendelkezik a fájlmegosztásba való íráshoz.

5. példa: Súgó mentése egy másik számítógépen lévő modulhoz

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

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

Mivel a CustomSQL modul nincs telepítve a számítógépen, 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 a legújabb súgófájlok helyével kapcsolatos információkat tartalmazza.

6. példa: Súgó mentése egy modulhoz több nyelven

Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"

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.

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

7. példa: Segítség mentése naponta több alkalommal

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

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.

A Force paraméter felülbírálja az 1 GB-os korlátozást is, é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.

Paraméterek

-Credential

Felhasználói hitelesítő adatokat ad meg. Ez a parancsmag egy olyan felhasználó hitelesítő adataival futtatja a parancsot, aki jogosult hozzáférni a DestinationPath paraméter által megadott fájlrendszer-helyhez. Ez a paraméter csak akkor érvényes, ha a DestinationPath vagy a LiteralPath paramétert használja a parancs.

Ez a paraméter lehetővé teszi a DestinationPath paramétert használó parancsok futtatását Save-Help távoli számítógépeken. Explicit hitelesítő adatok megadásával futtathatja a parancsot egy távoli számítógépen, és hozzáférhet egy fájlmegosztáshoz egy harmadik számítógépen anélkül, hogy hozzáférés-megtagadási hibát tapasztalna, vagy a hitelesítő adatok delegálásához CredSSP-hitelesítést használna.

Írjon be egy felhasználónevet (például User01 vagy Domain01\User01), vagy írjon be egy PSCredential objektumot, amelyet a Get-Credential parancsmag hoz létre. Ha beír egy felhasználónevet, a rendszer kéri a jelszó megadását.

A hitelesítő adatokat PSCredential objektum tárolja, a jelszót pedig SecureStringként tárolja a rendszer.

Feljegyzés

További információ a SecureString adatvédelemről: Mennyire biztonságos a SecureString?.

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

-DestinationPath

Annak a mappának az elérési útját adja meg, amelyben a súgófájlok mentésre kerülnek. Ne adjon meg fájlnevet vagy fájlnévkiterjesztést.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Azt jelzi, hogy ez a parancsmag nem követi a napi egyszeri korlátozást, kihagyja a verzióellenőrzést, és letölti az 1 GB-os korlátot meghaladó fájlokat.

Ezen paraméter nélkül minden modulhoz csak egy Save-Help parancs engedélyezett minden 24 órás időszakban, a letöltések modulonként legfeljebb 1 GB tömörítetlen tartalomra korlátozódnak, és a modul súgófájljai csak akkor települnek, ha újabbak, mint a számítógépen lévő fájlok.

A napi egyszeri korlát védi a súgófájlokat üzemeltető kiszolgálókat, és praktikussá teszi, hogy egy parancsot adjon hozzá Save-Help a PowerShell-profiljához.

Ha a Force paraméter nélkül szeretne segítséget menteni egy modulhoz több felhasználói felületi kultúrában, vegye fel az összes felhasználói felületi kultúrát ugyanabba a parancsba, például: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

Az érték lehet egy modul neve, egy teljes modul specifikációja vagy egy modulfájl elérési útja.

Ha az érték egy elérési út, az elérési út teljes mértékben minősített vagy relatív lehet. A relatív elérési út feloldása a használandó utasítást tartalmazó szkripthez képest történik.

Ha az érték egy név vagy egy modul specifikációja, a PowerShell megkeresi a PSModulePath-t a megadott modulban.

A modulspecifikáció egy kivonatoló, amely a következő kulcsokkal rendelkezik.

  • ModuleName - A Kötelező a modul nevét adja meg.
  • GUID - Nem kötelező : A modul GUID azonosítója.
  • Emellett az alábbi három kulcs közül legalább egyet meg kell adnia.
    • ModuleVersion – A modul minimálisan elfogadható verzióját adja meg.
    • MaximumVersion – Meghatározza a modul maximálisan elfogadható verzióját.
    • RequiredVersion – A modul pontos, kötelező verzióját adja meg. Ez nem használható a többi Verzió billentyűvel.

A Modul paraméterrel azonos parancsban nem adhatja meg a Teljesképűmodule paramétert. a két paraméter kölcsönösen kizárja egymást.

Type:ModuleSpecification[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

A célmappa elérési útját adja meg. A DestinationPath paraméter értékével ellentétben a LiteralPath paraméter értéke pontosan a beíráskor lesz használva. A rendszer egyetlen karaktert sem értelmez helyettesítő karakterként. Ha az elérési út tartalmaz escape karaktereket, csatolja egy idézőjelek közé. Az idézőjelek azt mondják a PowerShellnek, hogy ne értelmezzen karaktereket feloldósorozatként.

Type:String[]
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Module

Meghatározza azokat a modulokat, amelyekhez ez a parancsmag letölti a súgót. Adjon meg egy vagy több modulnevet vagy név pattert egy vesszővel tagolt listában vagy egy olyan fájlban, amely minden sorban egy modulnévvel rendelkezik. A helyettesítő karakterek használata engedélyezett. A modulobjektumokat a parancsmagból a Get-Module parancsmagba is be lehet csövezni Save-Help.

Alapértelmezés szerint letölti a súgót az összes olyan modulhoz, Save-Help amely támogatja az frissíthető súgót, és a helyi számítógépre van telepítve a PSModulePath környezeti változóban felsorolt helyen.

Ha a számítógépre nem telepített modulokhoz szeretne segítséget menteni, futtasson egy Get-Module parancsot egy távoli számítógépen. Ezután az eredményül kapott modulobjektumokat a Save-Help parancsmagba továbbítja, vagy küldje el a modulobjektumokat a Modul vagy az InputObject paraméterek értékeként.

Ha a megadott modul telepítve van a számítógépre, megadhatja a modul nevét vagy egy modulobjektumot. Ha a modul nincs telepítve a számítógépre, be kell írnia egy modulobjektumot, például a parancsmag által Get-Module visszaadottat.

A parancsmag Modul paramétere Save-Help nem fogadja el a modulfájl vagy a moduljegyzékfájl teljes elérési útját. Ha olyan modul súgóját szeretné menteni, amely nem PSModulePath-helyen található, importálja a modult az aktuális munkamenetbe a Save-Help parancs futtatása előtt.

A "*" (mind) érték megkísérli frissíteni a számítógépen telepített összes modul súgóját. Ide tartoznak azok a modulok, amelyek nem támogatják az frissíthető súgót. Ez az érték hibákat eredményezhet, ha a parancs olyan modulokkal találkozik, amelyek nem támogatják az frissíthető súgót.

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

-UICulture

Megadja azokat a felhasználói felületi kulturális értékeket, amelyekhez ez a parancsmag frissül a súgófájlokban. Adjon meg egy vagy több nyelvi kódot, például es-ESegy kulturális objektumokat tartalmazó változót, vagy egy kulturális objektumokat lekérő parancsot, például egy vagy Get-UICulture egy Get-Culture parancsot.

A helyettesítő karakterek nem engedélyezettek. Ne adjon meg részleges nyelvi kódot, például "de".

Alapértelmezés szerint Save-Help a windowsos vagy tartalék kultúrához beállított felhasználói felületi kultúra súgófájljait kapja meg. Ha megadja az UICulture paramétert, Save-Help csak a megadott felhasználói felületi kultúrához keres segítséget, tartalék kultúrában nem.

Type:CultureInfo[]
Position:2
Default value:Current UI culture
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseDefaultCredentials

Azt jelzi, hogy ez a parancsmag futtatja a parancsot, beleértve a webes letöltést is az aktuális felhasználó hitelesítő adataival. A parancs alapértelmezés szerint explicit hitelesítő adatok nélkül fut.

Ez a paraméter csak akkor érvényes, ha a webes letöltés NTLM-, egyeztetési vagy Kerberos-alapú hitelesítést használ.

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

Bevitelek

PSModuleInfo

Ehhez a parancsmaghoz modulobjektumot is csövezhet.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet.

Jegyzetek

  • A $pshome\Modules mappában lévő modulok súgójának mentéséhez indítsa el a PowerShellt a Futtatás rendszergazdaként lehetőséggel. A $pshome\Modules mappában lévő modulokhoz csak a Rendszergazda istrators csoport tagjai tölthetnek le súgót.
  • Az egyes modulok mentett súgója egy súgóinformációból (HelpInfo XML) é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 mentheti a számítógépre nem telepített modulok súgóját. Mivel azonban a súgófájlok a modul mappájába vannak telepítve, a parancsmag csak a Update-Help számítógépre telepített modulokra telepítheti 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, hibaüzenet megjelenítése nélkül 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. Egy adott parancsmaghoz nem menthet súgót, 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. Nem támogatja a többi beépülő modult.
  • A Update-Help parancsmagok és Save-Help a 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 parancsmagok és Save-Help parancsmagok nem támogatottak a Windows előtelepítési környezetében (Windows PE).