4.13.35 Delete folder
Function
Deletes a folder on a specified path in a Windows or UNIX environment.
This plugin assumes the following server:
• Execution target server
This is the server on which this plugin is executed. Windows or UNIX described in the prerequisites must have already been set up.
Use situation
If you have created a temporary folder to store files, you can use this plugin to delete the folder when it is no longer needed.
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.
Version
04.00.00
Plug-in tags
Control OS,Windows,Linux
Plug-in name displayed in the task log
osDeleteFolder
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 |
|---|---|---|---|---|---|
|
common.folderPath |
Folder path |
Specify the full path name of the folder to be deleted. |
-- |
Input |
R |
|
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.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |