SSH FTP Command Reference

CD

Changes the current working directory on the host.

CD "directory"

"directory": The new working directory.

CHECK

See CHECK Command for information about this command.

CHGRP

Changes the group ID of the file or directory on the host.

QUOTE CHGRP group "path"

group: The numeric group id for the new group.
"path": The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHMOD

Changes the access permissions or modes of the file or directory on the host.

QUOTE CHMOD permissions "path"

permissions

The absolute mode of the file/directory. Absolute modes are octal numbers specifying the complete list of attributes for the files; you specify attributes by OR'ing together these bits.

0400 - Individual read
0200 - Individual write
0100 - Individual execute (or list directory)
0040 - Group read
0020 - Group write
0010 - Group execute
0004 - Other read
0002 - Other write
0001 - Other execute

"path"

The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHOWN

Changes the user ID of the file or directory on the host.

QUOTE CHOWN owner "path"

owner: The numeric user id for the new owner.
"path": The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CLEAR

Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.

CLEAR property

property: Action property name with no embedded spaces.

Comment

# text...

Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.

DIR

Get a directory listing of available files from the host.

DIR "source"

"source": Remote source directory path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

GET

Receive one or more files from the host

GET -REC –DEL –UNI|–APE "source" "destination"

-REC

Recursively retrieve nested subdirectories.

Nested server directory structure retained locally.
If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.

-DEL

If the command is successful, delete the local file.

-UNI

Ensure the copied filename is unique.

-APE

Append copied file to existing destination file.

"source"

Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

"destination"

Local destination path.

Path can be to a filename or to a directory.
If you specify a relative path, the command uses the default inbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LCOPY

Copy one or more files locally.

LCOPY –DEL -REC {–UNI|–APE} {-ZIP|-UNZ} "source" "destination"

-DEL

If the command is successful, delete the local file.

-REC

Recursively search all subdirectories.

You cannot use this option with the -UNZ option.

-UNI

Ensure the copied filename is unique.

-APE

Append copied file to existing destination file.

-ZIP

Zip all the files into one or more ZIP archive files, depending on the destination specified.

Specify ZIP comment and compression level through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
The ZIP archive files created through the LCOPY command conform to the standard ZIP file format. Visit http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html. The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Cryptographic Services.

-UNZ

Unzip the source file(s).

All source files must be ZIP archive files.
You cannot use this option with the -REC option.
Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
The ZIP archive files created through the LCOPY command conform to the standard ZIP file format (reference http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html). The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files for more information on this capability.

"source"

Source path

Path can be to a filename or to a directory
You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
If you specify a relative path, the command uses the default inbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

"destination"

Destination path.

Path can be to a filename or to a directory.
If you specify a relative path, the command uses the default inbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
You can use a single * within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When * is used in conjunction with both the -REC and -ZIP options, and Zip Subdirectories Into Individual Zip Files is enabled, then * is substituted with each first-level subdirectory name. When * is not used for bundling zipped subdirectories, then it is used as a shortcut for the %sourcefilename% or %srcfilename% macro. Only one * is allowed in the destination path. See Setting advanced host properties.
When copying a file without the -APE option, or when copying a file with the -APE option where the destination file does not already exist, a temporary file name is used while the copy operation is taking place. This temporary file is placed in the destination directory. Its name begins with the product name and ends with .tmp. Once the copy completes successfully, the temporary file is renamed to the destination name.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LDELETE

Delete one or more files locally.

LDELETE "source"

"source"

Source path.

Path can be a filename or a directory.
You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
If you specify a relative path, the command uses the default inbox.
Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LREPLACE

Replace bytes in one or more files locally.

LREPLACE "source" Replace="input bytes" With="output bytes"

"source"

Source path.

Path can be to a filename or to a directory.
You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
If you specify a relative path, the command uses the default inbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

"input bytes"

List of bytes to be replaced.

Comma separated list of byte values (0-255).
All bytes in comma-separated list must be found in the file in listed sequence in order to be replaced.

"output bytes"

List of bytes to be substituted for original input bytes.

Comma separated list of byte values (0-255).
If With parameter is omitted, then the input bytes are deleted from the file.

PUT

Send one or more files to the host.

 PUT –DEL -APE "source" "destination" name=value,...

–DEL

If the PUT command is successful, delete local file(s).

-APE

Append copied file to existing destination file.

"source"

Local source path

Path can be to a filename or to a directory
You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
If you specify a relative path, the command uses the default outbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

"destination"

Remote destination path.

You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MKDIR

Creates a new directory on the host.

QUOTE MKDIR "directory"

"directory": The name of the new directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MKDIRS

Creates a new directory on the host.

QUOTE MKDIRS "path"

"path": The path of directories to create. Subdirectories are created using the / delimiter. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PWD

Returns the name of the current working directory on the host.

QUOTE PWD

RENAME

Renames a file or directory on the host.

QUOTE RENAME "source" "destination"

"source": The source file/directory to rename. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination": - The destination file/directory name. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

RM

Removes a file on the host.

QUOTE RM "path"

"path": The path of the file to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

RMDIR

Removes a directory on the host.

QUOTE RMDIR "path"

"path": The path of the directory to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

SCRIPT

See SCRIPT command for information about this command.

SET

Change an action property value. The new value only affects the commands that follow the SET.

SET property=value

property = value

Action property and new value

The property name must have no embedded spaces.
The value specified remains in effect until it is set again or until the end of action.
To reset property back to default value (host-level or system-level), specify
```
SET property
```
or
```
SET property=
```
To clear a string property, use the CLEAR command

STAT

Returns the attributes of the file or directory on the host.

QUOTE STAT "path"

"path": The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

SYMLINK

Creates a symbolic link on the host to a file or directory.

QUOTE SYMLINK "path" "link"

"path": The target path of the file/directory for the symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"link": The name for the new symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

SYSTEM

Execute a local system command.

SYSTEM "path"

"path"

Local command path with arguments.

If you specify a relative path or no path, the command uses the home directory.
See Using operating system commands in actions for additional information

TOUCH

Sets the remote file access and modified times to the current time.

QUOTE TOUCH "path"

"path": The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

WAIT

Pause execution.

WAIT seconds

Seconds: Number of seconds to pause.