Get-Help

  • Referensi
Modul:
Microsoft.PowerShell.Core

Menampilkan informasi tentang perintah dan konsep PowerShell.

Sintaks

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Deskripsi

Get-Help Cmdlet menampilkan informasi tentang konsep dan perintah PowerShell, termasuk cmdlet, fungsi, perintah Common Information Model (CIM), alur kerja, penyedia, alias, dan skrip.

Untuk mendapatkan bantuan untuk cmdlet PowerShell, ketik Get-Help diikuti dengan nama cmdlet, seperti: Get-Help Get-Process.

Artikel bantuan konseptual di PowerShell dimulai dengan about_, seperti about_Comparison_Operators. Untuk melihat semua artikel about_ , ketik Get-Help about_*. Untuk melihat artikel tertentu, ketik Get-Help about_<article-name>, seperti Get-Help about_Comparison_Operators.

Untuk mendapatkan bantuan untuk penyedia PowerShell, ketik Get-Help diikuti dengan nama penyedia. Misalnya, untuk mendapatkan bantuan untuk penyedia Sertifikat, ketik Get-Help Certificate.

Anda juga dapat mengetik help atau man, yang menampilkan satu layar teks sekaligus. Atau, <cmdlet-name> -?, itu identik dengan Get-Help, tetapi hanya berfungsi untuk cmdlet.

Get-Help mendapatkan isi bantuan yang ditampilkannya dari berkas bantuan pada komputer Anda. Tanpa file bantuan, Get-Help hanya menampilkan informasi dasar tentang cmdlet. Beberapa modul PowerShell menyertakan file bantuan. Dimulai di PowerShell 3.0, modul yang disertakan dengan sistem operasi Windows tidak menyertakan file bantuan. Untuk mengunduh atau memperbarui file bantuan untuk modul di PowerShell 3.0, gunakan Update-Help cmdlet .

Anda juga bisa menampilkan dokumen bantuan PowerShell secara online. Untuk mendapatkan versi online file bantuan, gunakan parameter Online , seperti: Get-Help Get-Process -Online.

Jika Anda mengetik Get-Help diikuti dengan nama yang tepat dari artikel bantuan, atau dengan kata yang unik untuk artikel bantuan, Get-Help menampilkan konten artikel. Jika Anda menentukan nama alias perintah yang tepat, Get-Help menampilkan bantuan untuk perintah asli. Jika Anda memasukkan pola kata atau kata yang muncul di beberapa judul artikel bantuan, Get-Help menampilkan daftar judul yang cocok. Jika Anda memasukkan teks apa pun yang tidak muncul di judul artikel bantuan apa pun, Get-Help menampilkan daftar artikel yang menyertakan teks tersebut dalam kontennya.

Get-Help bisa mendapatkan artikel bantuan untuk semua bahasa dan lokal yang didukung. Get-Help pertama mencari file bantuan di lokal yang ditetapkan untuk Windows, lalu di lokal induk, seperti pt untuk pt-BR, dan kemudian di lokal fallback. Dimulai di PowerShell 3.0, jika Get-Help tidak menemukan bantuan di lokal fallback, powerShell mencari artikel bantuan dalam bahasa Inggris, en-US, sebelum menampilkan pesan kesalahan atau menampilkan bantuan yang dibuat secara otomatis.

Untuk informasi tentang simbol yang Get-Help ditampilkan dalam diagram sintaks perintah, lihat about_Command_Syntax. Untuk informasi tentang atribut parameter, seperti Diperlukan dan Posisi, lihat about_Parameters.

Catatan

Di PowerShell 3.0 dan PowerShell 4.0, Get-Help tidak dapat menemukan Tentang artikel dalam modul kecuali modul diimpor ke sesi saat ini. Untuk mendapatkan artikel Tentang dalam modul, impor modul menggunakan Import-Module cmdlet atau dengan menjalankan cmdlet yang disertakan dalam modul.

Dimulai dengan PSReadLine v2.2.2, modul dikirim dengan dua fungsi yang menyediakan akses cepat untuk membantu saat Anda mengetik perintah pada baris perintah. Bantuan ditampilkan di terminal dalam buffer layar alternatif dengan halaman.

