Support

Documentation

akeeba:filter:exclude

What it does: Set an exclusion filter to Akeeba Backup.

Syntax: akeeba:filter:exclude VALUE [-root=ROOT] [--filterType=TYPE] [--profile=PROFILE]

Arguments

This command takes one mandatory argument.

VALUE

The value of the filter to set. This is the folder or table name to exclude, or the regular to use (for regex* filter types).

Options

--root=ROOT

Optional. Which filter root to use.

Defaults to [SITEROOT] or [SITEDB] depending on the --filterType option. Ignored for include filters. The names of the inclusion filters are the roots you can use when managing exclusion filters.

Tip: There are two special roots, [SITEROOT] (the filesystem root of the Joomla site) and [SITEDB] (the main database of the Joomla site).

--filterType=TYPE

Optional. The type of filter you want to set:

  • files. Exclude individual files.

  • directories. Exclude an entire folder, including its files and subdirectories.

  • skipdirs. Exclude the subdirectories of this folder but not its files.

  • skipfiles. Exclude the files contained in this folder but not its subdirectories.

  • regexfiles. Exclude individual files matching this regular expression. Only available in Akeeba Backup Professional.

  • regexdirectories. Exclude the subdirectories of and all files container in all folders matching this regular expression. Only available in Akeeba Backup Professional.

  • regexskipdirs. Exclude the subdirectories of all folders matching this regular expression but not their files. Only available in Akeeba Backup Professional.

  • regexskipfiles. Exclude the files contained in all folders matching this regular expression but not their subdirectories. Only available in Akeeba Backup Professional.

  • tables. Exclude individual database tables and their contents.

  • tabledata. Exclude the contents of individual tables but not the table itself (it backs up the table's structure).

  • regextables. Exclude all database tables whose name matches this regular expression and their contents. Only available in Akeeba Backup Professional.

  • regextabledata. Exclude the contents of all database tables whose name matches this regular expression but not the table itself (it backs up the tables' structure). Only available in Akeeba Backup Professional.

--profile=PROFILE

Optional. The backup profile to use. Default: 1.

Keep in mind that filters are set per backup profile. They are not reused across backup profiles.

Exit codes

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

0

The command completed without an error.

1

The root you entered cannot be found.

2

You have Akeeba Backup Core but the filter you're trying to manage is only available in Akeeba Backup Professional.