目次
PowerShellでのOut-Fileコマンドの使い方とは？
今回は、PowerShellでのOut-Fileコマンドの使い方について説明します。Out-Fileコマンドを使えば、ファイル出力できます。
ここでは以下について紹介します。
・ファイル出力
・追記（Appendオプション）
・強制書き込み（Forceオプション）
・確認（Confirmオプション）
・出力オブジェクトの指定（InputObjectオプション）
・既存ファイルに上書きしない（NoClobberオプション）
・改行を出力しない（NoNewlineオプション）
PowerShellでのOut-Fileコマンドの使い方に興味のある方はぜひご覧ください。
ファイル出力
PowerShellでのOut-Fileコマンドの基本的な使い方を紹介します。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
|
PS C:\> # ファイル出力
PS C:\> Write-Output test | Out-File .\test\test.txt
PS C:\> # ファイル表示
PS C:\> Get-Content .\test\test.txt
test
PS C:\>
|
Write-Outputコマンドの内容がファイル出力されていることが分かります。
リダイレクトしても同じ結果になります。
|
1
2
3
4
5
|
PS C:\> # リダイレクト
PS C:\> Write-Output test > .\test\test.txt
PS C:\> Get-Content .\test\test.txt
test
PS C:\>
|
このように、PowerShellではOut-Fileコマンドでファイル出力できます。
追記（Appendオプション）
PowerShellでのOut-FileコマンドのAppendオプションを紹介します。ファイルに追記できます。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
|
PS C:\> # ファイル表示
PS C:\> Get-Content .\test\test.txt
test
PS C:\> # ファイル追記出力
PS C:\> Write-Output test2 | Out-File .\test\test.txt -Append
PS C:\> # ファイル表示
PS C:\> Get-Content .\test\test.txt
test
test2
PS C:\>
|
Appendオプションを付与することで、ファイルに追記されていることが分かります。
リダイレクトの追記でも同じ結果になります。
|
1
2
3
4
5
6
7
|
PS C:\> Get-Content .\test\test.txt
test
PS C:\> Write-Output test2 >> .\test\test.txt
PS C:\> Get-Content .\test\test.txt
test
test2
PS C:\>
|
このように、PowerShellのOut-Fileコマンドでは、Appendオプションでファイル追記できます。
強制書き込み（Forceオプション）
PowerShellでのOut-FileコマンドのForceオプションを紹介します。読み取り専用ファイルに強制出力できます。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
PS C:\> # 読み取り専用ファイルに変更
PS C:\> Set-ItemProperty .\test\test.txt -Name IsReadOnly -Value $true
PS C:\> # 属性の確認
PS C:\> Get-ChildItem .\test\test.txt
ディレクトリ: C:\test
Mode LastWriteTime Length Name
---- ------------- ------ ----
-ar--- 2020/11/06 21:23 16 test.txt
PS C:\> # ファイル出力（-Forceオプションなし）
PS C:\> Write-Output test | Out-File .\test\test.txt
Out-File : パス 'C:\test\test.txt' へのアクセスが拒否されました。
発生場所 行:1 文字:21
+ Write-Output test | Out-File .\test\test.txt
+ ~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : OpenError: (:) [Out-File], UnauthorizedAccessException
+ FullyQualifiedErrorId : FileOpenFailure,Microsoft.PowerShell.Commands.OutFileCommand
PS C:\> # ファイル出力（-Forceオプションあり）
PS C:\> Write-Output test | Out-File .\test\test.txt -Force
PS C:\> Get-Content .\test\test.txt
test
PS C:\>
PS C:\> # 読み取り専用ファイルを解除
PS C:\> Set-ItemProperty .\test\test.txt -Name IsReadOnly -Value $false
|
Forceオプションを付与しない場合は読み取り専用ファイルへの出力に失敗していることが分かります。
このように、PowerShellのOut-Fileコマンドでは、Forceオプションで読み取り専用ファイルに強制出力できます。
確認（Confirmオプション）
PowerShellでのOut-FileコマンドのConfirmオプションを紹介します。ファイル出力の確認を行います。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
PS C:\> Write-Output test | Out-File .\test\test.txt -Confirm
確認
この操作を実行しますか?
対象 “.\test\test.txt” に対して操作 “ファイルへ出力” を実行しています。
[Y] はい(Y) [A] すべて続行(A) [N] いいえ(N) [L] すべて無視(L) [S] 中断(S) [?] ヘルプ (既定値は “Y”): Y
PS C:\> Get-Content .\test\test.txt
test
PS C:\> Write-Output test2 | Out-File .\test\test.txt -Confirm
確認
この操作を実行しますか?
対象 “.\test\test.txt” に対して操作 “ファイルへ出力” を実行しています。
[Y] はい(Y) [A] すべて続行(A) [N] いいえ(N) [L] すべて無視(L) [S] 中断(S) [?] ヘルプ (既定値は “Y”): N
PS C:\> Get-Content .\test\test.txt
test
PS C:\>
|
このように、PowerShellのOut-Fileコマンドでは、Confirmオプションでファイル出力の確認を行います。
出力オブジェクトの指定（InputObjectオプション）
PowerShellでのOut-FileコマンドのInputObjectオプションを紹介します。ファイルへ出力するオブジェクトを指定できます。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
|
PS C:\> # 現在時刻の取得
PS C:\> $val = Get-Date
PS C:\> # ファイル出力
PS C:\> Out-File -InputObject $val -FilePath .\test\test.txt
PS C:\> Get-Content .\test\test.txt
2020年11月6日 21:37:32
PS C:\>
|
このように、PowerShellのOut-Fileコマンドでは、InputObjectオプションで、ファイルへ出力するオブジェクトを指定できます。
既存ファイルに上書きしない（NoClobberオプション）
PowerShellでのOut-FileコマンドのNoClobberオプションを紹介します。ファイルが存在する場合は出力しません。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
PS C:\> # 存在確認
PS C:\> Test-Path .\test\test.txt
True
PS C:\> # ファイル書き込み
PS C:\> Write-Output test | Out-File .\test\test.txt -NoClobber
Out-File : ファイル 'C:\test\test.txt' は既に存在します。
発生場所 行:1 文字:21
+ Write-Output test | Out-File .\test\test.txt -NoClobber
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ResourceExists: (C:\test\test.txt:String) [Out-File], IOException
+ FullyQualifiedErrorId : NoClobber,Microsoft.PowerShell.Commands.OutFileCommand
PS C:\> # 存在確認
PS C:\> Test-Path .\test\test2.txt
False
PS C:\> # ファイル書き込み
PS C:\> Write-Output test | Out-File .\test\test2.txt -NoClobber
PS C:\> Get-Content .\test\test2.txt
test
PS C:\>
|
このように、PowerShellのOut-Fileコマンドでは、NoClobberオプションで、ファイルが存在する場合は出力しません。
改行を出力しない（NoNewlineオプション）
PowerShellでのOut-FileコマンドのNoNewlineオプションを紹介します。改行を出力しません。
実際のコマンドを見てみましょう。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
PS C:\> # 改行を出力しない
PS C:\> Write-Output test | Out-File .\test\test.txt -NoNewline
PS C:\> Get-Content .\test\test.txt
test
PS C:\> # 追記出力
PS C:\> Write-Output test2 | Out-File .\test\test.txt -Append
PS C:\> Get-Content .\test\test.txt
testtest2
PS C:\> # 追記出力
PS C:\> Write-Output test3 | Out-File .\test\test.txt -Append
PS C:\> Get-Content .\test\test.txt
testtest2
test3
PS C:\>
|
このように、PowerShellのOut-Fileコマンドでは、NoNewlineオプションで、改行を出力しません。
まとめ
いかがでしたでしょうか。PowerShellでのOut-Fileコマンドの使い方について説明しました。Out-Fileコマンドを使えば、ファイル出力できます。
基本的な使い方から、各種オプションの使い方について紹介しました。オプションは組み合わせて使用することもできます。
ぜひご自身でPowerShellコマンドを書いて、理解を深めてください。
インフラエンジニア専門の転職サイト「FEnetインフラ」
FEnetインフラはサービス開始から10年以上『エンジニアの生涯価値の向上』をミッションに掲げ、多くのエンジニアの就業を支援してきました。
転職をお考えの方は気軽にご登録・ご相談ください。