Saat Anda menekan kunci F1 , fungsi PSReadLineShowCommandHelp memanggil Get-Help -Full nama cmdlet yang paling dekat dengan kiri kursor. Ketika kursor segera berada di sebelah kiri parameter, fungsi melompat ke deskripsi parameter tersebut dalam topik bantuan lengkap. Saat Anda menekan Q untuk keluar dari tampilan bantuan, Anda dikembalikan ke baris perintah pada posisi kursor yang sama sehingga Anda dapat terus mengetik perintah.

Saat Anda menggunakan kombinasi kunci Alt+h, fungsi PSReadLineShowParameterHelp menampilkan informasi bantuan untuk parameter segera di sebelah kiri kursor. Teks bantuan ditampilkan di bawah baris perintah. Ini memungkinkan Anda untuk melihat deskripsi parameter dan terus mengetik perintah Anda.

Untuk informasi selengkapnya, lihat Menggunakan bantuan dinamis.

Contoh

Contoh 1: Menampilkan informasi bantuan dasar tentang cmdlet

Contoh-contoh ini menampilkan informasi bantuan dasar tentang Format-Table cmdlet.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> adalah sintaks Get-Help cmdlet yang paling sederhana dan default. Anda dapat menghilangkan parameter Nama .

Sintaks <cmdlet-name> -? hanya berfungsi untuk cmdlet.

Contoh 2: Menampilkan informasi dasar satu halaman dalam satu waktu

Contoh-contoh ini menampilkan informasi bantuan dasar tentang Format-Table cmdlet satu halaman pada satu waktu.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help adalah fungsi yang menjalankan Get-Help cmdlet secara internal dan menampilkan hasil satu halaman pada satu waktu.

man adalah alias untuk fungsi tersebut help .

Get-Help Format-Table mengirim objek ke bawah alur. Out-Host -Paging menerima output dari alur dan menampilkannya satu halaman sekaligus. Untuk informasi selengkapnya, lihat Out-Host.

Contoh 3: Menampilkan informasi selengkapnya untuk cmdlet

Contoh-contoh ini menampilkan informasi bantuan yang lebih rinci tentang Format-Table cmdlet.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Parameter Terperinci menampilkan tampilan terperinci artikel bantuan yang menyertakan deskripsi dan contoh parameter.

Parameter Lengkap menampilkan tampilan lengkap artikel bantuan yang menyertakan deskripsi parameter, contoh, jenis objek input dan output, dan catatan tambahan.

Parameter Terperinci dan Lengkap hanya efektif untuk perintah yang memiliki file bantuan yang diinstal di komputer. Parameter tidak efektif untuk artikel bantuan konseptual (about_).

Contoh 4: Menampilkan bagian cmdlet yang dipilih dengan menggunakan parameter

Contoh-contoh ini menampilkan bagian yang dipilih dari Format-Table bantuan cmdlet.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Parameter Contoh menampilkan bagian NAME dan SYNOPSIS file bantuan, dan semua Contoh. Anda tidak dapat menentukan Nomor contoh karena parameter Contoh adalah parameter pengalihan.

Parameter Parameter hanya menampilkan deskripsi parameter yang ditentukan. Jika Anda hanya menentukan karakter kartubebas tanda bintang (*), karakter tersebut akan menampilkan deskripsi semua parameter. Saat Parameter menentukan nama parameter seperti GroupBy, informasi tentang parameter tersebut ditampilkan.

Parameter ini tidak efektif untuk artikel bantuan konseptual (about_).

Contoh 5: Menampilkan versi bantuan online

Contoh ini menampilkan versi online artikel bantuan untuk Format-Table cmdlet di browser web default Anda.

Get-Help Format-Table -Online

Contoh 6: Menampilkan bantuan tentang sistem bantuan

Get-Help Cmdlet tanpa parameter menampilkan informasi tentang sistem bantuan PowerShell.

Get-Help

Contoh 7: Menampilkan artikel bantuan yang tersedia

