repmgr cluster show

repmgr cluster show

display information about each registered node in the replication cluster

## Description

Displays information about each registered node in the replication cluster. This command polls each registered server and shows its role (`primary` / `standby` / `bdr`) and status. It polls each server directly and can be run on any node in the cluster; this is also useful when analyzing connectivity from a particular node.

## Execution

This command requires either a valid `repmgr.conf` file or a database connection string to one of the registered nodes; no additional arguments are needed.

To show database connection errors when polling nodes, run the command in `--verbose` mode.

## Example

        $ repmgr -f /etc/repmgr.conf cluster show

         ID | Name  | Role    | Status    | Upstream | Location | Connection string
        ----+-------+---------+-----------+----------+----------+-----------------------------------------
         1  | node1 | primary | * running |          | default  | host=db_node1 dbname=repmgr user=repmgr
         2  | node2 | standby |   running | node1    | default  | host=db_node2 dbname=repmgr user=repmgr
         3  | node3 | standby |   running | node1    | default  | host=db_node3 dbname=repmgr user=repmgr

## Notes

The column `Role` shows the expected server role according to the &repmgr; metadata. `Status` shows whether the server is running or unreachable. If the node has an unexpected role not reflected in the &repmgr; metadata, e.g. a node was manually promoted to primary, this will be highlighted with an exclamation mark, e.g.:

        $ repmgr -f /etc/repmgr.conf cluster show

         ID | Name  | Role    | Status               | Upstream | Location | Connection string
        ----+-------+---------+----------------------+----------+----------+-----------------------------------------
         1  | node1 | primary | ? unreachable        |          | default  | host=db_node1 dbname=repmgr user=repmgr
         2  | node2 | standby | ! running as primary | node1    | default  | host=db_node2 dbname=repmgr user=repmgr
         3  | node3 | standby |   running            | node1    | default  | host=db_node3 dbname=repmgr user=repmgr

        WARNING: following issues were detected
          node "node1" (ID: 1) is registered as an active primary but is unreachable
          node "node2" (ID: 2) is registered as standby but running as primary

Node availability is tested by connecting from the node where `repmgr cluster show` is executed, and does not necessarily imply the node is down. See repmgr-cluster-matrix and repmgr-cluster-crosscheck to get a better overviews of connections between nodes.

## Options

`--csv`

- `repmgr cluster show` accepts an optional parameter `--csv`, which outputs the replication cluster's status in a simple CSV format, suitable for parsing by scripts, e.g.:

          $ repmgr -f /etc/repmgr.conf cluster show --csv
          1,-1,-1
          2,0,0
          3,0,1

  The columns have following meanings:

  - node ID

  - availability (0 = available, -1 = unavailable)

  - recovery state (0 = not in recovery, 1 = in recovery, -1 = unknown)

`--verbose`

- Display the full text of any database connection error messages

## Exit codes

Following exit codes can be emitted by `repmgr cluster show`:

`SUCCESS (0)`

- No issues were detected.

`ERR_NODE_STATUS (25)`

- One or more issues were detected.

## See also

repmgr-node-status, repmgr-node-check, repmgr-daemon-status