4.13.33 Delete file(SYSTEM)
Function
Deletes a file on a specified path on a specified target server.
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 products on the execution target server]/[OS running in the execution target server], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target server]
None.
[OS running in the execution target server]
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
[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
04.00.00
Plug-in tags
Control OS,Windows,Linux
Plug-in name displayed in the task log
osDeleteFile_System
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 |