Contoh ini menampilkan daftar semua artikel bantuan yang tersedia di komputer Anda.

Get-Help *

Contoh 8: Menampilkan daftar artikel konseptual

Contoh ini menampilkan daftar artikel konseptual yang disertakan dalam bantuan PowerShell. Semua artikel ini dimulai dengan karakter about_. Untuk menampilkan file bantuan tertentu, ketik Get-Help \<about_article-name\>, misalnya, Get-Help about_Signing.

Hanya artikel konseptual yang memiliki file bantuan yang terinstal di komputer Anda yang ditampilkan. Untuk informasi tentang mengunduh dan menginstal file bantuan di PowerShell 3.0, lihat Pembaruan-Bantuan.

Get-Help about_*

Contoh 9: Mencari kata dalam bantuan cmdlet

Contoh ini memperlihatkan cara mencari kata dalam artikel bantuan cmdlet.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Helpmenggunakan parameter Lengkap untuk mendapatkan informasi bantuan untuk Add-Member. Objek MamlCommandHelpInfo dikirim ke alur. Out-Stringmenggunakan parameter Stream untuk mengonversi objek menjadi string. Select-Stringmenggunakan parameter Pola untuk mencari string untuk Clixml.

Contoh 10: Menampilkan daftar artikel yang menyertakan kata

Contoh ini menampilkan daftar artikel yang menyertakan kata jarak jauh.

Saat Anda memasukkan kata yang tidak muncul di judul artikel apa pun, Get-Help menampilkan daftar artikel yang menyertakan kata tersebut.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Contoh 11: Menampilkan bantuan khusus penyedia

Contoh ini menunjukkan dua cara mendapatkan bantuan khusus penyedia untuk Get-Item. Perintah ini mendapatkan bantuan yang menjelaskan cara menggunakan Get-Item cmdlet di simpul DataCollection penyedia PowerShell SQL Server.

Contoh pertama menggunakan Get-Helpparameter Jalur untuk menentukan jalur penyedia SQL Server. Karena jalur penyedia ditentukan, Anda dapat menjalankan perintah dari lokasi jalur mana pun.

Contoh kedua menggunakan Set-Location untuk menavigasi ke jalur penyedia SQL Server. Dari lokasi tersebut , parameter Jalur tidak diperlukan untuk Get-Help mendapatkan bantuan khusus penyedia.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Contoh 12: Menampilkan bantuan untuk skrip

Contoh ini mendapatkan bantuan untuk MyScript.ps1 script. Untuk informasi tentang cara menulis bantuan untuk fungsi dan skrip Anda, lihat about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parameter

-Category

Menampilkan bantuan hanya untuk item dalam kategori yang ditentukan dan aliasnya. Artikel konseptual berada dalam kategori HelpFile .

Nilai yang dapat diterima untuk parameter ini adalah sebagai berikut:

  • Alias
  • Cmdlet
  • Penyedia
  • Umum
  • FAQ
  • Glosarium
  • HelpFile
  • ScriptCommand
  • Fungsi
  • Filter
  • ExternalScript
  • Semua
  • DefaultHelp
  • Alur kerja
  • DscResource
  • Kelas
  • Konfigurasi
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Menampilkan perintah dengan nilai komponen yang ditentukan, seperti Exchange. Masukkan nama komponen. Karakter kartubebas diizinkan. Parameter ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Detailed

Menambahkan deskripsi parameter dan contoh ke tampilan bantuan dasar. Parameter ini hanya efektif ketika file bantuan diinstal pada komputer. Ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Examples

Hanya menampilkan nama, sinopsis, dan contoh. Parameter ini hanya efektif ketika file bantuan diinstal pada komputer. Ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Full

Menampilkan seluruh artikel bantuan untuk cmdlet. Lengkapnya mencakup deskripsi parameter dan atribut, contoh, jenis objek input dan output, dan catatan tambahan.

Parameter ini hanya efektif ketika file bantuan diinstal pada komputer. Ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Functionality

