asctl Command Reference
You can use asctl commands in a Command window to display or modify IBM Aspera faspex Application component settings. Faspex configuration options that can be modified using asctl are listed below. If there are modifications that cannot be accomplished with asctl, notify Aspera Support.
Important: You must be an admin to run
asctl. Right click the Command window and select
Run as administrator.
Component | Description |
---|---|
Directory Service (DS) | Faspex Directory Service support. |
Apache | Apache web server. |
Background | Process new data from the MySQL database. |
Faspex | Faspex main application. |
Mongrel | Ruby's HTTP library. |
MySQL | MySQL database. |
All components commands
Important: The commands in this section control all Faspex components.
Task | Command | Description |
---|---|---|
Show config info | asctl all:info | Print info about all components. |
Restart all components | asctl all:restart | Restart all components. |
Setup status | asctl all:setup_status | Information about configuring all components. |
Start | asctl all:start | Start all components. |
Show status | asctl all:status | Display the status of each component. |
Stop | asctl all:stop | Stop all components. |
Show version | asctl all:version | Display the current version of each component. |
Directory Service (DS)
Task | Command | Additional information |
---|---|---|
Start DS | asctl faspex:ds:start | |
Stop DS | asctl faspex:ds:stop | |
Restart DS | asctl faspex:ds:restart | |
Show DS status | asctl faspex:ds:status | |
Disable DS | asctl faspex:ds:disable | When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations. |
Apache
Task | Command | Additional Information |
---|---|---|
Create a setup file | asctl apache:create_setup_file file | Create a reusable file that contains answers to the setup questions. Replace file with a file name. |
Disable Apache | asctl apache:disable | Disable the Aspera Apache server. When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations. |
Disable Apache logs | asctl apache:disable_logs | Set the Apache's log level to 'emerg'. |
Enable Apache logs | asctl apache:enable_logs | Set the Apache's log level to 'notice'. |
Re-generate conf | asctl apache:generate_config | Generate the component's configuration file using the current settings. |
Display hostname | asctl apache:hostname | Display the hostname or IP address of the server. |
Change hostname | asctl apache:hostname host | Change the hostname or IP address of the server. Replace host with a new hostname or IP address. |
Display HTTP port | asctl apache:http_port | Display the HTTP port the web server listens to. |
Change HTTP port | asctl apache:http_port port | Change the HTTP port the web server listens to. Replace port with a new port number. |
Display HTTPS port | asctl apache:https_port | Display the HTTPS port the web server listens to. |
Change HTTPS port | asctl apache:https_port port | Change the HTTPS port the web server listens to. Replace port with a new port number. |
Show config info | asctl apache:info | Print configuration info about Apache. |
Copy your SSL files into the Aspera default location (under default names) | asctl apache:install_ssl_cert cert_file key_file [chain_file] | After upgrading Faspex and Common, use this command to copy your original SSL certificate, key and optional chain file to /opt/aspera/common/apache/conf and give them Aspera-standard names. The httpd-ssl.conf file is also re-rendered and permissions/ownership is set for the cert files. |
Set Apache log level | asctl apache:log_level option | Specify the Apache's log level. Replace option with crit, error, warn, notice, info or debug. |
Create SSL certificate | asctl apache:make_ssl_cert hostname | Create a self-signed SSL certificate for the specified hostname. Replace hostname with your hostname. |
Restart Apache | asctl apache:restart | |
Configure Apache | asctl apache:setup | |
Configure Apache using saved file | asctl apache:setup_from_file filename | Run setup using the answers from a file created using the "create_setup_file" command. |
Start Apache | asctl apache:start | |
Show Apache status | asctl apache:status | |
Stop Apache | asctl apache:stop | |
Upgrade Apache | asctl apache:upgrade | |
Show Apache's version | asctl apache:version |
Background
Task | Command | Additional Information |
---|---|---|
Start Faspex background service | asctl faspex:background:start | |
Stop Faspex background service | asctl faspex:background:stop | |
Restart Faspex background service | asctl faspex:background:restart | |
Show Faspex background service status | asctl faspex:background:status | |
Disable Faspex background service | asctl faspex:background:disable | When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations. |
Faspex Database (DB) Background
Task | Command | Additional Information |
---|---|---|
Start Faspex DB background service | asctl faspex:db:start | |
Stop Faspex DB background service | asctl faspex:db:stop | |
Restart Faspex DB background service | asctl faspex:db:restart | |
Show Faspex DB background service status | asctl faspex:db:status |
Faspex Node Poller (NP) Background
Task | Command | Additional Information |
---|---|---|
Start Faspex NP background service | asctl faspex:np:start | |
Stop Faspex NP background service | asctl faspex:np:stop | |
Restart Faspex NP background service | asctl faspex:np:restart | |
Show Faspex NP background service status | asctl faspex:np:status |
Faspex
Task | Command | Description |
---|---|---|
Setup | asctl faspex:setup | Set up Faspex. |
Setup status | asctl faspex:setup_status | Information about configuring this component. |
Re-generate conf | asctl faspex:generate_config | Generate Faspex configuration file using the current settings. |
Show package dir | asctl faspex:package_dir | Show current directory that Faspex uses to store packages. |
Change package dir | asctl faspex:package_dir dir | Change directory that Faspex uses to store packages. Replace dir with the new path. |
Upgrade | asctl faspex:upgrade | Upgrade Faspex from a previous version. |
Show config info | asctl faspex:info | Print configuration info about Faspex. |
Display URI namespace | asctl faspex:uri_namespace | Display the URI namespace. |
Change URI namespace | asctl faspex:uri_namespace namespace | Change the URI namespace. Replace namespace with a new namespace. |
Display mongrel number | asctl faspex:mongrel_count | Display the number of ports the web server listens to. |
Change mongrel number | asctl faspex:mongrel_count number | Change the number of ports the web server listens to. Replace number with a number. |
Display lowest mongrel port number | asctl faspex:base_port | Display the lowest port for the mongrel instances. |
Change lowest mongrel port number | asctl faspex:base_port number | Change the lowest port for the mongrel instances. Replace number with a number. |
Display HTTP Fallback port | asctl faspex:http_fallback_port | Display the port for HTTP Fallback. |
Change HTTP Fallback port | asctl faspex:http_fallback_port port | Change the port for HTTP Fallback. Replace port with a new port number. |
Backup Faspex database | asctl faspex:backup_database | Backup Faspex database and save the backup files to the path C:\Program Files\Aspera\Faspex\db\backup. |
Migrate Faspex database | asctl faspex:migrate_database | Migrate Faspex MySQL database. |
Restore Faspex database | asctl faspex:restore_database [dir] | Restore Faspex MySQL database. Note: [dir] is the directory containing
the backup file.
Note: To restore database, backup files must use
default name (central.sql, faspex.sql and user_service.sql).
|
Create or update admin | asctl faspex:admin_user login email [password] | Create a new admin, or update an existing admin account. Replace login with a login, email with its email. You can add the account's password in the command ([password]), or enter it when prompted. If the login you have entered exists, the account is updated with new email and password. |
Create setup file | asctl faspex:create_setup_file file | Create a reusable file that contains answers to the setup questions. Replace file with a file name. |
Setup from file | asctl faspex:setup_from_file file | Run setup using the answers from a file created using "create_setup_files". Replace file with a file name. |
Rake command | asctl faspex:rake arg | Evoke a rake command. |
Upload license | asctl console:rake aspera:update_license | Upload a license using a rake task. You must first set the
LICENSE_KEY variable with your license key by running
export
LICENSE_TEXT='license_key' . |
Show set up version | asctl faspex:version | Display the currently set up version. |
Start Faspex | asctl faspex:start | Start Faspex application. |
Stop Faspex | asctl faspex:stop | Stop Faspex application. |
Restart Faspex | asctl faspex:restart | Restart Faspex application. |
Show Faspex status | asctl faspex:status | Display Faspex application's status. |
Disable Faspex | asctl faspex:disable | Disable Faspex application. When disabled, the service does start when rebooting computer, print reminders, or update its configurations. |
Mongrel
Task | Command | Description |
---|---|---|
Start mongrel service | asctl faspex:mongrel:start | Start the Faspex mongrel service. |
Stop mongrel service | asctl faspex:mongrel:stop | Stop the Faspex mongrel service. |
Restart mongrel | asctl faspex:mongrel:restart | Restart the Faspex mongrel service. |
Show mongrel status | asctl faspex:mongrel:status | Display the Faspex mongrel service status. |
Disable mongrel | asctl faspex:mongrel:disable | Disable the Faspex mongrel service. When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations. |
MySQL
Task | Command | Description |
---|---|---|
Create setup file | asctl mysql:create_setup_file file | Create a reusable file that contains answers to the setup questions. Replace file with a file name. |
Display database directory | asctl mysql:data_dir | Display the directory that the databases are kept in. |
Disable MySQL | asctl mysql:disable | Disable the Aspera MySQL. When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations. |
Grant access on MySQL-only server | asctl mysql:grant_remote_access host mysql_user password | If MySQL server is running on a different computer, use this command on the MySQL machine to allow access from the specified machine. Replace host, mysql_user and mysql_password with the server's hostname, MySQL's user name, and the user's password, respectively. |
Show config info | asctl mysql:info | Print configuration info about MySQL. |
Show port | asctl mysql:port | Display the port the MySQL server listens to. |
Change port | asctl mysql:port port | Change the port the MySQL server listens to. Replace port with a new port number. |
Restart MySQL | asctl mysql:restart | Restart the Aspera MySQL. |
Set root password | asctl mysql:set_root_password | Set the password for 'root' in MySQL. |
Configure MySQL-only server | asctl mysql:setup | If MySQL server is running on a different computer, use this command on the MySQL machine to configure it. |
Configure MySQL using saved file | asctl mysql:setup_from_file file | Run setup using the answers from a file created using the "create_setup_file" command. |
Start MySQL | asctl mysql:start | Start the Aspera MySQL. |
Show MySQL status | asctl mysql:status | Display the Aspera MySQL status. |
Stop MySQL | asctl mysql:stop | Stop the Aspera MySQL. |
Upgrade MySQL-only server | asctl mysql:upgrade | If MySQL server is running on a different computer, use this command on the MySQL machine to upgrade the database. |
Show MySQL's version | asctl mysql:version | Display the currently set up version. |