1<refentry id="repmgr-standby-unregister">
2  <indexterm>
3    <primary>repmgr standby unregister</primary>
4  </indexterm>
5
6  <refmeta>
7    <refentrytitle>repmgr standby unregister</refentrytitle>
8  </refmeta>
9
10  <refnamediv>
11    <refname>repmgr standby unregister</refname>
12    <refpurpose>remove a standby's information from the &repmgr; metadata</refpurpose>
13  </refnamediv>
14
15  <refsect1>
16    <title>Description</title>
17    <para>
18      Unregisters a standby with &repmgr;. This command does not affect the actual
19      replication, just removes the standby's entry from the &repmgr; metadata.
20    </para>
21  </refsect1>
22
23  <refsect1>
24    <title>Execution</title>
25    <para>
26      To unregister a running standby, execute:
27      <programlisting>
28        repmgr standby unregister -f /etc/repmgr.conf</programlisting>
29    </para>
30    <para>
31      This will remove the standby record from &repmgr;'s internal metadata
32      table (<literal>repmgr.nodes</literal>). A <literal>standby_unregister</literal>
33      event notification will be recorded in the <literal>repmgr.events</literal> table.
34    </para>
35    <para>
36      If the standby is not running, the command can be executed on another
37      node by providing the id of the node to be unregistered using
38      the command line parameter <literal>--node-id</literal>, e.g. executing the following
39      command on the primary server will unregister the standby with
40      id <literal>3</literal>:
41      <programlisting>
42        repmgr standby unregister -f /etc/repmgr.conf --node-id=3</programlisting>
43    </para>
44  </refsect1>
45
46  <refsect1>
47    <title>Options</title>
48    <variablelist>
49
50      <varlistentry>
51        <term><option>--node-id</option></term>
52        <listitem>
53          <para>
54            <varname>node_id</varname> of the node to unregister (optional)
55          </para>
56        </listitem>
57      </varlistentry>
58
59    </variablelist>
60  </refsect1>
61
62  <refsect1 id="repmgr-standby-unregister-events">
63    <title>Event notifications</title>
64    <para>
65      A <literal>standby_unregister</literal> <link linkend="event-notifications">event notification</link> will be generated.
66    </para>
67  </refsect1>
68
69</refentry>
70
71