Controller: /nodeworx/shell =========================== :Required Permissions: SWACCOUNTS Action: ``changeshell`` ----------------------- :Added in Version: 4.8.0-393 :Description: Change the user's shell. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``users`` - struct (string) - Yes - example, nfsnobody, centos, axfrdns - - * - ``shell`` - string - No* - /bin/sh, /bin/bash, /usr/bin/sh, /usr/bin/bash, /bin/zsh, /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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``compilers`` - string - No* - restricted, unrestricted - restricted - * - ``compiler_users`` - struct (string) - No - adm, alias, apache, axfrdns, bin, centos, chrony, clamav, daemon, dbus, dnscache, dnslog, dovecot, dovenull, example, ftp, games, halt, iworx, iworx-backup, iworx-horde, iworx-pma, iworx-roundcube, iworx-web, lp, mail, mailman, mysql, nfsnobody, nobody, ntp, operator, polkitd, postfix, proftpd, qmaild, qmaill, qmailp, qmailq, qmailr, qmails, root, rpc, rpcuser, saslauth, shutdown, simscan, spamd, sshd, 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``users`` - struct (string) - Yes - example, nfsnobody, centos, axfrdns - - Action: ``enable`` ------------------ :Added in Version: 4.8.0-393 :Description: Enable the specified shell user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``users`` - struct (string) - Yes - example, nfsnobody, centos, 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - 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 ^^^^^^^^^^^^^ .. code-block:: 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 ^^^^^^^^^^^^^ .. code-block:: 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' => 'nfsnobody', 'x' => 'x', 'uid' => '65534', 'gid' => '65534', 'info' => 'Anonymous NFS User', 'home' => '/var/lib/nfs', 'shell' => '/sbin/nologin', 'pass' => '!!', 'disabled' => true, 'history' => array ( 'user' => 'nfsnobody', 'history' => false, ), ), 2 => array ( 'user' => 'centos', 'x' => 'x', 'uid' => '1000', 'gid' => '1000', 'info' => 'Cloud User', 'home' => '/home/centos', 'shell' => '/bin/bash', 'pass' => '!!', 'disabled' => true, 'history' => array ( 'user' => 'centos', 'history' => false, ), ), ), 'reply_code' => 205, ) Action: ``password`` -------------------- :Added in Version: 4.7.0-339 :Description: Change a shell user password. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - string - Yes - root, nfsnobody, centos, 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``users`` - struct (string) - Yes - example, nfsnobody, centos, axfrdns - - Sample Output ^^^^^^^^^^^^^ .. code-block:: 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 ^^^^^^^^^^^^^ .. code-block:: 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 ^^^^^^^^^^^^^ .. code-block:: 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``shell`` - string - No* - /bin/sh, /bin/bash, /usr/bin/sh, /usr/bin/bash, /bin/zsh, /sbin/nologin - /bin/bash - \* indicates that it's actually required, but probably already has a valid default value. Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.