Limit-EventLog
イベント ログのサイズおよびエントリの期間を制限するイベント ログ プロパティを設定します。
構文
Limit-EventLog [-LogName] <string[]> [-ComputerName <string[]>] [-MaximumSize <Int64>] [-OverFlowAction {<OverwriteAsNeeded> | <OverwriteOlder> | <DoNotOverwrite>}] [-RetentionDays <int>] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Limit-EventLog コマンドレットは、従来のイベント ログの最大サイズ、各イベントの保持期間、およびログが最大サイズに達したときのアクションを設定します。このコマンドレットを使用して、ローカル コンピューターまたはリモート コンピューター上のイベント ログを制限できます。
EventLog という名詞を含むコマンドレット (EventLog コマンドレット) は、従来のイベント ログでのみ有効です。Windows Vista 以降のバージョンで Windows イベント ログ技術を使用しているログからイベントを取得するには、Get-WinEvent を使用します。
パラメーター
-ComputerName <string[]>
リモート コンピューターを指定します。既定値はローカル コンピューターです。
リモート コンピューターの NetBIOS 名、インターネット プロトコル (IP) アドレス、または完全修飾ドメイン名を入力します。ローカル コンピューターを指定するには、コンピューター名、ドット (.)、または「localhost」を入力します。
このパラメーターは、Windows PowerShell リモート処理に依存しません。コンピューターがリモート コマンドを実行するように構成されていない場合でも、Limit-EventLog の ComputerName パラメーターを使用できます。
必須 |
false |
位置 |
named |
既定値 |
Local computer |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-LogName <string[]>
イベント ログを指定します。1 つ以上のイベント ログのログ名 (LogDisplayName ではなく Log プロパティの値) をコンマ区切りで入力します。ワイルドカード文字は使用できません。このパラメーターは必須です。
必須 |
true |
位置 |
1 |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MaximumSize <Int64>
イベント ログの最大サイズをバイト単位で指定します。64 キロバイト (KB) ～ 4 ギガバイト (GB) の値を入力します。値は 64 KB (65536) で割り切れる必要があります。
このパラメーターは、従来のイベント ログを表す System.Diagnostics.EventLog オブジェクトの MaximumKilobytes プロパティの値を指定します。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-OverFlowAction <OverflowAction>
イベント ログが最大サイズに達したときのアクションを指定します。
有効な値は次のとおりです。
-- DoNotOverwrite: 既存のエントリは保持され、新しいエントリは破棄されます。
-- OverwriteAsNeeded: 新しいエントリが最も古いエントリを上書きします。
-- OverwriteOlder: 新しいイベントが、MinimumRetentionDays プロパティによって指定された値よりも古いイベントを上書きします。MinimumRetentionDays プロパティによって指定された値よりも古いイベントがない場合、新しいイベントが破棄されます。
このパラメーターは、従来のイベント ログを表す System.Diagnostics.EventLog オブジェクトの OverflowAction プロパティの値を指定します。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RetentionDays <int>
イベントをイベント ログに残す必要がある最小日数を指定します。
このパラメーターは、従来のイベント ログを表す System.Diagnostics.EventLog オブジェクトの MinimumRetentionDays プロパティの値を指定します。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
なし なし |
出力 |
なし なし |
注
Windows Vista 以降のバージョンの Windows で、Limit-EventLog を使用するには、Windows PowerShell を開く際に [管理者として実行] を指定する必要があります。
Limit-EventLog は、従来のイベント ログを表す System.Diagnostics.EventLog オブジェクトのプロパティを変更します。イベント ログ プロパティの現在の設定を表示するには、「get-eventlog –list」と入力します。
例 1
C:\PS>limit-eventLog -logname "Windows PowerShell" -MaximumSize 20KB
説明
-----------
このコマンドは、ローカル コンピューター上の Windows PowerShell イベント ログの最大サイズを 20480 キロバイト (KB) (20 KB) に増やします。
例 2
C:\PS>limit-eventlog -logname Security -comp Server01, Server02 -retentionDays 7
説明
-----------
このコマンドは、Server01 コンピューターと Server02 コンピューター上のセキュリティ ログのイベントを少なくとも 7 日間確実に保持します。
例 3
C:\PS>$logs = get-eventlog -list | foreach {$_.log}
C:\PS> limit-eventlog -overflowaction OverwriteOlder -logname $logs
C:\PS> get-eventlog -list
Max(K) Retain OverflowAction Entries Log
------ ------ -------------- ------- ---
15,168 0 OverwriteOlder 3,412 Application
512 0 OverwriteOlder 0 DFS Replication
512 0 OverwriteOlder 17 DxStudio
10,240 7 OverwriteOlder 0 HardwareEvents
512 0 OverwriteOlder 0 Internet Explorer
512 0 OverwriteOlder 0 Key Management Service
16,384 0 OverwriteOlder 4 ODiag
16,384 0 OverwriteOlder 389 OSession
Security
15,168 0 OverwriteOlder 19,360 System
15,360 0 OverwriteOlder 15,828 Windows PowerShell
説明
-----------
これらのコマンドは、ローカル コンピューター上のすべてのイベント ログのオーバーフロー アクションを "OverwriteOlder" に変更します。
最初のコマンドは、ローカル コンピューター上のすべてのログのログ名を取得します。2 番目のコマンドはオーバーフロー アクションを設定します。3 番目のコマンドは結果を表示します。
関連項目
概念
Clear-EventLog
Get-EventLog
Limit-EventLog
New-EventLog
Remove-EventLog
Show-EventLog
Write-EventLog
Get-WinEvent