Running a backup of the Analytics database

Initiate a backup of the API Connect Analytics database on VMware.

1. Perform a health check of your Analytics system by running the following command:

   apicup subsys health-check <analytics_subsystem>

   If successful, the command returns silently with exit code 0.

2. Start the backup by running the following command and including the appropriate flags:

   apicup subsys backup <analytics_subsystem>

   View the list of supported flags by running the backup command with the -h (help) flag, as shown in the following example:

   apicup subsys backup analytics -h
   Backup analytics subsystem
   
   Usage:
     backup SUBSYS [flags]
   
   Flags:
         --comment string          Comment to add to the backup CR before creation
         --debug                   Enable debug logging
     -h, --help                    help for backup
         --ignore-unavailable      If false, the backup will fail if an index is missing. If true, missing indices will be skipped and the backup will continue.
         --indices strings         Indice(s) you'd like to backup (all/apievents/ui). It can be set to any combination of indices (e.g. ui or ui,apievents).
         --wait                    Wait for the operation to complete or fail.
         --wait-timeout duration   Command timeout in seconds. (default 40s)

   Note: The --indices flag can be set to all|apievents|ui, or to the names of individual indexes. all includes apievents and ui indexes. Multiple values can be supplied with a comma-separated list. For example, to backup all UI data and all data from August of 2022:

   --indices ui, "apic-api-2022.08*"

3. Optionally view a list of available backups, and the status of each, by running the following command:

   apicup subsys list-backups <analytics_subsystem>

   View the list of supported flags by running the list-backups command with the -h (help) flag, as shown in the following example:

   apicup subsys list-backups -h
   List backups of the subsystem
   
   Usage:
     apicup subsys list-backups SUBSYS [flags]
   
   Flags:
     -h, --help               help for list-backups
         --timeout duration   Command timeout in seconds. (default 40s)
   
   Global Flags:
         --accept-license   Accept the license for API Connect
         --debug            Enable debug logging