Custom rake task for adding users to Workgroup/Dropboxcreating csv list of users on Faspex

Rake tasks are scripts that allow you to retrieve, delete or update information on your Faspex server using the command line. This article describes a custom rake task available to add users to a specific workgroup/dropbox.

Please note that you must install this rake task as it is not yet included by default on Faspex. For more information on custom rake tasks and how to install them, see this article (Custom rake tasks on Faspex).


You can list all or a certain subset of users and have the results saved to a csv file with this rake task.

The syntax is as following:

asctl faspex:rake custom:add_users_to_wg -- [options] 
short form long form description
-ffile --file=file Users file - one user per line 
-uusers_list --users=users_list Comma separated list of users
-wname  --wg_name=name Workgroup/Dropbox name (required)
-aaccess_type  --access_type=access_type specify the access type: standard/submin_only/admin
 -h  --help print out help information for this rake task

Note that you must include at least one of the options specifying which users to list in the command. Submit Only Access applies to Dropbox only, it will be ignored if applied to Workgroup.


To all users from file /tmp/faspex_users  to workgroup Distribution you would use the following command:

asctl faspex:rake custom:add_users_to_wg --  --file=/tmp/faspex_users --wg_name=Distribution --access_type="submit_only"

Example output may look like the following :

Running custom:add_users_to_wg:
       Reading from /tmp/faspex_user.
       For Workgroup Distribution.

WARN: Cannot add read user <<>> (external user) to wg Distribution
ERR: Read User <<nouser>> does not exist, skip
User(from file) <<abc>> added to Distribution Workgroup


Article is closed for comments.
Powered by Zendesk