Close
Thank you for your feedback.

Remove File or Directory activity

Remove File or Directory activity

The Remove File or Directory activity removes a file or a directory on an SFTP server, including subdirectories, when configured.

Input variables

Table 1. Remove File or Directory input variables
VariableDescription
sourceHostName or IP address of the server containing the files you want to remove.
sourcePortPort number to use to communicate with the target server. The default port number is 22.
sourceFilePathFull path to the file or directory to remove. To remove multiple files or directories using a single activity, enter a semicolon-separated list of paths in this field.
isDirectoryTrue/false variable that determines if the specified file path is a directory. The default value for this variable is false.
includeSubfoldersTrue/false variable that determines if the given directory and all of its subfolders should be removed. The default value for this variable is false. If the value for this field is false, then the activity can only remove an empty directory. This field appears when the isDirectory checkbox is selected.
sourceCredentialTagSpecific credential tag this activity must use to run SSH commands on the host.

Output variables

Table 2. Remove File or Directory output variables
VariableDescription
errorMessageThe executionResult.errorMessages from the Activity designer parsing sources. If this variable is not null, the operation has failed.
resultEither success or failure.
deletionResultsThe deletionResults array contains these attributes:
  • fullPath: Full path to the file or directory targeted.
  • status: Either succeeded or failed.
  • reason: Text message describing the cause of a failure.

Conditions

Table 3. Remove File or Directory conditions
ConditionDescription
SuccessThe activity succeeded in removing the file or directory specified.
FailureThe activity failed to remove the file or directory specified.

Products > IT Operations Management > Orchestration; Versions > Istanbul