2.4.Profile configuration options management

2.4.Profile configuration options management

These commands allow you to manage the configuration settings of your backup profiles, used to take backups.

2.4.1.akeeba:option:list

What it does: Lists the configuration options for an Akeeba Backup profile, including their titles.

Syntax: akeeba:option:list [--profile=1] [--filter=FILTER] [--sort-by=SORT_FIELD] [--sort-order=SORT_ORDER] [--format=FORMAT]

Arguments

This command takes no arguments.

Options

--profile=PROFILE

Optional. The backup profile to list configuration options for.

Provide the numeric profile ID. If omitted, the default backup profile ID 1 is used.

--filter=FILTER

Optional. Only return records whose keys begin with the given filter.

Use text e.g. akeeba.core.

--sort-by=SORT_FIELD

Optional. Sort the output by the given column: none, key, value, type, default, title, description, section

Default: none

--sort-order=SORT_ORDER

Optional. Sorting order.

asc for ascending, desc for descending.

--format=FORMAT

Optional. Output format: table, json, yaml, csv, count.

Exit codes

One of the following exit codes will be set when the command finishes running:

0

The command completed without an error.

1

Invalid profile ID specified.

2

Your filter resulted in no options being listed.

Viewing backup settings without backend access

If you do not have access to your site's administrator backend, you can still retrieve your backup configuration via the CLI. From the cli directory of your site run:

php joomla.php akeeba:option:list --profile=1 --format=csv > options.csv

Replace --profile=1 with the numeric ID of the profile you want to inspect. The resulting CSV file contains all configuration option keys and their current values.

Alternatively, if you have direct database access, the raw configuration is stored in the #__akeebabackup_profiles table. Each row corresponds to one profile; the configuration column holds the settings as a JSON document. Note that if you have enabled settings encryption the JSON contents will be encrypted and unreadable without the encryption key.