Controller: MailSmtp2

API Controller	/nodeworx/mail/smtp2
Required Permissions	["EMAIL"]

Action	Description
isRunning	Checks if the service is running or not.
isRunningOnNode	Checks if the service is running on a specific node (Clustering only).
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).
start	Starts the service.
startOnNode	Starts the service on a specific node (Clustering only).
stop	Stops the service.
stopOnNode	Stops the service on a specific node (Clustering only).
update	Change the auth settings for the alternate port SMTP server.

Action: isRunning (Added in version 4.2.0-260)

Checks if the service is running or not.

Example Output

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

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: 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_ALTERNATE_INBOUND_SMTP_SERVER##',
)

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' => 'Success',
)

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 => '',
  ),
)

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 => 'EMAIL',
  ),
)

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' => 'smtp2',
    'name' => '##LG_ALTERNATE_INBOUND_SMTP_SERVER##',
    'ports' => '',
    'page' => '/nodeworx/mail/mta',
    'ctrl' => '/nodeworx/mail/smtp2',
    'is_running' => 0,
  ),
)

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' => 'smtp2',
)

Action: listServicePage (Added in version 4.2.0-260)

Lists the page that controls the service.

Example Output

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

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: 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: 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

Action: update (Added in version 4.2.0-260)

Change the auth settings for the alternate port SMTP server.

Input Parameters

Name	Type	Notes	Required?
alternate_smtp_port	integer	Description Port 587 Recommended Help Entry This is the port to run your alternate SMTP server on. The default (and recommended) port is 587 but can be any usuable port on the box. Example Default Value 587	No*
auth_mode	string	Example Values auth_yes/tls_yes, auth_yes/tls_optional 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