Controller: /nodeworx/mail/smtp2 ================================ :Required Permissions: EMAIL Action: ``fail`` ---------------- :Added in Version: 4.7.0-339 :Description: Magic function - test for failure mechanism. Action: ``isRunning`` --------------------- :Added in Version: 4.7.0-339 :Description: Checks if the service is running or not. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => false, 'reply_code' => 205, ) Action: ``isRunningOnNode`` --------------------------- :Added in Version: 4.7.0-339 :Description: Checks if the service is running on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``listGeneralName`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the "normal" name - ie "web server" instead of "httpd". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => '##LG_ALTERNATE_INBOUND_SMTP_SERVER##', 'reply_code' => 205, ) Action: ``listPortNumbers`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists a string of the port numbers that this service uses, comma-seperated. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => 'Success', 'reply_code' => 205, ) Action: ``listPortNumbersArray`` -------------------------------- :Added in Version: 4.7.0-339 :Description: Lists array of port numbers and ranges that this service uses. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => '', ), 'reply_code' => 205, ) Action: ``listRequiredPermissions`` ----------------------------------- :Added in Version: 4.7.0-339 :Description: Lists an array of permissions required to control the service. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => 'EMAIL', ), 'reply_code' => 205, ) Action: ``listServiceInfo`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the service name, ports, page, and status. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'id' => 'smtp2', 'name' => '##LG_ALTERNATE_INBOUND_SMTP_SERVER##', 'ports' => '', 'page' => '/nodeworx/mail/mta', 'ctrl' => '/nodeworx/mail/smtp2', 'is_running' => 0, ), 'reply_code' => 205, ) Action: ``listServiceName`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the service name - ie "httpd" instead of "web server". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => 'smtp2', 'reply_code' => 205, ) Action: ``listServicePage`` --------------------------- :Added in Version: 4.7.0-339 :Description: Lists the page that controls the service. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => '/nodeworx/mail/mta', 'reply_code' => 205, ) Action: ``reroute`` ------------------- :Added in Version: 4.7.0-339 :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: ``restart`` ------------------- :Added in Version: 4.7.0-339 :Description: Restart the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - 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 Action: ``restartOnNode`` ------------------------- :Added in Version: 4.7.0-339 :Description: Restarts the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``start`` ----------------- :Added in Version: 4.7.0-339 :Description: Start the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - 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 Action: ``startOnNode`` ----------------------- :Added in Version: 4.7.0-339 :Description: Starts the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``stop`` ---------------- :Added in Version: 4.7.0-339 :Description: Stop the service. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cascade_to_nodes`` - integer - No - 1 - - 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 Action: ``stopOnNode`` ---------------------- :Added in Version: 4.7.0-339 :Description: Stops the service on a specific node (Clustering only). Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``node_id`` - string - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``update`` ------------------ :Added in Version: 4.7.0-339 :Description: Change the auth settings for the alternate port SMTP server. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``alternate_smtp_port`` - integer - No* - - 587 - This is the port for running your alternate SMTP server. The default (and recommended) port is 587 but can be any usable port on the box. - *Port 587 Recommended* * - ``auth_mode`` - string - No* - auth_yes/tls_yes, auth_yes/tls_optional - 0 - * - ``cascade_to_nodes`` - integer - No - 1 - - 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 \* indicates that it's actually required, but probably already has a valid default value. Action: ``win`` --------------- :Added in Version: 4.7.0-339 :Description: Magic function - test for testing success mechanism.