Rake tasks are scripts that allow you to retrieve, delete or update information on your Faspex server using the command line. Run with the configuration command asctl, rake tasks can perform actions on user accounts, packages and Workgroups on an individual level or in bulk.
Many rake tasks are already available as part of your Faspex installation and are documented in the Faspex manual. This article details custom rake tasks that are not yet part of the Faspex product but which you can add to your installation of Faspex for the added functionality. You will need to download the attached file and follow the installation instructions to make use of these custom rake tasks. Note that in the future these custom rake tasks may be integrated into Faspex by default.
If you need further assistance with the installation or usage of these custom rake tasks, please contact Support.
1. Download the custom.rake file attached at the bottom of this article.
2. Copy the file to the following directory, based on your system:
- Linux: /opt/aspera/faspex/lib/tasks
- Windows: C:\Program Files (x86)\Aspera\Faspex\lib\tasks
The general syntax for Faspex rake tasks is the following:
asctl faspex:rake <RAKE TASK> -- <OPTIONS>
The rake task and the options it takes are separated by -- (double -). For example, in the following command the rake task is custom:force_password_reset, and the option specified is -u with a value of username:
asctl faspex:rake custom:force_password_reset -- -uusername
Most of the rake tasks can take in options either in a shortened form or in a long form. The short form of an option consists only of a single dash and a letter (such as -u) and is followed immediately by a value with no space (such as -ujanedoe). The long form consists of a double dash and the option name, followed by an equal sign and the value. For example, the equivalent long form option to -ujanedoe would be --user_name=janedoe. You can use a combination of long form and short form options in the rake task commands.
In order to list further information about a rake task and the parameters it takes, run the rake task command and add --help at the end in place of any parameters. For example, to find out more about the force_password_reset rake task, you would run the following:
asctl faspex:rake custom:force_password_reset -- --help
To view all the custom rake tasks available to use, run the following command:
asctl faspex:rake custom:help
Custom rake task articles
You may also find documentation of the available rake tasks with examples in the following links, based on the type of rake task:
Audit report rake tasks
User management rake tasks
- Deleting contacts
- Force password expiration
- Force password reset
- Export Workgroup members
- Emailing users
- List users
- Deleting single user
- Deleting list of users
Package management rake tasks