Console asctl Command Reference

 

asctl Command Reference

Use asctl commands to control services related to Aspera Console™.

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

ComponentDescription
Apache Apache web server.
Aspera Console™ Aspera Console main application.
MySQL MySQL database.

All components commands

Important:

The commands in this section control all Console components, not Faspex.

TaskCommandDescription
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.

Apache

TaskCommandAdditional 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:

This command has been deprecated for Aspera Console version 1.5.6+. For Aspera Console version 1.5.6+, 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 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 Aspera Console component's configuration file using the current settings. Generate Aspera 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.
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 Aspera Faspex and Common, use this command to copy your original SSL certificate, key and optional chain file to/opt/aspera/common/apache/confand give them Aspera-standard names. Thehttpd-ssl.conffile 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 <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  

Aspera Console

TaskCommandDescription
Create or update admin asctl console: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.
Backup database asctl console:backup_database <dir> Backup Aspera Console database and associate files to the specified directory. Replace <dir> with a path to store the backup.
Display base port asctl console:base_port Display the base port of the mongrels.
Change base port asctl console:base_port [arg] Change the base port of the mongrels. Replace [arg] with the new base port number.
Create setup file asctl console:create_setup_file <file> Create a reusable file that contains answers to the setup questions. Replace <file> with a file name.
Disable Aspera Console asctl console:disable Disable Aspera Console. When disabled, the service will not start when rebooting computer, does not print reminders or update its configurations.
Re-generate conf asctl console:generate_config Generate Aspera Console component's configuration file using the current settings.
Config info asctl console:info Print Aspera Console configuration info.
Update database asctl console:migrate_database Update database to the latest schema.
Display mongrel count asctl console:mongrel_count Display the number of mongrels to spawn.
Change mongrel count asctl console:mongrel_count <arg> Change the number of mongrels to spawn. Replace <arg> with a number.
Rake command asctl console:rake <arg> Evoke a rake command.
Restart Aspera Console asctl console:restart Restart mongrel web servers and all background processes.
Restore config and data asctl console:restore <dir> Restore Aspera Console database and configuration from a backup directory.
Restore database asctl console:restore_database <dir> Restore Aspera Console database from a backup directory.
Configure Aspera Console component asctl console:setup Configure this component.
Configure Aspera Console using saved file asctl console:setup_from_file <file> Run setup using the answers from a file created using the "create_setup_file" command.
Start Aspera Console asctl console:start Starts mongrel web servers and all background processes.
Show Aspera Console status asctl console:status Display Aspera Console status.
Stop Aspera Console asctl console:stop Stops mongrel web servers and all background processes.
Upgrade asctl console:upgrade Upgrade Aspera Console from a previous version.
Display namespace asctl console:uri_namespace Display Aspera Console's URL namespace.
Change namespace asctl console:uri_namespace <arg> Change Aspera Console's URL namespace. Replace <arg> with the new namespace.
Show Aspera Console's version asctl console:version Display the currently set up version.

MySQL

TaskCommandDescription
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.
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk