Controller: Ftp

API Controller /nodeworx/ftp
Required Permissions ["FTP"]
Action Description
autoRestart Set the FTP server auto-restart status.
isRunning Checks if the service is running or not.
isRunningOnNode Checks if the service is running on a specific node (Clustering only).
killSessions Kill ftp sessions.
listFtpSessions List Ftp Sessions.
listGeneralName Lists the "normal" name - ie "web server" instead of "httpd".
listPortNumbers Lists a string of the port numbers that this service uses, comma-seperated.
listPortNumbersArray Lists array of port numbers and ranges that this service uses.
listRequiredPermissions Lists an array of permissions required to control the service.
listServiceInfo Lists the service name, ports, page, and status.
listServiceName Lists the service name - ie "httpd" instead of "web server".
listServicePage Lists the page that controls the service.
restart Restarts the service.
restartOnNode Restarts the service on a specific node (Clustering only).
rrdGraph Set the FTP connections RRD graph display in the web interface.
serverOptions Update FTP server settings.
sftpOptions Update SFTP server settings.
start Starts the service.
startOnBoot Set the FTP server start-on-boot status.
startOnNode Starts the service on a specific node (Clustering only).
stop Stops the service.
stopOnNode Stops the service on a specific node (Clustering only).

Action: autoRestart

Set the FTP server auto-restart status.

Input Parameters

Name Type Notes Required?
ftp_autorestart integer
Help Entry
With this option on you can have FTP restarted automatically if FTP goes down unexpectedly
Example Values
1, 0
Example Default Value
0
 No*
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No
* indicates that it's actually required, but probably already has a valid default value

Action: isRunning (Added in version 4.2.0-260)

Checks if the service is running or not.

Example Output

array (
  'status' => 0,
  'payload' => true,
)

Action: isRunningOnNode (Added in version 4.3.0-290)

Checks if the service is running on a specific node (Clustering only).

Input Parameters

Name Type Notes Required?
node_id string No*
* indicates that it's actually required, but probably already has a valid default value

Action: killSessions (Added in version 4.8.0-393)

Kill ftp sessions.

Input Parameters

Name Type Notes Required?
sessions struct (integer) No*
* indicates that it's actually required, but probably already has a valid default value

Action: listFtpSessions (Added in version 4.8.0-393)

List Ftp Sessions.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
  ),
)

Action: listGeneralName (Added in version 4.2.0-260)

Lists the "normal" name - ie "web server" instead of "httpd".

Example Output

array (
  'status' => 0,
  'payload' => '##LG_FTPSERVER##',
)

Action: listPortNumbers (Added in version 4.2.0-260)

Lists a string of the port numbers that this service uses, comma-seperated.

Example Output

array (
  'status' => 0,
  'payload' => '21',
)

Action: listPortNumbersArray (Added in version 4.2.0-260)

Lists array of port numbers and ranges that this service uses.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 21,
  ),
)

Action: listRequiredPermissions (Added in version 4.2.0-260)

Lists an array of permissions required to control the service.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 'FTP',
  ),
)

Action: listServiceInfo (Added in version 4.2.0-260)

Lists the service name, ports, page, and status.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    'id' => 'proftpd',
    'name' => '##LG_FTPSERVER##',
    'ports' => '21',
    'page' => '/nodeworx/ftp',
    'ctrl' => '/nodeworx/ftp',
    'is_running' => 1,
  ),
)

Action: listServiceName (Added in version 4.2.0-260)

Lists the service name - ie "httpd" instead of "web server".

Example Output

array (
  'status' => 0,
  'payload' => 'proftpd',
)

Action: listServicePage (Added in version 4.2.0-260)

Lists the page that controls the service.

Example Output

array (
  'status' => 0,
  'payload' => '/nodeworx/ftp',
)

Action: restart (Added in version 4.2.0-260)

Restarts the service.

Input Parameters

Name Type Notes Required?
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No

Action: restartOnNode (Added in version 4.3.0-290)

Restarts the service on a specific node (Clustering only).

Input Parameters

Name Type Notes Required?
node_id string No*
* indicates that it's actually required, but probably already has a valid default value

Action: rrdGraph

Set the FTP connections RRD graph display in the web interface.

Input Parameters

Name Type Notes Required?
rrd integer
Help Entry
Use the dropdown to turn the FTP server activity graph on or off
Example Values
1, 0
Example Default Value
0
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: serverOptions

Update FTP server settings.

Input Parameters

Name Type Notes Required?
maxinstances integer
Help Entry
Sets the maximum number of child processes to be spawned
Example Default Value
30
 No*
maxclients integer
Help Entry
The total number of FTP clients allowed to connect to the FTP server.
Example Default Value
25
 No*
maxclientsperuser integer
Help Entry
The total number of ftp clients allowed to connect from a given user id.
Example Default Value
0
 No*
timeoutlogin integer
Help Entry
Sets the login timeout
Example Default Value
120
 No*
timeoutidle integer
Help Entry
Sets the idle timeout
Example Default Value
600
 No*
timeoutnotransfer integer
Help Entry
Sets the connection without transfer timeout
Example Default Value
900
 No*
timeoutstalled integer
Help Entry
Sets the timeout on stalled downloads
Example Default Value
3600
 No*
timeoutsession integer
Help Entry
Sets a timeout for an entire session
Example Default Value
0
 No*
maxloginattempts integer
Help Entry
Sets how many password attempts are allowed before disconnection
Example Default Value
3
 No*
tlsrequired integer
Help Entry
Toggle whether FTPS (secure FTP) is required on this server
Example Values
1, 0
Example Default Value
0
 No*
showsymlinks integer
Help Entry
Toggle the display of symlinks
Example Values
1, 0
Example Default Value
1
 No*
allowretrieverestart integer
Help Entry
Allow clients to resume uploads
Example Values
1, 0
Example Default Value
1
 No*
allowstorerestart integer
Help Entry
Allow clients to resume downloads
Example Values
1, 0
Example Default Value
1
 No*
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No
* indicates that it's actually required, but probably already has a valid default value

Action: sftpOptions (Added in version 4.9.0-426)

Update SFTP server settings.

Input Parameters

Name Type Notes Required?
port integer
Help Entry
The port used for the SFTP service.
Example Default Value
24
 No*
maxloginattempts integer
Help Entry
Sets how many password attempts are allowed before disconnection
Example Default Value
6
 No*
sftpengine integer
Help Entry
The current status of the SFTP engine.
Example Values
1, 0
Example Default Value
1
 No*
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No
* indicates that it's actually required, but probably already has a valid default value

Action: start (Added in version 4.2.0-260)

Starts the service.

Input Parameters

Name Type Notes Required?
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No

Action: startOnBoot

Set the FTP server start-on-boot status.

Input Parameters

Name Type Notes Required?
ftp_startonboot integer
Help Entry
If set to 'Yes', FTP will be automatically started when the server starts up
Example Values
1, 0
Example Default Value
1
 No*
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No
* indicates that it's actually required, but probably already has a valid default value

Action: startOnNode (Added in version 4.3.0-290)

Starts the service on a specific node (Clustering only).

Input Parameters

Name Type Notes Required?
node_id string No*
* indicates that it's actually required, but probably already has a valid default value

Action: stop (Added in version 4.2.0-260)

Stops the service.

Input Parameters

Name Type Notes Required?
cascade_to_nodes integer
Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
 No

Action: stopOnNode (Added in version 4.3.0-290)

Stops the service on a specific node (Clustering only).

Input Parameters

Name Type Notes Required?
node_id string No*
* indicates that it's actually required, but probably already has a valid default value