Version 3.12.0

4.1. List backups

To display a list of created backups on all storage, just use the command nxs-backup ls backups. The command takes the name of a job or group of jobs as an argument. If no group is specified, the default value all is used.

The example below shows a list of files for all jobs on all storage:

$ nxs-backup ls backups
External backup jobs  # Group of exterbal backups
└── my_ext            # Job name
    └── ext_bak.sh    # External command used
        ├── local     # Storage name
        │   ├── /var/nxs-backup/ext/my_ext/daily/2024-07-23_11-02.bak
        │   ├── /var/nxs-backup/ext/my_ext/monthly/2024-07-01_11-02.bak
        │   └── /var/nxs-backup/ext/my_ext/weekly/2024-07-21_11-02.bak
        └── scp       # Storage name
            ├── /var/nxs-backup/ext/my_ext/daily/2024-07-18_11-02.bak
            ├── /var/nxs-backup/ext/my_ext/daily/2024-07-19_11-02.bak
            ├── /var/nxs-backup/ext/my_ext/daily/2024-07-20_11-02.bak
            ├── /var/nxs-backup/ext/my_ext/daily/2024-07-21_11-02.bak
            ├── /var/nxs-backup/ext/my_ext/daily/2024-07-22_11-02.bak
            └── /var/nxs-backup/ext/my_ext/daily/2024-07-23_11-02.bak
Database backup jobs  # Group of database backups
└── test_psql         # Job name
    ├── psql13/demo   # Target calculated during execution (db_source/database)
    │   ├── scp   
    │   │   ├── /var/nxs-backup/psql13/demo/daily/demo_2024-07-22_11-03.sql.gz
    │   │   ├── /var/nxs-backup/psql13/demo/daily/demo_2024-07-23_11-03.sql.gz
    │   │   ├── /var/nxs-backup/psql13/demo/monthly/demo_2024-07-01_11-03.sql.gz
    │   │   └── /var/nxs-backup/psql13/demo/weekly/demo_2024-07-21_11-03.sql.gz
    │   └── local   
    │       └── /var/nxs-backup/psql/psql13/demo/daily/demo_2024-07-23_11-03.sql.gz
    └── psql13/events # Target calculated during execution (db_source/database)
        ├── scp 
        │   ├── /var/nxs-backup/db/psql13/events/daily/events_2024-07-22_11-03.sql.gz
        │   ├── /var/nxs-backup/db/psql13/events/daily/events_2024-07-23_11-03.sql.gz
        │   ├── /var/nxs-backup/db/psql13/events/monthly/events_2024-07-01_11-03.sql.gz
        │   └── /var/nxs-backup/db/psql13/events/weekly/events_2024-07-21_11-03.sql.gz
        └── local
            └── /var/nxs-backup/psql/psql13/events/daily/events_2024-07-23_11-03.sql.gz
File backup jobs      # Group of files backups
└── test_files        # Job name
    ├── www_data/p1   # Target calculated during execution (files_source/subdir)
    │   ├── scp  
    │   │   ├── /var/nxs-backup/files/www_data/p1/daily/p1_2024-07-22_11-04.tar.gz
    │   │   ├── /var/nxs-backup/files/www_data/p1/daily/p1_2024-07-23_11-04.tar.gz
    │   │   ├── /var/nxs-backup/files/www_data/p1/monthly/p1_2024-07-01_11-04.tar.gz
    │   │   └── /var/nxs-backup/files/www_data/p1/weekly/p1_2024-07-21_11-04.tar.gz
    │   └── local
    │       └── /var/nxs-backup/files/www_data/p1/daily/p1_2024-07-23_11-02.tar.gz
    └── www_data/p2   # Target calculated during execution (files_source/subdir)
        ├── scp  
        │   ├── /var/nxs-backup/files/www_data/p2/daily/p2_2024-07-22_11-04.tar.gz
        │   ├── /var/nxs-backup/files/www_data/p2/daily/p2_2024-07-23_11-04.tar.gz
        │   ├── /var/nxs-backup/files/www_data/p2/monthly/p2_2024-07-01_11-04.tar.gz
        │   └── /var/nxs-backup/files/www_data/p2/weekly/p2_2024-07-21_11-04.tar.gz
        └── local
            └── /var/nxs-backup/files/www_data/p2/daily/p2_2024-07-23_11-02.tar.gz

Command reference:

$ nxs-backup ls backups -h
nxs-backup 3.10.0
Usage: nxs-backup ls backups [JOB_NAME/GROUP_NAME]

Positional arguments:
  JOB_NAME/GROUP_NAME    Name of job or jobs group to run [default: all]

Global options:
  --config PATH, -c PATH
                         Path to config file [default: /etc/nxs-backup/nxs-backup.conf]
  --test-config, -t      Check if configuration correct
  --help, -h             display this help and exit
  --version              display version and exit