repmgr/doc/repmgr-cluster-show.sgml

<refentry id="repmgr-cluster-show">
  <indexterm>
    <primary>repmgr cluster show</primary>
  </indexterm>

  <refmeta>
    <refentrytitle>repmgr cluster show</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>repmgr cluster show</refname>
    <refpurpose>display information about each registered node in the replication cluster</refpurpose>
  </refnamediv>


  <refsect1>
    <title>Description</title>
    <para>
      Displays information about each registered node in the replication cluster. This
      command polls each registered server and shows its role (<literal>primary</literal> /
      <literal>standby</literal> / <literal>bdr</literal>) 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.
    </para>
  </refsect1>

  <refsect1>
    <title>Execution</title>
    <para>
      This command requires either a valid <filename>repmgr.conf</filename> file or a database
      connection string to one of the registered nodes; no additional arguments are needed.
    </para>

    <para>
      To show database connection errors when polling nodes, run the command in
      <literal>--verbose</literal> mode.
    </para>

  </refsect1>

  <refsect1>
    <title>Example</title>
    <para>
    <programlisting>
    $ 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</programlisting>
  </para>
  </refsect1>
  <refsect1>
    <title>Notes</title>
    <para>
      The column <literal>Role</literal> shows the expected server role according to the
      &repmgr; metadata. <literal>Status</literal> 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.:
      <programlisting>
    $ 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</programlisting>
    </para>
    <para>
      Node availability is tested by connecting from the node where
      <command>repmgr cluster show</command> is executed, and does not necessarily imply the node
      is down. See <xref linkend="repmgr-cluster-matrix"> and <xref linkend="repmgr-cluster-crosscheck"> to get
          a better overviews of connections between nodes.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <variablelist>

      <varlistentry>
        <term><option>--csv</option></term>
        <listitem>
		  <para>
			<command>repmgr cluster show</command> accepts an optional parameter <literal>--csv</literal>, which
			outputs the replication cluster's status in a simple CSV format, suitable for
			parsing by scripts, e.g.:
			<programlisting>
    $ repmgr -f /etc/repmgr.conf cluster show --csv
    1,-1,-1
    2,0,0
    3,0,1</programlisting>
		  </para>
		  <para>
			The columns have following meanings:
			<itemizedlist spacing="compact" mark="bullet">
			  <listitem>
				<simpara>
				  node ID
				</simpara>
			  </listitem>
			  <listitem>
				<simpara>
            availability (0 = available, -1 = unavailable)
				</simpara>
			  </listitem>
			  <listitem>
				<simpara>
				  recovery state (0 = not in recovery, 1 = in recovery, -1 = unknown)
				</simpara>
			  </listitem>
			</itemizedlist>
		  </para>
		</listitem>
	  </varlistentry>

      <varlistentry>
        <term><option>--terse</option></term>
        <listitem>
          <para>
			Suppress display of the <literal>conninfo</literal> column.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--verbose</option></term>
        <listitem>
          <para>
			Display the full text of any database connection error messages
          </para>
        </listitem>
      </varlistentry>

	</variablelist>

  </refsect1>


  <refsect1>
    <title>Exit codes</title>
    <para>
      Following exit codes can be emitted by <command>repmgr cluster show</command>:
    </para>
    <variablelist>

      <varlistentry>
        <term><option>SUCCESS (0)</option></term>
        <listitem>
          <para>
            No issues were detected.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>ERR_NODE_STATUS (25)</option></term>
        <listitem>
          <para>
            One or more issues were detected.
          </para>
        </listitem>
      </varlistentry>

   </variablelist>
  </refsect1>

  <refsect1>
    <title>See also</title>
    <para>
     <xref linkend="repmgr-node-status">, <xref linkend="repmgr-node-check">, <xref linkend="repmgr-daemon-status">
    </para>
  </refsect1>

</refentry>