Command-line Tools

Navigation:  CageFS >

Command-line Tools

Previous pageReturn to chapter overviewNext page

cagefsctl is used to manage CageFS. It allows initializing and updating CageFS, as well as enabling/disabling CageFS for individual users.

 

Use the following syntax to manage CageFS:

 

/usr/sbin/cagefsctl [OPTIONS]

 

Options:

 

 -i | --init                 : initialize CageFS (create CageFS if it does not exist)

 -r | --reinit               : reinitialize CageFS (make backup and recreate CageFS)

 -u | --update               : update files in CageFS (add new and modified files to CageFS,

                               remove unneeded files)

 -f | --force                : recreate CageFS (do not make backup, overwrite existing files)

 -d | --dont-clean           : do not delete any files from skeleton (use with --update option)

 -k | --hardlink             : use hardlinks if possible

      --create-mp            : Creates /etc/cagefs/cagefs.mp file

      --mount-skel           : mount CageFS skeleton directory

      --unmount-skel         : unmount CageFS skeleton directory

      --remove-all           : disable CageFS, remove templates and /var/cagefs directory

      --sanity-check         : perform basic self-diagnistics of common cagefs-related issues(mostly useful for support)

      --addrpm               : add rpm-packages in CageFS (run "cagefsctl --update" in order to apply changes)

      --delrpm               : remove rpm-packages from CageFS (run "cagefsctl --update" in order to apply changes)

      --list-rpm             : list rpm-packages that are installed in CageFS

 -e | --enter                : enter into user's CageFS as root

      --update-list          : update specified files only (paths are read from stdin)

      --update-etc           : update etc directory of all or specified users

      --set-update-period    : set min period of update of CageFS in days (default = 1 day)

      --force-update         : force update of CageFS (ignore period of update)

      --force-update-etc     : force update of /etc directories for users in CageFS

      --reconfigure-cagefs   : configure CageFS integration with other software (control panels,

                               database servers, etc)

 

Use the following syntax to manage users:

 

/usr/sbin/cagefsctl [OPTIONS] username [more usernames]

 

Options:

 

 -m | --remount           : remount specified user(s)

 -M | --remount-all       : remount CageFS skeleton directory and all users

                            (use this each time you have changed cagefs.mp file)

 -w | --unmount           : unmount specified user(s)

    | --unmount-dir       : unmount specified dir for all users

 -W | --unmount-all       : unmount CageFS skeleton directory and all users

 -l | --list              : list users that entered in CageFS

      --list-logged-in    : list users that entered in CageFS via SSH

      --enable            : enable CageFS for the user

      --disable           : disable CageFS for the user

      --enable-all        : enable all users, except specified in /etc/cagefs/users.disabled

      --disable-all       : disable all users, except specified in /etc/cagefs/users.enabled

      --display-user-mode : display current mode ("Enable All" or "Disable All")

      --toggle-mode       : toggle mode saving current lists of users

                            (lists of enabled and disabled users remain unchanged)

      --list-enabled      : list enabled users

      --list-disabled     : list disabled users

      --user-status       : print status of specified user (enabled or disabled)

      --getprefix         : display prefix for user

 

PHP Selector related options:

 

      --setup-cl-selector         : setup PHP Selector or register new alt-php versions

      --remove-cls-selector        : unregister alt-php versions, switch users to default php version when needed

      --rebuild-alt-php-ini       : rebuild alt_php.ini file for specified users (or all users if none specified)

      --validate-alt-php-ini      : same as --rebuild-alt-php-ini but also validates alt_php.ini options 

      --cl-selector-reset-versions: reset php version for specifed users to default (or all users if none specified)

      --cl-selector-reset-modules : reset php modules (extensions) for specific users to defaults (or all users if none specified)

      --create-virt-mp            : create virtual mount points for the user

      --create-virt-mp-all        : create virtual mount points for all users

      --remount-virtmp            : create virtual mount points and remount user

      --apply-global-php-ini      : use with 0, 1 or 2 arguments from the list: error_log, date.timezone

                                    without arguments applies all global php options including two above

 

Common options:

 

      --enable-cagefs        : enable CageFS

      --disable-cagefs       : disable CageFS

      --cagefs-status        : print CageFS status (enabled or disabled)

      --set-min-uid          : Set min UID

      --get-min-uid          : Display current MIN_UID setting

      --print-suids          : Print list of SUID and SGID programs in skeleton

      --do-not-ask           : assume "yes" in all queries (should be the first option in command)

      --clean-var-cagefs     : clean /var/cagefs directory (remove data of non-existent users)

      --set-tmpwatch         : set tmpwatch command and parameters (save to /etc/cagefs/cagefs.ini file)

      --tmpwatch             : execute tmpwatch (remove outdated files in tmp directories in CageFS for all users)

      --toggle-plugin        : disable/enable CageFS plugin

 -v | --verbose              : verbose output

      --wait-lock            : wait for end of execution of other cagefsctl processes (when needed) before execution of the command

 -h | --help                 : this message