4.13.29　ファイル一覧の取得

機能

この部品は，指定したパスのファイルまたはフォルダ配下のファイルおよびフォルダの情報を，指定したパスにテキストファイルとして出力します。

対象パス(common.targetPathプロパティ)や出力ファイルのパス(common.outputFilePathプロパティ)には，ワイルドカードを使用したファイルまたはフォルダのパスは指定できません。

出力結果は，実行対象サーバがWindowsの場合は"dir /Q"コマンド，UNIXの場合は"ls -la"コマンドの実行結果の形式で出力されます。また，隠しファイルやシステムファイルの情報も出力します。

サブフォルダ配下の情報取得(common.showAllFileListプロパティ)に「true」を指定した場合，サブフォルダも含めたすべてのファイル情報を出力します。「true以外」を指定した場合は，指定したパスのサブフォルダ配下のファイルの情報を出力しません。

指定した出力ファイルのパス上にフォルダが存在しない場合は，フォルダを作成し，その配下に結果を出力します。また，同名のファイルが既に存在する場合にはファイルを上書きします。

利用場面

他の部品によって作成したファイルの作成確認などに使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)サブフォルダも含めたすべてのファイル情報を出力する場合，完了まで長時間を要することがあります。

(3)実行対象サーバがWindowsの場合，対象フォルダの配下にフォルダへのシンボリックリンクがあると，シンボリックリンクをたどってリンク先のファイルおよびフォルダの情報を取得します。シンボリックリンクが上位のフォルダにリンクされている場合は，部品は正常終了しますが，取得結果が不正になります。

バージョン

02.02.00

部品のタグ

Gather OS information,Windows,Linux,AIX

タスクログに表示される部品の名称

osShowFileList

戻り値

戻り値	説明
0	正常
12	異常(ユーザーミス) プロパティ不正
27	異常(エラー内容はタスクログで確認)
41	異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー	プロパティ名	説明	デフォルト値	入出力種別	必須区分
plugin.destinationHost	実行対象サーバのホスト名	この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。	−	入力	○
common.targetPath	対象パス	対象のファイルまたはフォルダをフルパスで指定します。	−	入力	○
common.showAllFileList	サブフォルダ配下の情報取得	サブフォルダも含めたすべてのファイル情報を取得したい場合は「true」を指定します。「true以外」の場合は，サブフォルダ配下のファイル情報を取得しません。	false	入力	△
common.outputFilePath	出力ファイルのパス	出力するファイルをフルパスで指定します。	−	入力	○
common.returnValue	部品の戻り値	この部品の戻り値が格納されます。	−	出力	−