XenoGuard Documentation

Rename

Actions » Windows » Network » FTP » File » Rename 

The action Rename changes the name of a file or directory via File Transfer Protocol (FTP).


[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. Open the Network node.
  3. In the FTP node, select the File node.
  4. In the File node, select the Rename action.

Parameters:

The action has the following input parameters:


name Description
Server Address
The host name or IP address of the FTP server.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
User
The name of the user in the FTP server.

Allowed Context Scopes
[Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Password
The password of the user in the FTP server.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Protocol Type
The type of protocol to use for accessing the file.

Accepted Protocols: File Transfer Protocol (FTP) and Secure File Transfer Protocol (SFTP)

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
File Path Name
The path name of the file to be renamed via FTP.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
New Name
The new name of the file.

Allowed Context Scopes
 [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Results:

The action returns the following results:


name
description
File Path Name
The path name of the renamed file.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Example 1 (Update filename of a remote file):

This example creates two local variables, myTextFile.txt and myNewTextFile.txt, with both having Text as data type. The values of variables were used as File Path Name and New Name. The result is then output via Message Box.


See other FTP File operations:

Download
Upload
Move
Delete
Get Information
Permission