Controller: Sshd

API Controller /nodeworx/sshd
Required Permissions ["SSH"]
Action Description
autoRestart Configure SSHD auto-restart.
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.
listSessions Lists information about current shell sessions.
restart Restarts the service.
restartOnNode Restarts the service on a specific node (Clustering only).
start Starts the service.
startOnBoot Configure SSHD start-on-boot.
startOnNode Starts the service on a specific node (Clustering only).
stop Stops the service.
stopOnNode Stops the service on a specific node (Clustering only).
terminate Terminate shell sessions.
updateConfig Configure SSHD server settings.
updateRrd Toggle SSHD rrd graph in web interface.

Action: autoRestart (Added in version 4.3.0-290)

Configure SSHD auto-restart.

Input Parameters

Name Type Notes Required?
sshd_autorestart integer
Help Entry
With this option on you can have SSH restarted automatically if SSH 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: 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_SSHSERVER##',
)

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

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

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

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' => 'sshd',
    'name' => '##LG_SSHSERVER##',
    'ports' => '22',
    'page' => '/nodeworx/sshd',
    'ctrl' => '/nodeworx/sshd',
    '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' => 'sshd',
)

Action: listServicePage (Added in version 4.2.0-260)

Lists the page that controls the service.

Example Output

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

Action: listSessions (Added in version 4.8.0-393)

Lists information about current shell sessions.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'pid' => '1952',
      'user' => 'root',
      'from' => 'login.dtw.nexcess.net',
      'logintime' => '2011-08-31 11:57 ',
      'idletime' => '10:46',
      'command' => '/home/interworx -c /home/in ',
    ),
  ),
)

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

Configure SSHD start-on-boot.

Input Parameters

Name Type Notes Required?
sshd_startonboot integer
Help Entry
If set to 'Yes', SSH 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

Action: terminate (Added in version 4.8.0-393)

Terminate shell sessions.

Input Parameters

Name Type Notes Required?
pid struct (string) Yes

Action: updateConfig

Configure SSHD server settings.

Input Parameters

Name Type Notes Required?
port integer
Example Default Value
22
 No*
allow_root string
Help Entry
Sets whether the root user can login via ssh. Options are:
  • Yes - Root user is permitted to login
  • Without Password - Disables password authentication for the root user
  • Forced Command Only - Login is allowed but only if a command option was specified. Example: 
    ssh root@test.com uptime
  • No - Root user is not permitted to login
Example Values
yes, without-password, forced-commands-only, no
Example Default Value
yes
 No*
sshd_login_timeout integer
Help Entry
After this timeout period the server will disconnect a user who has not yet succesfully logged in
Example Default Value
120
 No*
sshd_loglevel string
Help Entry
Sets the verbosity that is used when logging sshd messages
Example Values
quiet, fatal, error, info, verbose, debug1, debug2, debug3
Example Default Value
info
 No*
sshd_priv_separate integer
Help Entry
Toggles privilege separation. Used to prevent privilege escalation during the authentication process.
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: updateRrd

Toggle SSHD rrd graph in web interface.

Input Parameters

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