Menampilkan bantuan untuk item dengan fungsionalitas yang ditentukan. Masukkan fungsionalitas. Karakter kartubebas diizinkan. Parameter ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Name

Mendapatkan bantuan tentang perintah atau konsep yang ditentukan. Masukkan nama cmdlet, fungsi, penyedia, skrip, atau alur kerja, seperti Get-Member, nama artikel konseptual, seperti about_Objects, atau alias, seperti ls. Karakter kartubebas diizinkan dalam cmdlet dan nama penyedia, tetapi Anda tidak dapat menggunakan karakter kartubebas untuk menemukan nama bantuan fungsi dan artikel bantuan skrip.

Untuk mendapatkan bantuan untuk skrip yang tidak terletak di jalur yang tercantum dalam $env:Path variabel lingkungan, ketik jalur skrip dan nama file.

Jika Anda memasukkan nama yang tepat dari artikel bantuan, Get-Help menampilkan konten artikel.

Jika Anda memasukkan pola kata atau kata yang muncul di beberapa judul artikel bantuan, Get-Help menampilkan daftar judul yang cocok.

Jika Anda memasukkan teks apa pun yang tidak cocok dengan judul artikel bantuan apa pun, Get-Help menampilkan daftar artikel yang menyertakan teks tersebut dalam kontennya.

Nama-nama artikel konseptual, seperti about_Objects, harus dimasukkan dalam bahasa Inggris, bahkan dalam versi powerShell non-bahasa Inggris.

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

-Online

Menampilkan versi online artikel bantuan di browser default. Parameter ini hanya berlaku untuk artikel bantuan cmdlet, fungsi, alur kerja, dan skrip. Anda tidak dapat menggunakan parameter Online dengan Get-Help dalam sesi jarak jauh.

Untuk informasi tentang mendukung fitur ini dalam artikel bantuan yang Anda tulis, lihat about_Comment_Based_Help, dan Bantuan Online Pendukung, dan Bantuan Penulisan untuk Cmdlet PowerShell.

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

-Parameter

Hanya menampilkan deskripsi terperinci dari parameter yang ditentukan. Kartubebas diizinkan. Parameter ini tidak berpengaruh pada tampilan bantuan konseptual (About_).

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

-Path

Mendapatkan bantuan yang menjelaskan cara kerja cmdlet di jalur penyedia yang ditentukan. Masukkan jalur penyedia PowerShell.

Parameter ini mendapatkan versi yang disesuaikan dari artikel bantuan cmdlet yang menjelaskan cara kerja cmdlet di jalur penyedia PowerShell yang ditentukan. Parameter ini hanya efektif untuk bantuan tentang cmdlet penyedia dan hanya ketika penyedia menyertakan versi kustom artikel bantuan cmdlet penyedia dalam file bantuannya. Untuk menggunakan parameter ini, instal file bantuan untuk modul yang menyertakan penyedia.

Untuk melihat bantuan cmdlet kustom untuk jalur penyedia, buka lokasi jalur penyedia dan masukkan Get-Help perintah atau, dari lokasi jalur mana pun, gunakan parameter Get-Help Jalur untuk menentukan jalur penyedia. Anda juga dapat menemukan cmdlet kustom bantuan online di bagian bantuan penyedia dari artikel bantuan.

Untuk informasi selengkapnya tentang penyedia PowerShell, lihat about_Providers.

Catatan

Penyedia untuk jalur yang ditentukan harus menginstal file bantuan penyedia PowerShell. Jika tidak ada file bantuan penyedia yang tersedia, tidak ada informasi bantuan yang dikembalikan. Tidak ada file bantuan penyedia yang tersedia untuk penyedia yang disertakan dengan versi PowerShell ini.

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

-Role

Tampilan membantu dikustomisasi untuk peran pengguna yang ditentukan. Masukkan peran. Karakter kartubebas diizinkan.

Masukkan peran yang dimainkan pengguna dalam organisasi. Beberapa cmdlet menampilkan teks yang berbeda dalam file bantuan mereka berdasarkan nilai parameter ini. Parameter ini tidak berpengaruh pada bantuan untuk cmdlet inti.

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

