Using edbctl v1
Use the edbctl --help or -h command to return the complete list of commands:
edbctl --help
Output
The edbctl command-line interface (CLI) is a tool for managing HCP resources and performing database cluster operations. You must first configure an access key using the "credential" command to proceed using this tool. These credentials will allow you to access the supported HCP resources and manage them using the edbctl CLI. The CLI supports various commands for managing projects, clusters, backups, credentials, and more. Usage: edbctl [options] edbctl [command] Examples: edbctl credential import-access-key --name user1 --access-key baak_xyz --address http://localhost:8080 edbctl config set context_project "Adaptable Chameleon" Management Commands: credential Manage authentication credentials. project Manage projects associated with the database clusters. location Manage locations associated with the projects. cluster Manage database cluster resources. cluster-template Manage database cluster template resources. backup Manage cluster backups. catalog Manage database catalog resources. Configuration Commands: config Manages configuration settings for edbctl tool help Help about any command Setup Commands: image Image management commands operator Operator management commands operand Operand management commands image-pull-secret Pull Secret management commands hybrid-manager Hybrid Manager management, monitoring, and diagnostics Options: -h, --help help for edbctl -v, --version version for edbctl Use "edbctl [command] --help" for more information about a command.
edbctl commands list
- edbctl backup — Manage cluster backups.
- edbctl catalog — Manage database catalog resources.
- edbctl cluster — Manage database cluster resources.
- edbctl cluster-template — Manage database cluster template resources.
- edbctl config — Manage configuration settings for
edbctltool. - edbctl credential — Manage authentication credentials.
- edbctl hybrid-manager — Hybrid Manager management, monitoring, and diagnostics.
- edbctl image — Manage asset images.
- edbctl image-pull-secret — Pull secret management commands.
- edbctl location — Manage locations for database cluster provisioning.
- edbctl operand — Manage operand images.
- edbctl operator — Manage the Postgres AI Operator.
- edbctl project — Manage projects associated with the database clusters.
- On this page
- edbctl commands list