1<refentry id="repmgr-node-status">
2  <indexterm>
3    <primary>repmgr node status</primary>
4  </indexterm>
5
6  <refmeta>
7    <refentrytitle>repmgr node status</refentrytitle>
8  </refmeta>
9
10  <refnamediv>
11    <refname>repmgr node status</refname>
12    <refpurpose>show overview of a node's basic information and replication status</refpurpose>
13  </refnamediv>
14
15  <refsect1>
16    <title>Description</title>
17    <para>
18      Displays an overview of a node's basic information and replication
19      status. This command must be run on the local node.
20    </para>
21  </refsect1>
22
23  <refsect1>
24    <title>Example</title>
25    <para>
26    <programlisting>
27        $ repmgr -f /etc/repmgr.conf node status
28        Node "node1":
29            PostgreSQL version: 10beta1
30            Total data size: 30 MB
31            Conninfo: host=node1 dbname=repmgr user=repmgr connect_timeout=2
32            Role: primary
33            WAL archiving: off
34            Archive command: (none)
35            Replication connections: 2 (of maximal 10)
36            Replication slots: 0 (of maximal 10)
37            Replication lag: n/a</programlisting>
38    </para>
39  </refsect1>
40
41  <refsect1>
42    <title>Output format</title>
43    <para>
44      <itemizedlist spacing="compact" mark="bullet">
45
46        <listitem>
47          <simpara>
48            <literal>--csv</literal>: generate output in CSV format
49          </simpara>
50        </listitem>
51      </itemizedlist>
52    </para>
53  </refsect1>
54
55  <refsect1>
56    <title>Exit codes</title>
57    <para>
58      One of the following exit codes will be emitted by <command>repmgr node status</command>:
59    </para>
60    <variablelist>
61
62      <varlistentry>
63        <term><option>SUCCESS (0)</option></term>
64        <listitem>
65          <para>
66            No issues were detected.
67          </para>
68        </listitem>
69      </varlistentry>
70
71      <varlistentry>
72        <term><option>ERR_NODE_STATUS (25)</option></term>
73        <listitem>
74          <para>
75            One or more issues were detected.
76          </para>
77        </listitem>
78      </varlistentry>
79
80   </variablelist>
81  </refsect1>
82
83
84  <refsect1>
85    <title>See also</title>
86    <para>
87      See <xref linkend="repmgr-node-check"/> to diagnose issues and <xref linkend="repmgr-cluster-show"/>
88      for an overview of all nodes in the cluster.
89    </para>
90  </refsect1>
91</refentry>
92