edbctl backup

Suggest edits

Manages cluster backups. Use this command to create, delete, and list backups for your clusters. Use the subcommands to perform specific backup operations.

Commands

edbctl backup list — Display a list of all available backups.
edbctl backup create — Create a backup of a specified cluster.
edbctl backup delete — Delete a backup of a specified cluster.

edbctl backup list

Lists all available backups for a specified cluster. Displays detailed information, including backup ID, name, start time, location, status, and tags.

edbctl backup list [options]

Where options are,

    --cluster-id string   Cluster ID (required). The immutable unique identifier for a cluster
    --location string     Location ID.
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-P, --project string      The project that groups your clusters and other resources, the default is taken from 'context_project'
-o, --output string       [table json yaml xml] (default "table")
-h, --help                help for list

This example shows how to list the backup of the clusters:

edbctl backup list

edbctl backup create

Creates a backup for a specified cluster. Provide the cluster ID, backup name, location ID, and optional tags to initiate the backup.

edbctl backup create [options]

Where options are

    --cluster-id string   Cluster ID (required). The unique identifier for the cluster to back up.
    --method string       Backup method (required). Specify the backup method: BARMAN_CLOUD or VOLUME_SNAPSHOT.
    --name string         Backup name (required). The name of the backup to be created.
    --location string     Location ID (required).
    --group-id string     PGD cluster group ID to be backed up. Required for PGD clusters.
    --tags strings        Assign tags to the backup in the format name=color (color is optional)
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-P, --project string      The project that groups your clusters and other resources, the default is taken from 'context_project'
-y, --yes                 auto-confirm all confirmations
-h, --help                help for create

These examples shows how to create a backup of the cluster:

edbctl backup create --cluster-id p-8nllnskncq --name "My Backup" --method "BARMAN_CLOUD" --location "managed-devspatcher" 
edbctl backup create --cluster-id p-8nllnskncq --name "My Backup" --method "BARMAN_CLOUD" --location "managed-devspatcher"  --tags name2=blue
edbctl backup create --cluster-id p-8nllnskncq --name "My Backup" --method "VOLUME_SNAPSHOT" --location "managed-devspatcher"  --tags name2=#FF0000

edbctl backup delete

Deletes a backup from a specified cluster using its backup ID. This action is irreversible, so ensure you have the correct backup ID before proceeding.

edbctl backup delete {--id} [options]

This example shows how to delete the backup:

edbctl backup delete --id my_backup_id --cluster-id p-8nllnskncq

Where options are,

-i, --id string           Backup ID (required). The immutable unique identifier for the cluster's backup
    --cluster-id string   Cluster ID (required). The immutable unique identifier for a cluster
-c, --credential string   The credential which you created via 'credential create' command, the default is fetched from 'context_credential'
-P, --project string      The project that groups your clusters and other resources, the default is taken from 'context_project'
-y, --yes                 auto-confirm all confirmations
-h, --help                help for delete

← Prev

Hybrid Manager CLI - edbctl

↑ Up