Install-Module
Stáhne jeden nebo více modulů z úložiště a nainstaluje je do místního počítače.
Syntax
NameParameterSet (Výchozí)
Install-Module
[-Name] <String[]>
[-MinimumVersion <String>]
[-MaximumVersion <String>]
[-RequiredVersion <String>]
[-Repository <String[]>]
[-Credential <PSCredential>]
[-Scope <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-AllowClobber]
[-SkipPublisherCheck]
[-Force]
[-AllowPrerelease]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject
Install-Module
[-InputObject] <PSObject[]>
[-Credential <PSCredential>]
[-Scope <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-AllowClobber]
[-SkipPublisherCheck]
[-Force]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Install-Module získá jeden nebo více modulů, které splňují zadaná kritéria z online úložiště. Rutina ověří, že výsledky hledání jsou platné moduly, a zkopíruje složky modulů do umístění instalace. Nainstalované moduly se po instalaci automaticky neimportují.
Můžete filtrovat, který modul se instaluje, na základě minimální, maximální a přesné verze zadaných modulů.
Pokud má nainstalovaný modul stejný název nebo verzi nebo obsahuje příkazy v existujícím modulu, zobrazí se zprávy upozornění. Po potvrzení, že chcete nainstalovat modul a přepsat upozornění, použijte parametry -Force a -AllowClobber parametry. V závislosti na nastavení úložiště možná budete muset odpovědět na výzvu k pokračování instalace modulu.
Tyto příklady používají galerii Prostředí PowerShell jako jediné registrované úložiště.
Get-PSRepository zobrazí zaregistrovaná úložiště. Pokud máte více registrovaných úložišť, zadejte název úložiště pomocí -Repository parametru.
Příklady
Příklad 1: Vyhledání a instalace modulu
Tento příklad najde v úložišti modul a nainstaluje ho.
Find-Module -Name PowerShellGet | Install-Module
Použije Find-Module parametr Name k určení modulu PowerShellGet . Ve výchozím nastavení se nejnovější verze modulu stáhne z úložiště. Objekt se odešle do kanálu do rutiny Install-Module.
Install-Module nainstaluje modul pro všechny uživatele v $env:ProgramFiles\PowerShell\Modules.
Příklad 2: Instalace modulu podle názvu
V tomto příkladu je nainstalovaná nejnovější verze modulu PowerShellGet .
Install-Module -Name PowerShellGet
Použije Install-Module parametr Name k určení modulu PowerShellGet . Ve výchozím nastavení se nejnovější verze modulu stáhne z úložiště a nainstaluje se.
Příklad 3: Instalace modulu pomocí minimální verze
V tomto příkladu se nainstaluje minimální verze modulu PowerShellGet . Parametr MinimumVersion určuje nejnižší verzi modulu, který se má nainstalovat. Pokud je k dispozici novější verze modulu, stáhne se a nainstaluje pro všechny uživatele.
Install-Module -Name PowerShellGet -MinimumVersion 2.0.1
Použije Install-Module parametr Name k určení modulu PowerShellGet . Parametr MinimumVersion určuje, že verze 2.0.1 je stažena z úložiště a nainstalována. Protože je k dispozici verze 2.0.4 , tato verze se stáhne a nainstaluje pro všechny uživatele.
Příklad 4: Instalace konkrétní verze modulu
V tomto příkladu se nainstaluje konkrétní verze modulu PowerShellGet .
Install-Module -Name PowerShellGet -RequiredVersion 2.0.0
Použije Install-Module parametr Name k určení modulu PowerShellGet . Parametr RequiredVersion určuje, že verze 2.0.0 je stažena a nainstalována pro všechny uživatele.
Příklad 5: Instalace modulu pouze pro aktuálního uživatele
Tento příklad stáhne a nainstaluje nejnovější verzi modulu, pouze pro aktuálního uživatele.
Install-Module -Name PowerShellGet -Scope CurrentUser
Použije Install-Module parametr Name k určení modulu PowerShellGet .
Install-Modulestáhne a nainstaluje nejnovější verzi PowerShellGetu do adresáře aktuálního uživatele . $home\Documents\PowerShell\Modules
Parametry
-AcceptLicense
Pro moduly, které vyžadují licenci, acceptLicense automaticky přijme licenční smlouvu během instalace. Další informace najdete v tématu Moduly vyžadující přijetí licence.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-AllowClobber
Přepíše zprávy upozornění týkající se konfliktů instalace existujících příkazů v počítači.
Přepíše existující příkazy, které mají stejný název jako příkazy nainstalované modulem.
AllowClobber a Force lze použít společně v Install-Module příkazu.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-AllowPrerelease
Umožňuje nainstalovat modul označený jako předběžná verze.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Confirm
Před spuštěním rutiny Install-Module vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Credential
Určuje uživatelský účet, který má práva k instalaci modulu pro zadaného poskytovatele balíčku nebo zdroje.
Vlastnosti parametru
| Typ: | PSCredential |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Force
Nainstaluje modul a přepíše upozornění na konflikty instalace modulu. Pokud na počítači již existuje modul se stejným názvem, umožňuje vynucení instalace více verzí. Pokud existuje existující modul se stejným názvem a verzí, vynuťte přepsání této verze.
Vynutit a AllowClobber je možné použít společně v Install-Module příkazu.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-InputObject
Používá se pro vstup kanálu. Pokud je hodnota zadaná přímo do objektu InputObject, vyvolá se chyba. Pomocí kanálu předejte objekty s parametrem InputObject .
Vlastnosti parametru
| Typ: | PSObject[] |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
InputObject
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | True |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-MaximumVersion
Určuje maximální verzi jednoho modulu, který se má nainstalovat. Nainstalovaná verze musí být menší nebo rovna hodnotě MaximumVersion. Pokud chcete nainstalovat více modulů, nemůžete použít MaximumVersion.
Maximálnost a požadovanou verzi nelze použít ve stejném Install-Module příkazu.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-MinimumVersion
Určuje minimální verzi jednoho modulu, který se má nainstalovat. Nainstalovaná verze musí být větší nebo rovna hodnotě MinimumVersion. Pokud je k dispozici novější verze modulu, nainstaluje se novější verze. Pokud chcete nainstalovat více modulů, nemůžete použít MinimumVersion.
Metody MinimumVersion a RequiredVersion nelze použít ve stejném Install-Module příkazu.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Name
Určuje přesné názvy modulů, které se mají nainstalovat z online galerie. Je přijat čárkami oddělený seznam názvů modulů. Název modulu se musí shodovat s názvem modulu v úložišti. Slouží Find-Module k získání seznamu názvů modulů.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-PassThru
Rutina Install-Module získá jeden nebo více modulů, které splňují zadaná kritéria z online úložiště. Rutina ověří, že výsledky hledání jsou platné moduly, a zkopíruje složky modulů do umístění instalace. Nainstalované moduly se po instalaci automaticky neimportují.
Můžete filtrovat, který modul se instaluje, na základě minimální, maximální a přesné verze zadaných modulů.
Pokud má nainstalovaný modul stejný název nebo verzi nebo obsahuje příkazy v existujícím modulu, zobrazí se zprávy upozornění. Po potvrzení, že chcete nainstalovat modul a přepsat upozornění, použijte parametry -Force a -AllowClobber parametry. V závislosti na nastavení úložiště možná budete muset odpovědět na výzvu k pokračování instalace modulu.
Tyto příklady používají galerii Prostředí PowerShell jako jediné registrované úložiště.
Get-PSRepository zobrazí zaregistrovaná úložiště. Pokud máte více registrovaných úložišť, zadejte název úložiště pomocí -Repository parametru.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Proxy
Určuje proxy server pro požadavek místo přímého připojení k internetovému prostředku.
Vlastnosti parametru
| Typ: | Uri |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-ProxyCredential
Určuje uživatelský účet, který má oprávnění používat proxy server určený parametrem Proxy.
Vlastnosti parametru
| Typ: | PSCredential |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Repository
Pomocí parametru Repository určete, které úložiště se použije ke stažení a instalaci modulu. Používá se při registraci více úložišť. Určuje název registrovaného úložiště v Install-Module příkazu. K registraci úložiště použijte Register-PSRepository.
Chcete-li zobrazit registrovaná úložiště, použijte Get-PSRepository.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-RequiredVersion
Určuje přesnou verzi jednoho modulu, který se má nainstalovat. Pokud v úložišti pro zadanou verzi není žádná shoda, zobrazí se chyba. Pokud chcete nainstalovat více modulů, nemůžete použít RequiredVersion.
RequiredVersion nelze použít ve stejném Install-Module příkazu jako MinimumVersion nebo MaximumVersion.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
NameParameterSet
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Scope
Určuje rozsah instalace modulu. Přijatelné hodnoty pro tento parametr jsou AllUsers a CurrentUser.
Rozsah AllUsers nainstaluje moduly do umístění, které je přístupné všem uživatelům počítače:
$env:ProgramFiles\PowerShell\Modules
CurrentUser nainstaluje moduly do umístění, které je přístupné pouze aktuálnímu uživateli počítače. Například:
$home\Documents\PowerShell\Modules
Pokud není definován žádný obor , nastaví se výchozí nastavení na základě verze PowerShellGet.
- Ve verzi PowerShellGet 2.0.0 a vyšší je výchozí hodnota CurrentUser, která nevyžaduje zvýšení oprávnění pro instalaci.
- Ve verzích PowerShellGet 1.xch
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Přípustné hodnoty: | CurrentUser, AllUsers |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-SkipPublisherCheck
Umožňuje nainstalovat novější verzi modulu, který už na vašem počítači existuje. Například když je existující modul digitálně podepsán důvěryhodným vydavatelem, ale nová verze není digitálně podepsána důvěryhodným vydavatelem.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když Install-Module se spustí příkaz. Příkazový modul nebyl spuštěn.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
PSRepositoryItemInfo
Find-Module vytvoří PSRepositoryItemInfo objekty, které lze odeslat kanál do Install-Module.
String
PSObject
String
PSCredential
Uri
Výstupy
Microsoft.PowerShell.Commands.PSRepositoryItemInfo
Při použití PassThru parametru, Install-Module výstup PSRepositoryItemInfo objekt pro modul. Jedná se o stejné informace, které získáte z rutiny Find-Module .
Poznámky
Install-Module běží v PowerShellu 5.0 nebo novějších verzích ve Windows 7 nebo Windows 2008 R2 a novějších verzích Windows.
Důležité
Od dubna 2020 galerie Prostředí PowerShell už nepodporuje protokol TLS (Transport Layer Security) verze 1.0 a 1.1. Pokud nepoužíváte protokol TLS 1.2 nebo vyšší, při pokusu o přístup k galerii Prostředí PowerShell se zobrazí chyba. Pomocí následujícího příkazu se ujistěte, že používáte protokol TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Další informace najdete v oznámení v blogu PowerShellu.
Osvědčeným postupem zabezpečení je vyhodnotit kód modulu před prvním spuštěním rutin nebo funkcí. Aby se zabránilo spouštění modulů obsahujících škodlivý kód, nejsou nainstalované moduly po instalaci automaticky importovány.
Pokud název modulu určený parametrem Name v úložišti neexistuje, Install-Module vrátí chybu.
Pokud chcete nainstalovat více modulů, použijte parametr Name a zadejte pole názvů modulů oddělených čárkami. Pokud zadáte více názvů modulů, nemůžete použít MinimumVersion, MaximumVersion nebo RequiredVersion.
Find-Module vytvoří PSRepositoryItemInfo objekty, které lze odeslat kanál do Install-Module. Kanál je dalším způsobem, jak zadat více modulů, které se mají nainstalovat v jednom příkazu.
Ve výchozím nastavení jsou moduly pro obor AllUsers nainstalovány v $env:ProgramFiles\PowerShell\Modules. Výchozí nastavení zabraňuje nejasnostem při instalaci prostředků DSC (PowerShell Desired State Configuration).
Instalace modulu se nezdaří a nelze jej importovat, pokud ve složce neobsahuje soubor se .psm1stejným názvem , .psd1nebo .dll . K instalaci modulu použijte parametr Force .
Pokud se verze existujícího modulu shoduje s názvem určeným parametrem Name a parametr MinimumVersion nebo RequiredVersion se nepoužije, modul se bezobslužně prodlužuje, Install-Module ale nenainstaluje se.
Pokud je verze existujícího modulu větší než hodnota parametru MinimumVersion nebo se rovná hodnotě parametru RequiredVersion , tiše pokračuje, Install-Module ale modul se nenainstaluje.
Pokud stávající modul neodpovídá hodnotám určeným parametry MinimumVersion nebo RequiredVersion , dojde v Install-Module příkazu k chybě. Pokud je například verze existujícího nainstalovaného modulu nižší než hodnota MinimumVersion nebo se nerovná hodnotě RequiredVersion .
Při instalaci modulu se nainstalují také všechny závislé moduly určené podle požadavků vydavatele modulu. Vydavatel určí požadované moduly a jejich verze v manifestu modulu.