Command reference
=================

The command name for the PGD command line interface is ``pgd`` .

Synopsis
--------

The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool
to manage your EDB Postgres Distributed cluster. It allows you to run
commands against EDB Postgres Distributed clusters. You can use it to
inspect and manage cluster resources.

Global Options
--------------

All commands accept the following global options:

.. csv-table::
  :header: Short,Long,Description
  :widths: 8,8,20
  :align: left
  :class: longtable

  "",--dsn,"Database connection string<br/>For example ""host=bdr-a1 port=5432 dbname=bdrdb user=postgres"""
  -f,--config-file,"Name/Path to config file.<br/>This is ignored if --dsn flag is present<br/>Default ""/etc/edb/pgd-cli/pgd-cli-config.yml"""
  -h,--help,Help for pgd - will show specific help for any command used
  -L,--log-level,"Logging level: debug, info, warn, error (default ""error"")"
  -o,--output,"Output format: json, yaml"

See also
--------

-  :ref:`check-health <check-health>` 

-  :ref:`create-proxy <create-proxy>` 

-  :ref:`delete-proxy <delete-proxy>` 

-  :ref:`set-group-options <set-group-options>` 

-  :ref:`set-node-options <set-node-options>` 

-  :ref:`set-proxy-options <set-proxy-options>` 

-  :ref:`show-clockskew <show-clockskew>` 

-  :ref:`show-events <show-events>` 

-  :ref:`show-groups <show-groups>` 

-  :ref:`show-nodes <show-nodes>` 

-  :ref:`show-proxies <show-proxies>` 

-  :ref:`show-raft <show-raft>` 

-  :ref:`show-replslots <show-replslots>` 

-  :ref:`show-subscriptions <show-subscriptions>` 

-  :ref:`show-version <show-version>` 

-  :ref:`Perform a planned switchover <Perform a planned switchover>` 

-  :ref:`verify-cluster <verify-cluster>` 

-  :ref:`verify-settings <verify-settings>` 

.. toctree::
  :maxdepth: 3

  Tools--cli--command_ref--pgd_check-health
  Tools--cli--command_ref--pgd_create-proxy
  Tools--cli--command_ref--pgd_delete-proxy
  Tools--cli--command_ref--pgd_set-group-options
  Tools--cli--command_ref--pgd_set-node-options
  Tools--cli--command_ref--pgd_set-proxy-options
  Tools--cli--command_ref--pgd_show-clockskew
  Tools--cli--command_ref--pgd_show-events
  Tools--cli--command_ref--pgd_show-groups
  Tools--cli--command_ref--pgd_show-nodes
  Tools--cli--command_ref--pgd_show-proxies
  Tools--cli--command_ref--pgd_show-raft
  Tools--cli--command_ref--pgd_show-replslots
  Tools--cli--command_ref--pgd_show-subscriptions
  Tools--cli--command_ref--pgd_show-version
  Tools--cli--command_ref--pgd_switchover
  Tools--cli--command_ref--pgd_verify-cluster
  Tools--cli--command_ref--pgd_verify-settings