Controller: /nodeworx/help
==========================

:Required Permissions: REMOTEASSIST

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

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

Action: ``querySsh``
--------------------

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

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

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'mode' => '0',
       'duration' => '72 hours',
     ),
     'reply_code' => 205,
   )


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

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

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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``controller``
     - string
     - Yes
     - Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, ...
     - 
     - 

Action: ``ssh``
---------------

:Added in Version: 4.8.0-393
:Description: Enable or disable Interworx Support SSH user.

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

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

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``mode``
     - integer
     - No*
     - 1, 0
     - 0
     - 
   * - ``duration``
     - string
     - No
     - 24 hours, 48 hours, 72 hours, 1 week
     - 72 hours
     - Defines how long Remote Assistance will be enabled before automatically disabling

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

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

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