pgd raft disable
================

Synopsis
--------

The ``pgd raft disable`` command stops the Raft consensus worker on one
or more nodes in the EDB Postgres Distributed cluster. When the worker
is disabled, the node stops participating in Raft elections, ceases to
send or receive consensus log entries, and will not act as a write
leader.

Enabling the worker allows the node to participate in Raft elections,
log replication, and cluster-wide state changes.

..  Note::
   The consensus worker remains in the disabled state until it is explicitly enabled using `pgd raft enable`  or until the Postgres node is restarted, whichever occurs first.

Users and roles
^^^^^^^^^^^^^^^

Requires the ``bdr_superuser`` role. See :ref:`User roles <User roles>`  .

Syntax
------

.. code:: plaintext

   pgd raft disable [OPTIONS]

Options
-------

The following options are available for the ``pgd raft disable``
command:

.. csv-table::
  :header: Short,Long,Description
  :widths: 12,10,25
  :align: left
  :class: longtable

  "",--node,Target a specific node by name to disable its Raft worker.
  "",--group,Target all nodes in a specific group.
  "",--all,Target all nodes in the cluster.

See `Global Options <https://www.enterprisedb.com/docs/pgd/latest/reference/cli/command_ref/#global-options>`_  for common global options.

Examples
--------

Disable Raft on a specific node
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd raft disable --node kaftan
   __OUTPUT__
   Raft disabled successfully on node kaftan

Disable Raft for all nodes in a group
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd raft disable --group dc1_subgroup
   __OUTPUT__
   Raft disabled successfully on 3 nodes in group dc1_subgroup

Disable Raft for the entire cluster
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd raft disable --all
   __OUTPUT__
   Raft disabled successfully on 6 nodes in the cluster
