Controller: /nodeworx/shell

Required Permissions:

SWACCOUNTS

Action: changeshell

Added in Version:

4.8.0-393

Description:

Change the user’s shell.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
users	struct (string)	Yes	example, nobody, rocky, axfrdns
shell	string	No*	/bin/sh, /bin/bash, /usr/bin/sh, /usr/bin/bash, /sbin/nologin	/sbin/nologin

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

Action: compilerSecurity

Added in Version:

6.9.0-1810

Description:

Set compiler security options.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
compilers	string	No*	restricted, unrestricted	restricted
compiler_users	struct (string)	No	adm, alias, apache, axfrdns, bin, chrony, clamav, cockpit-ws, cockpit-wsinstance, daemon, dbus, dnscache, dnslog, dovecot, dovenull, example, ftp, games, halt, iworx, iworx-backup, iworx-pma, iworx-roundcube, iworx-web, lp, mail, mysql, nginx, nobody, operator, polkitd, proftpd, qmaild, qmaill, qmailp, qmailq, qmailr, qmails, rocky, root, rpc, rpcuser, saslauth, setroubleshoot, shutdown, simscan, spamd, sshd, sssd, sync, …

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

Action: disable

Added in Version:

4.8.0-393

Description:

Disable the specified shell user.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
users	struct (string)	Yes	example, nobody, rocky, axfrdns

Action: enable

Added in Version:

4.8.0-393

Description:

Enable the specified shell user.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
users	struct (string)	Yes	example, nobody, rocky, axfrdns

Action: fail

Added in Version:

n/a

Description:

Magic function - test for failure mechanism.

Action: forbiddenUsers

Added in Version:

4.11.0-456

Description:

Modify the list of disabled uniqnames.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
forbidden_unix_users	struct (string)	No*

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

Action: listSiteworxUsers

Added in Version:

4.8.0-393

Description:

Lists the SiteWorx shell users.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'user' => 'example',
      'x' => 'x',
      'uid' => '1002',
      'gid' => '1002',
      'info' => '',
      'home' => '/home/example',
      'shell' => '/sbin/nologin',
      'pass' => '!!',
      'disabled' => true,
      'siteworx' => 'example.com',
      'history' =>
      array (
        'user' => 'example',
        'history' => false,
      ),
    ),
  ),
  'reply_code' => 205,
)

Action: listSystemUsers

Added in Version:

4.8.0-393

Description:

Lists the System shell users.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'user' => 'root',
      'x' => 'x',
      'uid' => '0',
      'gid' => '0',
      'info' => 'root',
      'home' => '/root',
      'shell' => '/bin/bash',
      'pass' => '!!',
      'disabled' => true,
      'history' =>
      array (
        'user' => 'root',
        'history' => false,
      ),
    ),
    1 =>
    array (
      'user' => 'nobody',
      'x' => 'x',
      'uid' => '65534',
      'gid' => '65534',
      'info' => 'Kernel Overflow User',
      'home' => '/',
      'shell' => '/sbin/nologin',
      'pass' => '*',
      'disabled' => true,
      'history' =>
      array (
        'user' => 'nobody',
        'history' => false,
      ),
    ),
    2 =>
    array (
      'user' => 'rocky',
      'x' => 'x',
      'uid' => '1000',
      'gid' => '1000',
      'info' => 'Cloud User',
      'home' => '/home/rocky',
      'shell' => '/bin/bash',
      'pass' => '!!',
      'disabled' => true,
      'history' =>
      array (
        'user' => 'rocky',
        'history' => false,
      ),
    ),
  ),
  'reply_code' => 205,
)

Action: password

Added in Version:

4.7.0-339

Description:

Change a shell user password.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
user	string	Yes	root, nobody, rocky, axfrdns, example
current_password	string	Yes			The current password, used to authenticate changes.
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

Action: queryChangeshell

Added in Version:

5.1.0-838

Description:

Displays the information available to the action “changeshell”.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
users	struct (string)	Yes	example, nobody, rocky, axfrdns

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'shell' => '/sbin/nologin',
    'users' =>
    array (
      0 => 'example',
    ),
  ),
  'reply_code' => 205,
)

Action: queryCompilerSecurity

Added in Version:

6.9.0-1810

Description:

Displays the information available to the action “compilerSecurity”.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'compilers' => 'restricted',
    'compiler_users' =>
    array (
    ),
  ),
  'reply_code' => 205,
)

Action: queryShellOptions

Added in Version:

5.1.0-838

Description:

Displays the information available to the action “shellOptions”.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'shell' => '/bin/bash',
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version:

n/a

Description:

Action to re-route from the current controller to a different one.

Action: shellOptions

Added in Version:

4.7.0-339

Description:

Change the default shell.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
shell	string	No*	/bin/sh, /bin/bash, /usr/bin/sh, /usr/bin/bash, /sbin/nologin	/bin/bash

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

Action: wait

Added in Version:

8.1.3-2998

Description:

Magic function - used to simulate a long-running process

Action: win

Added in Version:

n/a

Description:

Magic function - test for testing success mechanism.