ara-manage commandline interface

ara-manage is a command provided by ARA when the API server dependencies are installed.

It is an alias to the python manage.py command interface provided by Django and they can be used interchangeably if you are running ARA from source.

Note

Django comes with a lot of built-in commands and they are not all used or relevant in the context of ARA so they might not be exposed, tested or documented.

This documentation provides information about commands which we think are relevant.

If you do not find a command documented here, you can find more information about it in the Django documentation.

Please feel free to send a patch if we’re missing anything !

ara-manage

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 25)

Command 'ara-manage --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage prune

Used to delete playbooks that are older than a specified amount of days.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 32)

Command 'ara-manage prune --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage changepassword

Change the password for a user.

Relevant when working with authentication.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 41)

Command 'ara-manage changepassword --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage createsuperuser

Superusers are relevant when setting up authentication.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 48)

Command 'ara-manage createsuperuser --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage makemigrations

Generally used to generate new SQL migrations after modifying the database model files.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 55)

Command 'ara-manage makemigrations --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage migrate

Runs SQL migrations.

They need to be run at least once before the API server can start.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 64)

Command 'ara-manage migrate --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage runserver

Runs the embedded development server.

Note

Good for small scale usage.

Consider deploying with a WSGI application server and a web server for production use.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 76)

Command 'ara-manage runserver --help' failed: [Errno 2] No such file or directory: 'ara-manage'

ara-manage generate

Generates a static version of the built-in reporting web interface.

Note

Good for small scale usage but inefficient and contains a lot of small files at a large scale.

System Message: ERROR/6 (/build/python-ara-J9iEEK/python-ara-1.4.3/doc/source/ara-manage.rst, line 86)

Command 'ara-manage generate --help' failed: [Errno 2] No such file or directory: 'ara-manage'