1<refentry id="repmgr-primary-unregister">
2  <indexterm>
3    <primary>repmgr primary unregister</primary>
4  </indexterm>
5  <refmeta>
6    <refentrytitle>repmgr primary unregister</refentrytitle>
7  </refmeta>
8  <refnamediv>
9    <refname>repmgr primary unregister</refname>
10    <refpurpose>unregister an inactive primary node</refpurpose>
11  </refnamediv>
12
13  <refsect1>
14    <title>Description</title>
15    <para>
16      <command>repmgr primary unregister</command> unregisters an inactive primary node
17      from the &repmgr; metadata. This is typically when the primary has failed and is
18      being removed from the cluster after a new primary has been promoted.
19    </para>
20  </refsect1>
21
22  <refsect1>
23    <title>Execution</title>
24    <para>
25      <command>repmgr primary unregister</command> can be run on any active &repmgr; node,
26      with the ID of the node to unregister passed as <option>--node-id</option>.
27    </para>
28    <para>
29      Execute with the <literal>--dry-run</literal> option to check what would happen without
30      actually unregistering the node.
31    </para>
32
33    <para>
34      <command>repmgr master unregister</command> can be used as an alias for
35      <command>repmgr primary unregister</command>.
36    </para>
37  </refsect1>
38
39  <refsect1>
40
41    <title>Options</title>
42
43    <variablelist>
44
45      <varlistentry>
46        <term><option>--dry-run</option></term>
47        <listitem>
48          <para>
49            Check prerequisites but don't actually unregister the primary.
50          </para>
51        </listitem>
52      </varlistentry>
53
54     <varlistentry>
55        <term><option>--node-id</option></term>
56        <listitem>
57          <para>
58            ID of the inactive primary to be unregistered.
59          </para>
60        </listitem>
61      </varlistentry>
62
63     <varlistentry>
64        <term><option>--force</option></term>
65        <listitem>
66          <para>
67            Forcibly unregister the node if it is registered as an active primary,
68            as long as it has no registered standbys; or if it is registered as
69            a primary but running as a standby.
70          </para>
71        </listitem>
72      </varlistentry>
73
74    </variablelist>
75
76  </refsect1>
77
78  <refsect1 id="repmgr-primary-unregister-events">
79    <title>Event notifications</title>
80    <para>
81      A <literal>primary_unregister</literal> <link linkend="event-notifications">event notification</link> will be generated.
82    </para>
83  </refsect1>
84
85</refentry>
86