4.13.30 Delete file
Function
Deletes a file on a specified path on a specified target server.
When the execution target server is Windows, the built-in Administrator is required to execute this plug-in. If the built-in Administrator does not exist or is invalid on the execution target server, execute "Delete file(SYSTEM)" plug-in that executes with the system account.
Use situation
You use this plugin to delete a file forwarded by means of a file-forwarding plugin or a file output by another plugin.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[OS running in the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
None.
[OS running in the execution target server]
(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
[Usage conditions for the target server]
None.
Cautions
(1) This plugin can delete files only. It cannot delete a folder or directory. To delete a folder or directory, use the osDeleteFolder plugin.
Version
02.00.00
Plug-in tags
Control OS,Windows,Linux,AIX
Plug-in name displayed in the task log
osDeleteFile
Return code
0: Normal
12: Error (user error) Invalid property
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin 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 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.filePath |
File path |
Specify the full path of the file to be deleted. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |