4.13.29 Obtaining a file list
Function
This plug-in outputs, to a text file in a specified location, information about a specified file or about the files and subfolders in a specified folder.
The path of the target folder or file is specified by the common.targetPath property, and the path of the output destination text file is specified by the common.outputFilePath property. The values of these properties cannot include wildcard characters.
If the OS of the execution-target server is Windows, the information is output in the same format as with the "dir /Q" command. If the OS of the execution-target server is UNIX, the information is output in the same format as with the "ls -la" command. Information about hidden files and system files is also output.
To output information about all files, including subfolders, set the "true" for the common.showAllFileList property. If you do not specify "true" for this property, information about files in the subfolders of the specified path will not be output.
If the specified file path includes a folder that does not exist, the folder will be created, and then the text file will be output in that folder. If files that has the same name as a file to be specified already exist in the folder, the existing files are overwritten.
Use situation
This plug-in can be used to check whether the files to be created by other plug-ins were successfully created.
Prerequisites
For the most recent information about the prerequisite products in the system, the prerequisite products on the execution-target server, and the supported OSs on the execution-target server, see the Release Notes.
[Prerequisite products in the system]
JP1/Automatic Operation 11-00 or later
[Prerequisite products on the execution-target server]
None.
[Supported OSs on the execution-target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter or 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) or 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
[Conditions for using the execution-target server]
None.
Cautions
(1) For the properties of this plug-in, do not specify any strings that include double quotation marks (") or single quotation marks (').
(2) If you specify to output the information for all files, including subfolders, processing might take a long time.
(3) If the OS of the execution-target server is Windows and the target folder contains a symbolic link to a folder, this plug-in also obtains information about the files and subfolders in the link-target folder. If the link-target folder is an upper-level folder, the plug-in terminates normally, but the obtained information is invalid.
Version
02.02.00
Plug-in tags
Gather OS information,Windows,Linux,AIX
Plug-in name displayed in the task log
osShowFileList
Return code
0: Normal
12: Error (Mistake by user) Invalid property
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the plug-in) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.targetPath |
Target path |
Enter the full path of the target file or folder. |
-- |
Input |
R |
|
common.showAllFileList |
Obtaining information under subfolders |
Specify "true" to obtain all file information including subfolders. If "true" is not specified, the file information under subfolders will not be collected. |
false |
Input |
O |
|
common.outputFilePath |
Output file path |
Specifies the file to be output as a full path. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |