> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# adminHaOffline

<div className="kinetica-doxygen">
  <div id="abe3d7c0c7fc2acb14bdc22e030dee0b5" />

  <h2 className="memtitle"><span className="permalink"><a href="#abe3d7c0c7fc2acb14bdc22e030dee0b5">◆ </a></span>adminHaOffline() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> gpudb::GPUdb::adminHaOffline </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest">AdminHaOfflineRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. </p>
      <p>In-flight queries may fail to replicate to other clusters in the ring when going offline.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="acfc2a6a92f7019a18768ffe9c91478d1" />

  <h2 className="memtitle"><span className="permalink"><a href="#acfc2a6a92f7019a18768ffe9c91478d1">◆ </a></span>adminHaOffline() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> & gpudb::GPUdb::adminHaOffline </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest">AdminHaOfflineRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. </p>
      <p>In-flight queries may fail to replicate to other clusters in the ring when going offline.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a95662cd408cd6e50c823e6c078b8a345" />

  <h2 className="memtitle"><span className="permalink"><a href="#a95662cd408cd6e50c823e6c078b8a345">◆ </a></span>adminHaOffline() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> gpudb::GPUdb::adminHaOffline </td>
          <td>(</td>
          <td className="paramtype">const bool</td>
          <td className="paramname"><span className="paramname"><span className="em">offline</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. </p>
      <p>In-flight queries may fail to replicate to other clusters in the ring when going offline.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">offline</td>

              <td>
                Set to true if desired state is offline. Supported values:

                <ul>
                  <li> true </li>
                  <li> false </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty map.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a50a1072291f97df14d3d7d42fb2650e2" />

  <h2 className="memtitle"><span className="permalink"><a href="#a50a1072291f97df14d3d7d42fb2650e2">◆ </a></span>adminHaOffline() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> & gpudb::GPUdb::adminHaOffline </td>
          <td>(</td>
          <td className="paramtype">const bool</td>
          <td className="paramname"><span className="paramname"><span className="em">offline</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">AdminHaOfflineResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. </p>
      <p>In-flight queries may fail to replicate to other clusters in the ring when going offline.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">offline</td>

              <td>
                Set to true if desired state is offline. Supported values:

                <ul>
                  <li> true </li>
                  <li> false </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty map. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>