Controller: /siteworx/ftp
=========================

:Required Permissions: FTP
:Required Options: FTP Accounts

Action: ``add``
---------------

:Added in Version: 4.7.0-339
:Description: Add an FTP account.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - string
     - Yes
     - 
     - 
     - Username of FTP user currently logged in
   * - ``password``
     - string
     - Yes
     - 
     - 
     - 
   * - ``confirm_password``
     - string
     - Yes
     - 
     - 
     - Confirm the password field by providing it again. Must match the password provided.
   * - ``encrypted``
     - integer
     - No
     - 1, 0
     - 
     - 
   * - ``homedir``
     - string
     - No*
     - 
     - /home/example
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``delete``
------------------

:Added in Version: 4.7.0-339
:Description: Delete an FTP account.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - struct (string)
     - Yes
     - ftp, sw_ftp_secondary
     - 
     - Username of FTP user currently logged in

Action: ``edit``
----------------

:Added in Version: 4.7.0-339
:Description: Edit a FTP account.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - string
     - Yes
     - ftp, sw_ftp_secondary
     - 
     - 
   * - ``password``
     - string
     - No
     - 
     - 
     - 
   * - ``confirm_password``
     - string
     - No
     - 
     - 
     - Confirm the password field by providing it again. Must match the password provided.
   * - ``encrypted``
     - integer
     - No
     - 1, 0
     - 
     - 
   * - ``homedir``
     - string
     - No*
     - 
     - /home/example
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``fail``
----------------

:Added in Version: n/a
:Description: Magic function - test for failure mechanism.

Action: ``list``
----------------

:Added in Version: 4.7.0-339
:Description: List FTP accounts.

.. warning::

   This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listFtpAccounts


Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 
       array (
         0 => 'ftp',
         1 => 'ftp@example.com',
       ),
       1 => 
       array (
         0 => 'sw_ftp_secondary',
         1 => 'sw_ftp_secondary@example.com',
       ),
     ),
     'reply_code' => 205,
   )


Action: ``listFtpAccounts``
---------------------------

:Added in Version: 4.8.0-393
:Description: List FTP Accounts.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 
       array (
         'username' => 'ftp',
         'crypt_password' => '$1$VD.jRZxs$JzPhjlZIuMLb87LZX2mxt/',
         'homedir' => '/home/example',
         'login_count' => '0',
         'fulluser' => 'ftp@example.com',
         'status' => 'active',
       ),
       1 => 
       array (
         'username' => 'sw_ftp_secondary',
         'crypt_password' => '$1$VD.jRZxs$JzPhjlZIuMLb87LZX2mxt/',
         'homedir' => '/home/example',
         'login_count' => '0',
         'fulluser' => 'sw_ftp_secondary@example.com',
         'status' => 'active',
       ),
     ),
     'reply_code' => 205,
   )


Action: ``queryEdit``
---------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "edit".

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - string
     - Yes
     - ftp, sw_ftp_secondary
     - 
     - 

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'username' => 'ftp',
       'password' => NULL,
       'confirm_password' => NULL,
       'encrypted' => NULL,
       'homedir' => '/home/example',
       'user' => 'ftp',
     ),
     'reply_code' => 205,
   )


Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Action: ``suspend``
-------------------

:Added in Version: 5.1.0-954
:Description: Suspend an FTP account.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - struct (string)
     - Yes
     - ftp, sw_ftp_secondary
     - 
     - Username of FTP user currently logged in

Action: ``unsuspend``
---------------------

:Added in Version: 5.1.0-954
:Description: Unsuspend an FTP account.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``user``
     - struct (string)
     - Yes
     - ftp, sw_ftp_secondary
     - 
     - Username of FTP user currently logged in

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.