[[selection]]
= Index & Snapshot Selection

[partintro]
--

The <<indices-subcommand,indices>> and <<snapshots-subcommand,snapshots>>
<<subcommand,subcommands>> allows <<commands,commands>> to obtain a list of
indices to act on.
--

[[index-selection]]
== Index Selection

[float]
Summary
~~~~~~~

The <<indices-subcommand,indices>> <<subcommand,subcommand>> allows individual
<<commands,commands>> to obtain a list of indices to act on.

------------------------------------------------------------------------------
Options:
  --newer-than INTEGER            Include only indices newer than n time_units
  --older-than INTEGER            Include only indices older than n time_units
  --prefix TEXT                   Include only indices beginning with prefix.
  --suffix TEXT                   Include only indices ending with suffix.
  --time-unit [hours|days|weeks|months]
                                  Unit of time to reckon by
  --timestring TEXT               Python strftime string to match your index
                                  definition, e.g. 2014.07.15 would be
                                  %Y.%m.%d
  --regex TEXT                    Provide your own regex, e.g
                                  '^prefix-.*-suffix$'
  --exclude TEXT                  Exclude matching indices. Can be invoked
                                  multiple times.
  --index TEXT                    Include the provided index in the list. Can
                                  be invoked multiple times.
  --all-indices                   Do not filter indices.  Act on all indices.
  --help                          Show this message and exit.
------------------------------------------------------------------------------

&nbsp;

[float]
Options
~~~~~~~

* <<newer-than,--newer-than>>
* <<older-than,--older-than>>
* <<prefix,--prefix>>
* <<suffix,--suffix>>
* <<time-unit,--time-unit>>
* <<timestring,--timestring>>
* <<regex,--regex>>
* <<exclude,--exclude>>
* <<index_flag,--index>>
* <<all-indices,--all-indices>>

[[snapshot-selection]]
== Snapshot Selection

[float]
Summary
~~~~~~~

The <<snapshots-subcommand,snapshots>> <<subcommand,subcommand>> allows the
<<show>> and <<delete>> commands to obtain a list of snapshots to act on.

----------------------------------------------------------------------------
Options:
  --newer-than INTEGER            Include only snapshots newer than n
                                  time_units
  --older-than INTEGER            Include only snapshots older than n
                                  time_units
  --prefix TEXT                   Include only snapshots beginning with
                                  prefix.
  --suffix TEXT                   Include only snapshots ending with suffix.
  --time-unit [hours|days|weeks|months]
                                  Unit of time to reckon by
  --timestring TEXT               Python strftime string to match your
                                  snapshot's definition, e.g. 20140715020304
                                  would be %Y%m%d%H%M%S
  --regex TEXT                    Provide your own regex, e.g
                                  '^prefix-.*-suffix$'
  --exclude TEXT                  Exclude matching snapshots. Can be invoked
                                  multiple times.
  --snapshot TEXT                 Include the provided snapshot in the list.
                                  Can be invoked multiple times.
  --all-snapshots                 Do not filter snapshots.  Act on all
                                  snapshots.
  --repository TEXT               Repository name.
  --help                          Show this message and exit.
----------------------------------------------------------------------------

&nbsp;

[float]
Options
~~~~~~~

* <<newer-than,--newer-than>>
* <<older-than,--older-than>>
* <<prefix,--prefix>>
* <<suffix,--suffix>>
* <<time-unit,--time-unit>>
* <<timestring,--timestring>>
* <<regex,--regex>>
* <<exclude,--exclude>>
* <<snapshot_flag,--snapshot>>
* <<all-snapshots,--all-snapshots>>
* <<repository,--repository>>
