Install-Module
Mengunduh satu atau beberapa modul dari repositori, dan menginstalnya di komputer lokal.
Sintaks
NameParameterSet (Default)
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>]
Deskripsi
Install-Module Cmdlet mendapatkan satu atau beberapa modul yang memenuhi kriteria tertentu dari repositori online. Cmdlet memverifikasi bahwa hasil pencarian adalah modul yang valid dan menyalin folder modul ke lokasi penginstalan. Modul yang diinstal tidak diimpor secara otomatis setelah penginstalan.
Anda dapat memfilter modul mana yang diinstal berdasarkan versi minimum, maksimum, dan tepat dari modul yang ditentukan.
Jika modul yang diinstal memiliki nama atau versi yang sama, atau berisi perintah dalam modul yang ada, pesan peringatan akan ditampilkan. Setelah Anda mengonfirmasi bahwa Anda ingin menginstal modul dan mengambil alih peringatan, gunakan -Force parameter dan -AllowClobber . Bergantung pada pengaturan repositori Anda, Anda mungkin perlu menjawab permintaan agar penginstalan modul dilanjutkan.
Parameter yang mengambil nomor versi modul mengharapkan string yang diformat sebagai nomor versi.
- Nomor versi standar memiliki format di
x.y.zmana x, y, dan z adalah angka - Versi prarilis memiliki format
x.y.z-<prerelease_label>di mana string arbitrer ditetapkan ke rilis tersebut<prerelease_label>.
Contoh-contoh ini menggunakan Galeri PowerShell sebagai satu-satunya repositori terdaftar.
Get-PSRepository menampilkan repositori terdaftar. Jika Anda memiliki beberapa repositori terdaftar, gunakan -Repository parameter untuk menentukan nama repositori.
Contoh
Contoh 1: Menemukan dan menginstal modul
Contoh ini menemukan modul di repositori dan menginstal modul.
Find-Module -Name PowerShellGet | Install-Module
Find-Module menggunakan parameter Nama untuk menentukan modul PowerShellGet. Secara default, versi terbaru modul diunduh dari repositori. Objek dikirimkan alur ke cmdlet Install-Module.
Install-Module menginstal modul untuk semua pengguna di $env:ProgramFiles\PowerShell\Modules.
Contoh 2: Menginstal modul berdasarkan nama
Dalam contoh ini, versi terbaru modul PowerShellGet diinstal.
Install-Module -Name PowerShellGet
Install-Module menggunakan parameter Nama untuk menentukan modul PowerShellGet. Secara default, versi terbaru modul diunduh dari repositori dan diinstal.
Contoh 3: Menginstal modul menggunakan versi minimumnya
Dalam contoh ini, versi minimum modul PowerShellGet diinstal. Parameter MinimumVersion menentukan versi terendah modul yang harus diinstal. Jika versi modul yang lebih baru tersedia, versi tersebut diunduh dan diinstal untuk semua pengguna.
Install-Module -Name PowerShellGet -MinimumVersion 2.0.1
Install-Module menggunakan parameter Nama untuk menentukan modul PowerShellGet. Parameter MinimumVersion menentukan bahwa versi 2.0.1 diunduh dari repositori dan diinstal. Karena versi 2.0.4 tersedia, versi tersebut diunduh dan diinstal untuk semua pengguna.
Contoh 4: Menginstal versi modul tertentu
Dalam contoh ini, versi tertentu dari modul PowerShellGet diinstal.
Install-Module -Name PowerShellGet -RequiredVersion 2.0.0
Install-Module menggunakan parameter Nama untuk menentukan modul PowerShellGet. Parameter RequiredVersion menentukan bahwa versi 2.0.0 diunduh dan diinstal untuk semua pengguna.
Contoh 5: Instal modul hanya untuk pengguna saat ini
Contoh ini mengunduh dan menginstal versi terbaru modul, hanya untuk pengguna saat ini.
Install-Module -Name PowerShellGet -Scope CurrentUser
Install-Module menggunakan parameter Nama untuk menentukan modul PowerShellGet.
Install-Module mengunduh dan menginstal versi terbaru PowerShellGet ke direktori pengguna saat ini, $HOME\Documents\PowerShell\Modules.
Contoh 6: Menginstal versi prarilis terbaru modul
Contoh ini menunjukkan cara menginstal versi terbaru modul saat versi tersebut adalah versi prarilis. Menginstal versi prarilis memerlukan parameter AllowPrerelease .
Install-Module -Name Microsoft.PowerShell.Crescendo -AllowPrerelease
Menggunakan metode ini, Anda mendapatkan versi terbaru yang tersedia. Jika versi terbaru bukan prarilis, Anda mendapatkan versi stabil terbaru modul.
Contoh 7: Menginstal versi prarilis tertentu dari modul
Contoh ini menunjukkan cara menginstal versi prarilis tertentu dari modul.
Find-Module Cmdlet dapat digunakan untuk menemukan versi modul prarilis di Galeri PowerShell.
Versi prarilis memiliki format <version_number>-<prerelease_label>.
Find-Module PSReadLine -AllVersions -AllowPrerelease | Select-Object -First 5
Version Name Repository Description
------- ---- ---------- -----------
2.2.6 PSReadLine PSGallery Great command line editing in the PowerS…
2.2.5 PSReadLine PSGallery Great command line editing in the PowerS…
2.2.4-beta1 PSReadLine PSGallery Great command line editing in the PowerS…
2.2.3 PSReadLine PSGallery Great command line editing in the PowerS…
2.2.2 PSReadLine PSGallery Great command line editing in the PowerS…
Install-Module -Name PSReadLine -RequiredVersion 2.2.4-beta1 -AllowPrerelease
Gunakan versi yang diperlihatkan di Galeri PowerShell untuk nilai parameter RequiredVersion .
Parameter
-AcceptLicense
Untuk modul yang memerlukan lisensi, AcceptLicense secara otomatis menerima perjanjian lisensi selama penginstalan. Untuk informasi selengkapnya, lihat Modul yang Memerlukan Penerimaan Lisensi.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-AllowClobber
Mengesampingkan pesan peringatan tentang konflik penginstalan tentang perintah yang ada di komputer.
Menimpa perintah yang ada yang memiliki nama yang sama dengan perintah yang diinstal oleh modul.
AllowClobber dan Force dapat digunakan bersama-sama dalam perintah Install-Module .
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-AllowPrerelease
Memungkinkan Anda menginstal modul yang ditandai sebagai pra-rilis.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Confirm
Meminta konfirmasi sebelum menjalankan cmdlet Install-Module.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | Cf |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Credential
Menentukan akun pengguna yang memiliki hak untuk menginstal modul untuk penyedia atau sumber paket tertentu.
Properti parameter
| Jenis: | PSCredential |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-Force
Menginstal modul dan mengambil alih pesan peringatan tentang konflik penginstalan modul. Jika modul dengan nama yang sama sudah ada di komputer, Force memungkinkan beberapa versi diinstal. Jika ada modul yang ada dengan nama dan versi yang sama, Paksa timpa versi tersebut.
Force dan AllowClobber dapat digunakan bersama-sama dalam perintah Install-Module .
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-InputObject
Digunakan untuk input alur. Kesalahan dilemparkan jika nilai yang disediakan langsung ke InputObject. Gunakan alur untuk meneruskan objek dengan parameter InputObject .
Properti parameter
| Jenis: | PSObject[] |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
InputObject
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-MaximumVersion
Menentukan versi maksimum dari satu modul yang akan diinstal. Versi yang diinstal harus kurang dari atau sama dengan MaximumVersion. Jika Anda ingin menginstal beberapa modul, Anda tidak dapat menggunakan MaximumVersion.
MaximumVersion dan RequiredVersion tidak dapat digunakan dalam perintah yang sama Install-Module .
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-MinimumVersion
Menentukan versi minimum modul tunggal untuk diinstal. Versi yang diinstal harus lebih besar dari atau sama dengan MinimumVersion. Jika ada versi modul yang lebih baru yang tersedia, versi yang lebih baru akan diinstal. Jika Anda ingin menginstal beberapa modul, Anda tidak dapat menggunakan MinimumVersion.
MinimumVersion dan RequiredVersion tidak dapat digunakan dalam perintah yang sama Install-Module .
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-Name
Menentukan nama modul yang tepat untuk diinstal dari galeri online. Daftar nama modul yang dipisahkan koma diterima. Nama modul harus cocok dengan nama modul di repositori. Gunakan Find-Module untuk mendapatkan daftar nama modul.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-PassThru
Saat menggunakan parameter PassThru , Install-Module menghasilkan objek PSRepositoryItemInfo untuk modul.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Proxy
Menentukan server proksi untuk permintaan, daripada menyambungkan langsung ke sumber daya Internet.
Properti parameter
| Jenis: | Uri |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-ProxyCredential
Menentukan akun pengguna yang memiliki izin untuk menggunakan server proksi yang ditentukan oleh parameter Proksi.
Properti parameter
| Jenis: | PSCredential |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-Repository
Gunakan parameter Repositori untuk menentukan nama repositori tempat mengunduh dan menginstal modul. Digunakan saat beberapa repositori didaftarkan. Menentukan nama repositori terdaftar dalam Install-Module perintah. Untuk mendaftarkan repositori, gunakan Register-PSRepository.
Untuk menampilkan repositori terdaftar, gunakan Get-PSRepository.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-RequiredVersion
Menentukan versi yang tepat dari satu modul untuk diinstal. Jika tidak ada kecocokan di repositori untuk versi yang ditentukan, kesalahan akan ditampilkan. Jika Anda ingin menginstal beberapa modul, Anda tidak dapat menggunakan RequiredVersion.
RequiredVersion tidak dapat digunakan dalam perintah yang sama Install-Module dengan MinimumVersion atau MaximumVersion.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
NameParameterSet
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-Scope
Menentukan cakupan penginstalan modul. Nilai yang dapat diterima untuk parameter ini adalah AllUsers dan CurrentUser.
Cakupan AllUsers menginstal modul di lokasi yang dapat diakses oleh semua pengguna komputer:
$env:ProgramFiles\PowerShell\Modules
CurrentUser menginstal modul di lokasi yang hanya dapat diakses oleh pengguna komputer saat ini. Contohnya:
$HOME\Documents\PowerShell\Modules
Saat tidak ada Cakupan yang ditentukan, default diatur berdasarkan versi PowerShellGet.
- Dalam versi PowerShellGet 1.x, defaultnya adalah AllUsers, yang memerlukan elevasi untuk penginstalan.
- Untuk PowerShellGet versi 2.0.0 ke atas di PowerShell 6 atau yang lebih tinggi:
- Defaultnya adalah CurrentUser, yang tidak memerlukan elevasi untuk penginstalan.
- Jika Anda berjalan dalam sesi yang ditingkatkan, defaultnya adalah AllUsers.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Nilai yang diterima: | CurrentUser, AllUsers |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SkipPublisherCheck
Memungkinkan Anda menginstal versi modul yang lebih baru yang sudah ada di komputer Anda. Misalnya, ketika modul yang ada ditandatangani secara digital oleh penerbit tepercaya tetapi versi baru tidak ditandatangani secara digital oleh penerbit tepercaya.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-WhatIf
Memperlihatkan apa yang akan terjadi jika perintah Install-Module dijalankan. Cmdlet tidak dijalankan.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | wi |
Kumpulan parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
Input
PSRepositoryItemInfo
Find-Module membuat objek PSRepositoryItemInfo yang dapat dikirimkan alur ke Install-Module.
String
PSObject
String
PSCredential
Uri
Output
Microsoft.PowerShell.Commands.PSRepositoryItemInfo
Saat menggunakan parameter PassThru , Install-Module menghasilkan objek PSRepositoryItemInfo untuk modul. Ini adalah informasi yang sama dengan yang Anda dapatkan dari Find-Module cmdlet.
Catatan
PowerShell menyertakan alias berikut untuk Install-Module:
- Semua platform:
inmo
Install-Module berjalan pada rilis PowerShell 5.0 atau yang lebih baru, pada Windows 7 atau Windows 2008 R2 dan rilis Windows yang lebih baru.
Penting
Pada April 2020, Galeri PowerShell tidak lagi mendukung Transport Layer Security (TLS) versi 1.0 dan 1.1. Jika Anda tidak menggunakan TLS 1.2 atau yang lebih tinggi, Anda akan menerima kesalahan saat mencoba mengakses Galeri PowerShell. Gunakan perintah berikut untuk memastikan Anda menggunakan TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Untuk informasi selengkapnya, lihat pengumuman
Sebagai praktik terbaik keamanan, evaluasi kode modul sebelum menjalankan cmdlet atau fungsi apa pun untuk pertama kalinya. Untuk mencegah menjalankan modul yang berisi kode berbahaya, modul yang diinstal tidak diimpor secara otomatis setelah penginstalan.
Jika nama modul yang ditentukan oleh parameter Nama tidak ada di repositori, Install-Module mengembalikan kesalahan.
Untuk menginstal beberapa modul, gunakan parameter Nama dan tentukan array nama modul yang dipisahkan koma. Jika Anda menentukan beberapa nama modul, Anda tidak dapat menggunakan MinimumVersion, MaximumVersion, atau RequiredVersion.
Find-Module membuat objek PSRepositoryItemInfo yang dapat dikirimkan alur ke Install-Module. Alur adalah cara lain untuk menentukan beberapa modul untuk diinstal dalam satu perintah.
Secara default, modul untuk cakupan AllUsers diinstal di $env:ProgramFiles\PowerShell\Modules. Default mencegah kebingungan saat Anda menginstal sumber daya PowerShell Desired State Configuration (DSC).
Penginstalan modul gagal dan tidak dapat diimpor jika tidak memiliki .psm1, , .psd1atau .dll dengan nama yang sama dalam folder. Gunakan parameter Paksa untuk menginstal modul.
Jika versi modul yang ada cocok dengan nama yang ditentukan oleh parameter Nama , dan parameter MinimumVersion atau RequiredVersion tidak digunakan, Install-Module diam-diam berlanjut tetapi tidak menginstal modul.
Jika versi modul yang ada lebih besar dari nilai parameter MinimumVersion , atau sama dengan nilai parameter RequiredVersion , Install-Module diam-diam berlanjut tetapi tidak menginstal modul.
Jika modul yang ada tidak cocok dengan nilai yang ditentukan oleh parameter MinimumVersion atau RequiredVersion , kesalahan terjadi dalam Install-Module perintah. Misalnya, jika versi modul yang diinstal yang ada lebih rendah dari nilai MinimumVersion atau tidak sama dengan nilai RequiredVersion .
Install-Module juga menginstal modul dependen apa pun yang ditentukan sebagaimana diperlukan oleh penerbit modul.
Penerbit mencantumkan modul yang diperlukan dan versinya dalam manifes modul.
