You can utilize the asctl commands in a Terminal window to display or modify Faspex Server's component settings. This topic lists all Faspex Server configuration options that can be modified using asctl. If there are modifications that cannot be accomplished with asctl, please notify Aspera Support.

All components commands

IMPORTANT NOTE:The commands in this section control all Faspex Server 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.
(Deprecated) Clean up Apache logs	asctl apache:delete_logs_older_than <X>_days IMPORTANT NOTE: This command has been deprecated for Faspex Server version 2.0.7+. For Faspex Server version 2.0.7+, all Apache logs are, by default, rotated by size (defaulting to 10Mb files and only retaining the last 10 rotated logs).	Delete log files older than the specified number of days. Replace <X> with a number.
Disable Apache	asctl apache:disable	Disable Aspera's Apache. 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 Faspex Server 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.
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 <host>	Create a self-signed SSL certificate for the specified hostname. Replace <host> with your hostname.
Restart Apache	asctl apache:restart
Configure Apache	asctl apache:setup
Configure Apache using saved file	asctl apache:setup_from_file <file>	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 /opt/aspera/faspex/db/backup. Refer to Backing up Faspex Server for more info.
Migrate Faspex database	asctl faspex:migrate_database	Migrate Faspex MySQL database.
Restore Faspex database	asctl faspex:restore_database	Restore Faspex MySQL database. 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.
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 will not start when rebooting computer, does not print reminders or update its configurations.

Mongrel

Task	Command	Description
Start mongrel service	asctl faspex:mongrel:start	Start Faspex's mongrel service.
Stop mongrel service	asctl faspex:mongrel:stop	Stop Faspex's mongrel service.
Restart mongrel	asctl faspex:mongrel:restart	Restart Faspex's mongrel service.
Show mongrel status	asctl faspex:mongrel:status	Display Faspex's mongrel service status.
Disable mongrel	asctl faspex:mongrel:disable	Disable Faspex's 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 Aspera's 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 Aspera's 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 Aspera's MySQL.
Show MySQL status	asctl mysql:status	Display Aspera's MySQL status.
Stop MySQL	asctl mysql:stop	Stop Aspera's 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.