repmgr/doc/repmgr-daemon-stop.xml

<refentry id="repmgr-daemon-stop">
  <indexterm>
    <primary>repmgr daemon stop</primary>
  </indexterm>

  <indexterm>
    <primary>repmgrd</primary>
    <secondary>stopping</secondary>
  </indexterm>

  <refmeta>
    <refentrytitle>repmgr daemon stop</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>repmgr daemon stop</refname>
    <refpurpose>Stop the &repmgrd; daemon</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      This command stops the &repmgrd; daemon on the
      local node.
    </para>

    <para>
      By default, &repmgr; will wait for up to 15 seconds to confirm that &repmgrd;
      stopped. This behaviour can be overridden by specifying a diffent value using the <option>--wait</option>
      option, or disabled altogether with the <option>--no-wait</option> option.
    </para>
    <note>
      <para>
        If PostgreSQL is not running on the local node, under some circumstances &repmgr; may not
        be able to confirm if &repmgrd; has actually stopped.
      </para>
    </note>

   <important>
      <para>
        The <filename>repmgr.conf</filename> parameter <varname>repmgrd_service_stop_command</varname>
        must be set for <command>repmgr daemon stop</command> to work; see section
        <xref linkend="repmgr-daemon-stop-configuration"/> for details.
      </para>
    </important>
  </refsect1>

  <refsect1>
    <title>Configuration</title>
    <para>
      <command>repmgr daemon stop</command> will execute the command defined by the
      <varname>repmgrd_service_stop_command</varname> parameter in <filename>repmgr.conf</filename>.
      This must be set to a shell command which will stop &repmgrd;;
      if &repmgr; was installed from a package, this will be the service command defined by the
      package. For more details see <link linkend="appendix-packages">Appendix: &repmgr; package details</link>.
    </para>

    <important>
      <para>
        If &repmgr; was installed from a system package, and you do not configure
        <varname>repmgrd_service_stop_command</varname> to an appropriate service command, this may
        result in the system becoming confused about the state of the &repmgrd;
        service; this is particularly the case with <literal>systemd</literal>.
      </para>
    </important>

  </refsect1>

  <refsect1>

    <title>Options</title>

    <variablelist>

      <varlistentry>
        <term><option>--dry-run</option></term>
        <listitem>
          <para>
            Check prerequisites but don't actually attempt to stop &repmgrd;.
          </para>
          <para>
            This action will output the command which would be executed.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-w</option></term>
        <term><option>--wait</option></term>
        <listitem>
          <para>
            Wait for the specified number of seconds to confirm that &repmgrd;
            stopped successfully.
          </para>
          <para>
            Note that providing <option>--wait=0</option> is the equivalent of <option>--no-wait</option>.
          </para>

         </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--no-wait</option></term>
        <listitem>
          <para>
            Don't wait to confirm that &repmgrd;
            stopped successfully.
          </para>
          <para>
            This is equivalent to providing <option>--wait=0</option>.
          </para>
         </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="repmgr-daemon-stop-configuration" xreflabel="repmgr daemon stop configuration">
    <title>Configuration file settings</title>
    <para>
     The following parameter in <filename>repmgr.conf</filename> is relevant
     to <command>repmgr daemon stop</command>:
    </para>

    <variablelist>

      <varlistentry>

        <term><option>repmgrd_service_stop_command</option></term>
        <listitem>
          <indexterm>
            <primary>repmgrd_service_stop_command</primary>
          <secondary>with &quot;repmgr daemon stop&quot;</secondary>
          </indexterm>

          <para>
            <command>repmgr daemon stop</command> will execute the command defined by the
            <varname>repmgrd_service_stop_command</varname> parameter in <filename>repmgr.conf</filename>.
            This must be set to a shell command which will stop &repmgrd;;
            if &repmgr; was installed from a package, this will be the service command defined by the
            package. For more details see <link linkend="appendix-packages">Appendix: &repmgr; package details</link>.
          </para>
          <important>
            <para>
              If &repmgr; was installed from a system package, and you do not configure
              <varname>repmgrd_service_stop_command</varname> to an appropriate service command, this may
              result in the system becoming confused about the state of the &repmgrd;
              service; this is particularly the case with <literal>systemd</literal>.
            </para>
          </important>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Exit codes</title>
    <para>
      One of the following exit codes will be emitted by <command>repmgr daemon stop</command>:
    </para>
    <variablelist>

      <varlistentry>
        <term><option>SUCCESS (0)</option></term>
        <listitem>
          <para>
            &repmgrd; could be stopped.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>ERR_BAD_CONFIG (1)</option></term>
        <listitem>
          <para>
            <varname>repmgrd_service_stop_command</varname> is not defined in
            <filename>repmgr.conf</filename>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>ERR_REPMGRD_SERVICE (27)</option></term>
        <listitem>
          <para>
            &repmgrd; could not be stopped.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

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

</refentry>