-ShowWindow

Menampilkan topik bantuan dalam jendela agar lebih mudah dibaca. Jendela menyertakan fitur Temukan pencarian dan kotak Pengaturan yang memungkinkan Anda mengatur opsi untuk tampilan, termasuk opsi untuk menampilkan hanya bagian yang dipilih dari topik bantuan.

Parameter ShowWindow mendukung topik bantuan untuk perintah (cmdlet, fungsi, perintah CIM, skrip) dan artikel Tentang konseptual. Ini tidak mendukung bantuan penyedia.

Parameter ini diperkenalkan kembali di PowerShell 7.0. Parameter ini hanya tersedia di Windows.

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

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

ExtendedCmdletHelpInfo

Jika Anda menjalankan Get-Help pada perintah yang tidak memiliki file bantuan, Get-Help mengembalikan objek ExtendedCmdletHelpInfo yang mewakili bantuan yang dihasilkan secara otomatis.

String

Jika Anda mendapatkan artikel bantuan konseptual, Get-Help mengembalikannya sebagai string.

MamlCommandHelpInfo

Jika Anda mendapatkan perintah yang memiliki file bantuan, Get-Help mengembalikan objek MamlCommandHelpInfo .

Catatan

PowerShell 3.0 tidak menyertakan file bantuan. Untuk mengunduh dan menginstal file bantuan yang Get-Help dibaca, gunakan Update-Help cmdlet . Anda dapat menggunakan Update-Help cmdlet untuk mengunduh dan menginstal file bantuan untuk perintah inti yang disertakan dengan PowerShell dan untuk modul apa pun yang Anda instal. Anda juga dapat menggunakannya untuk memperbarui file bantuan agar bantuan di komputer Anda tidak pernah kedaluarsa.

Anda juga dapat membaca artikel bantuan tentang perintah yang disertakan dengan PowerShell secara online mulai dari Memulai Windows PowerShell.

Get-Help menampilkan bantuan dalam lokal yang ditetapkan untuk sistem operasi Windows atau dalam bahasa fallback untuk lokal tersebut. Jika Anda tidak memiliki file bantuan untuk lokal utama atau fallback, Get-Help berperilaku seolah-olah tidak ada file bantuan di komputer. Untuk mendapatkan bantuan untuk lokal yang berbeda, gunakan Wilayah dan Bahasa di Panel Kontrol untuk mengubah pengaturan. Pada Windows 10 atau lebih tinggi, Pengaturan, Waktu & Bahasa.

Tampilan lengkap bantuan mencakup tabel informasi tentang parameter. Tabel menyertakan bidang berikut:

  • Diperlukan. Menunjukkan apakah parameter diperlukan (benar) atau opsional (false).

  • Posisi. Menunjukkan apakah parameter diberi nama atau posisi (numerik). Parameter posisi harus muncul di tempat tertentu dalam perintah.

  • Bernama menunjukkan bahwa nama parameter diperlukan, tetapi parameter dapat muncul di mana saja dalam perintah.

  • Numerik menunjukkan bahwa nama parameter bersifat opsional, tetapi ketika nama dihilangkan, parameter harus berada di tempat yang ditentukan oleh angka. Misalnya, 2 menunjukkan bahwa ketika nama parameter dihilangkan, parameter harus menjadi parameter kedua atau hanya tidak bernama dalam perintah. Saat nama parameter digunakan, parameter dapat muncul di mana saja dalam perintah.

  • Nilai default. Nilai parameter atau perilaku default yang digunakan PowerShell jika Anda tidak menyertakan parameter dalam perintah .

  • Menerima input alur. Menunjukkan apakah Anda dapat (benar) atau tidak dapat (salah) mengirim objek ke parameter melalui alur. Menurut Nama Properti berarti bahwa objek yang disalurkan harus memiliki properti yang memiliki nama yang sama dengan nama parameter.

  • Menerima karakter kartubebas. Menunjukkan apakah nilai parameter dapat menyertakan karakter kartubebas, seperti tanda bintang (*) atau tanda tanya (?).