FTP
Connect to an FTP server and work on its files: change and create directories, list, rename, upload, download and remove files, with the transfer type, active or passive mode and compression. Typical use: exchange files with a partner on a schedule.
ftp set timeoutftp connectftp set typeftp active compressionftp activeftp passiveftp cdftp pwdftp mkdirftp lsftp renameftp putftp getftp rm fileftp rm dirftp disconnectftp disconnect all

ftp set timeout <connectTimeout>


Description

    To set the FTP timeout.

Parameters

    connectTimeout:   The connection timeout - number - required
admin
ftp set timeout 10000;
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp connect <sessionId> <jsonObject>


Description

    Connect to an FTP server (use "anonymous/ftp4j" for an anonymous connection).

Parameters

    sessionId:   The session id - string - required
    jsonObject:   The JSON object information - string - required
admin
ftp connect "session1" {cm get "demo_cm_ftp";};
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp disconnect  ·  ftp get  ·  ftp ls  ·  ftp passive

ftp set type <sessionId> <type>


Description

    Set the transfer type (TEXTUAL | BINARY | AUTO).

Parameters

    sessionId:   The session id - string - required
    type:   The type (TEXTUAL | BINARY | AUTO) - string - required
admin
ftp set type "session1" "BINARY";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp active compression <sessionId> <bool>


Description

    Enable or disable compression.

Parameters

    sessionId:   The session id - string - required
    bool:   A boolean (true | false) - number - required
admin
ftp active compression "session1" true;
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls  ·  ftp passive

ftp active <sessionId>


Description

    Set the active mode.

Parameters

    sessionId:   The session id - string - required
admin
ftp active "session1";
mentdb
1
Used in use cases (1 recipe)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp passive <sessionId>


Description

    Set the passive mode.

Parameters

    sessionId:   The session id - string - required
admin
ftp passive "session1";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp cd <sessionId> <directory>


Description

    Go to another remote directory.

Parameters

    sessionId:   The session id - string - required
    directory:   The remote directory - string - required
admin
ftp cd "session1" "/remote/dir";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls  ·  ftp passive

ftp pwd <sessionId>


Description

    Get the current remote directory.

Parameters

    sessionId:   The session id - string - required
admin
ftp pwd "session1";
mentdb
/remote/dir
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp mkdir <sessionId> <directory>


Description

    Create a remote directory.

Parameters

    sessionId:   The session id - string - required
    directory:   The remote directory - string - required
admin
ftp mkdir "session1" "/remote/dir";
mentdb
1
Used in use cases (1 recipe)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
Often used with

    cm get  ·  execute  ·  ftp active  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get

ftp ls <sessionId> <fileFilterPath>


Description

    Get all the files of the current remote directory.

Parameters

    sessionId:   The session id - string - required
    fileFilterPath:   The file filter path - string - required
admin
ftp ls "session1" "*.txt"
mentdb
[ { \"name\": \"filename.txt\", \"lastModified\": \"2023-08-06 06:32:39\", \"isDir\": \"0\" } ]
admin
ftp ls "session1" ""
mentdb
[ { \"name\": \"filename.txt\", \"lastModified\": \"2023-08-06 06:32:39\", \"isDir\": \"0\" } ]
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp passive

ftp rename <sessionId> <oldFile> <newFile>


Description

    Rename a remote file or directory.

Parameters

    sessionId:   The session id - string - required
    oldFile:   The old file path - string - required
    newFile:   The new file path - string - required
admin
ftp rename "session1" "file1" "file2";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get  ·  ftp ls

ftp put <sessionId> <localFile> <mode>


Description

    Upload a file.

Parameters

    sessionId:   The session id - string - required
    localFile:   The local file path - string - required
    mode:   The mode (APPEND | RESUME) - string - required
admin
ftp put "session1" "file1" "RESUME";
mentdb
1
Used in use cases (1 recipe)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
Often used with

    cm get  ·  execute  ·  ftp active  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get

ftp get <sessionId> <remoteFile> <localFile>


Description

    Download a file.

Parameters

    sessionId:   The session id - string - required
    remoteFile:   The remote file path - string - required
    localFile:   The local file path - string - required
admin
ftp get "session1" "remoteFile1" "localFile2";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp ls  ·  ftp passive

ftp rm file <sessionId> <remoteFile>


Description

    Remove a remote file.

Parameters

    sessionId:   The session id - string - required
    remoteFile:   The remote file path - string - required
admin
ftp rm file "session1" "remoteFile1";
mentdb
1
Used in use cases (1 recipe)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
Often used with

    cm get  ·  execute  ·  ftp active  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get

ftp rm dir <sessionId> <remoteDir>


Description

    Remove a remote directory.

Parameters

    sessionId:   The session id - string - required
    remoteDir:   The remote directory path - string - required
admin
ftp rm dir "session1" "remoteDir1";
mentdb
1
Used in use cases (1 recipe)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
Often used with

    cm get  ·  execute  ·  ftp active  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp disconnect  ·  ftp get

ftp disconnect <sessionId>


Description

    Disconnect a session.

Parameters

    sessionId:   The session id - string - required
admin
ftp disconnect "session1";
mentdb
1
Used in use cases (2 recipes)

    File transfer & remote systems engineer › Send orders and fetch delivery reports over FTP
    File transfer & remote systems engineer › Incremental FTP mirror of a carrier's tracking files
Often used with

    cm get  ·  execute  ·  ftp active compression  ·  ftp cd  ·  ftp connect  ·  ftp get  ·  ftp ls  ·  ftp passive

ftp disconnect all


Description

    Disconnect all sessions.

admin
ftp disconnect all;
mentdb
0