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

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

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.

Options
-------

.. code:: text

     -f, --config-file string   config file; ignored if
                                --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
         --dsn string           database connection string
                                e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "
     -h, --help                 help for pgd
     -L, --log-level string     logging level: debug, info, warn, error (default "error")
     -o, --output string        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:`Switchover <Switchover>` 

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

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

.. toctree::
  :maxdepth: 3

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