#navi(../)
* PowerShellのコマンドレットのヘルプの引き方・Get-Help [#u1b68ac6]
Get-Help コマンドレットでコマンドレットの使用方法のヘルプを見ることができます。~
ただ、Get-Helpにオプションを付けないと指定したコマンドレットの概略の説明のみが表示されます。~
より詳細なヘルプ(説明)を表示する方法を以下に記します。
#contents
#htmlinsertpcsp(win-top.html,win-sp.html)
* Get-Helpコマンドの各種パラメータによる動作の違い [#da5d8cf8]
以下にGet-EventLogコマンドレットのヘルプを各パラメータの違いで表示される内容が異なることを記します。
** パラメータなし [#ad338154]
PS D:\> Get-Help Get-EventLog
名前
Get-EventLog
構文
Get-EventLog [-LogName] <string> [[-InstanceId] <long[]>] [-ComputerName <string[]>] [-Newest <int>] [-After
<datetime>] [-Before <datetime>] [-UserName <string[]>] [-Index <int[]>] [-EntryType <string[]> {Error | In
formation | FailureAudit | SuccessAudit | Warning}] [-Source <string[]>] [-Message <string>] [-AsBaseObject]
[<CommonParameters>]
Get-EventLog [-ComputerName <string[]>] [-List] [-AsString] [<CommonParameters>]
エイリアス
なし
注釈
Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプ ファイルは見つかりませんでした。ヘルプの一部だけが表示されています。
-- このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Help を使用してください。
-- このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Get-EventLog -Online」と入力するか、
http://go.microsoft.com/fwlink/?LinkID=113314 を参照してください。
** -Detailedパラメータ [#fe3db532]
パラメータなしより詳細な内容のヘルプが表示されます。
PS D:\> Get-Help Get-EventLog -Detailed
名前
Get-EventLog
構文
Get-EventLog [-LogName] <string> [[-InstanceId] <long[]>] [-ComputerName <string[]>] [-Newest <int>] [-After
<datetime>] [-Before <datetime>] [-UserName <string[]>] [-Index <int[]>] [-EntryType <string[]> {Error | In
formation | FailureAudit | SuccessAudit | Warning}] [-Source <string[]>] [-Message <string>] [-AsBaseObject]
[<CommonParameters>]
Get-EventLog [-ComputerName <string[]>] [-List] [-AsString] [<CommonParameters>]
パラメーター
-After <datetime>
-AsBaseObject
-AsString
-Before <datetime>
-ComputerName <string[]>
-EntryType <string[]>
-Index <int[]>
-InstanceId <long[]>
-List
-LogName <string>
-Message <string>
-Newest <int>
-Source <string[]>
-UserName <string[]>
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
OutBuffer, PipelineVariable、および OutVariable。詳細については、
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
を参照してください。
エイリアス
なし
注釈
Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプ ファイルは見つかりませんでした。ヘルプの一部だけが表示されています。
-- このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Help を使用してください。
-- このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Get-EventLog -Online」と入力するか、
http://go.microsoft.com/fwlink/?LinkID=113314 を参照してください。
** -Fullパラメータ [#e7eae5ca]
パラメータ-Detailedより更に詳細なヘルプが表示されます。
PS D:\> Get-Help Get-EventLog -Full
名前
Get-EventLog
構文
Get-EventLog [-LogName] <string> [[-InstanceId] <long[]>] [-ComputerName <string[]>] [-Newest <int>] [-After
<datetime>] [-Before <datetime>] [-UserName <string[]>] [-Index <int[]>] [-EntryType <string[]> {Error | In
formation | FailureAudit | SuccessAudit | Warning}] [-Source <string[]>] [-Message <string>] [-AsBaseObject]
[<CommonParameters>]
Get-EventLog [-ComputerName <string[]>] [-List] [-AsString] [<CommonParameters>]
パラメーター
-After <datetime>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-AsBaseObject
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-AsString
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 List
エイリアス なし
動的 false
-Before <datetime>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-ComputerName <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス Cn
動的 false
-EntryType <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス ET
動的 false
-Index <int[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-InstanceId <long[]>
必須 false
位置 1
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-List
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 List
エイリアス なし
動的 false
-LogName <string>
必須 true
位置 0
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス LN
動的 false
-Message <string>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス MSG
動的 false
-Newest <int>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
-Source <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス ABO
動的 false
-UserName <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 LogName
エイリアス なし
動的 false
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
OutBuffer, PipelineVariable、および OutVariable。詳細については、
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
を参照してください。
入力
なし
出力
System.Diagnostics.EventLog
System.Diagnostics.EventLogEntry
System.String
エイリアス
なし
注釈
Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプ ファイルは見つかりませんでした。ヘルプの一部だけが表示されています。
-- このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Help を使用してください。
-- このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Get-EventLog -Online」と入力するか、
http://go.microsoft.com/fwlink/?LinkID=113314 を参照してください。
** -Onlineパラメータ [#z1a37412]
Get-Helpに-Onlineパラメータを指定するとブラウザが起動されマイクロソフトのオンラインヘルプが表示されます。
#ref(01.gif)
以上、Get-Helpによるヘルプ表示のパラメータについてでした。
#htmlinsertpcsp(win-btm.html,win-sp.html)