Chapter 50: Controller: /nodeworx/settings Up Part II: NodeWorx API Spec Chapter 52: Controller: /nodeworx/simplescripts 

51 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 Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
shell string Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/dash, /usr/sbin/jk_chrootsh
Example Default Value
/sbin/nologin
No*
* 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 Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Action: enable
Added in version 4.8.0-393
Description Enable the specified shell user.
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Action: forbiddenUsers
Added in version 4.11.0-456
Description Modify the list of disabled uniqnames.
Input Parameters
Name Type Notes Required?
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 (
’shell’ => ’/sbin/nologin’,
’home’ => ’/home/example’,
’info’ => ’’,
’gid’ => ’670’,
’uid’ => ’670’,
’x’ => ’x’,
’user’ => ’example’,
’pass’ => ’!!’,
’disabled’ => true,
’siteworx’ => ’example.com’,
’history’ =>
array (
’history’ => false,
’user’ => ’example’,
),
),
),
)
Action: listSystemUsers
Added in version 4.8.0-393
Description Lists the System shell users.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’shell’ => ’/bin/bash’,
’home’ => ’/root’,
’info’ => ’root’,
’gid’ => ’0’,
’uid’ => ’0’,
’x’ => ’x’,
’user’ => ’root’,
’pass’ => ’$6$QOSkvN8d$1b5oSdfeYT68.TijbF.roHKJAM0BeaR4rnAfJ/I.mGwhpX8ayw4jt0pxRXZQLL1eNZ8Qd5jjJpBJD7F8D7R0Q.’,
’disabled’ => false,
’history’ =>
array (
’history’ => true,
’user’ => ’root’,
),
),
1 =>
array (
’shell’ => ’/sbin/nologin’,
’home’ => ’/var/lib/nfs’,
’info’ => ’Anonymous NFS User’,
’gid’ => ’65534’,
’uid’ => ’65534’,
’x’ => ’x’,
’user’ => ’nfsnobody’,
’pass’ => ’!!’,
’disabled’ => true,
’history’ =>
array (
’history’ => false,
’user’ => ’nfsnobody’,
),
),
2 =>
array (
’shell’ => ’/bin/bash’,
’home’ => ’/home/axfrdns’,
’info’ => ’’,
’gid’ => ’500’,
’uid’ => ’500’,
’x’ => ’x’,
’user’ => ’axfrdns’,
’pass’ => ’!!’,
’disabled’ => true,
’history’ =>
array (
’history’ => false,
’user’ => ’axfrdns’,
),
),
),
)
Action: password
Added in version 4.7.0-339
Description Change a shell user password.
Input Parameters
Name Type Notes Required?
user string Example Values
root, nfsnobody, axfrdns, example
Yes
current_password string Help Entry
The current password, used to authenticate changes.
Yes
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
Action: queryChangeshell
Added in version 5.1.0-838
Description Displays the information available to the action "changeshell".
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’shell’ => ’/sbin/nologin’,
’users’ =>
array (
0 => ’example’,
),
),
)
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’,
),
)
Action: shellOptions
Added in version 4.7.0-339
Description Change the default shell.
Input Parameters
Name Type Notes Required?
shell string Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/dash, /usr/sbin/jk_chrootsh
Example Default Value
/bin/bash
No*
* indicates that it’s actually required, but probably already has a valid default value
 Chapter 50: Controller: /nodeworx/settings Up Part II: NodeWorx API Spec Chapter 52: Controller: /nodeworx/simplescripts 

(C) 2017 by InterWorx LLC