Running an on-demand backup of the management database

Create a management database backup at any time, by running an apicup command.

Before you begin

Database backup settings for the management subsystem must be configured. See Configuring management database backups.
Take a backup of the portal database at the same time as you take a backup of the management database. The portal and management databases must remain consistent with each other.
Do not attempt to run more than one management database backup at a time. Check that no backups are running:
```
apicup subsys list-backups <management subsystem name>
```
Check that the scheduled backup is not configured to run before you expect your on-demand backup to finish:
```
apicup subsys get <management subsystem name> database-backup-schedule
```

Procedure

Check that your management subsystem is healthy:
```
apicup subsys health-check <management subsystem name>
```
When successful, the command returns silently with an exit code of 0.

Use the apicup command to start the backup process:

apicup subsys backup <management subsystem name>

Monitor the backup process with:

apicup subsys list-backups <management subsystem name>

Example output:

NAME                             AGE     CLUSTER              METHOD              PHASE       ERROR
mgmt-backup-rnvx8                15m     stv3-management-site1-db   ObjectStore   completed   
stv3-management-20240617010000   7h46m   stv3-management-site1-db   ObjectStore   completed

For more information about the backup, use the detailed-output flag:

apicup subsys list-backups <management subsystem name> --detailed-output=true