> ## 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.

# adminOffline

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

  <h2 className="memtitle"><span className="permalink"><a href="#a9458238afaafde877e568a92d45abb75">◆ </a></span>adminOffline() <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_1AdminOfflineResponse">AdminOfflineResponse</a> gpudb::GPUdb::adminOffline </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminOfflineRequest">AdminOfflineRequest</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>Take the system offline. </p>
      <p>When the system is offline, no user operations can be performed with the exception of a system shutdown.</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_1AdminOfflineRequest">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_1AdminOfflineResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a57f142409c09c17cf6b6db1018d28a86" />

  <h2 className="memtitle"><span className="permalink"><a href="#a57f142409c09c17cf6b6db1018d28a86">◆ </a></span>adminOffline() <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_1AdminOfflineResponse">AdminOfflineResponse</a> & gpudb::GPUdb::adminOffline </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminOfflineRequest">AdminOfflineRequest</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_1AdminOfflineResponse">AdminOfflineResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Take the system offline. </p>
      <p>When the system is offline, no user operations can be performed with the exception of a system shutdown.</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_1AdminOfflineRequest">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_1AdminOfflineResponse">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_1AdminOfflineResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a4d36ee318372b12d061552af95a2910c" />

  <h2 className="memtitle"><span className="permalink"><a href="#a4d36ee318372b12d061552af95a2910c">◆ </a></span>adminOffline() <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_1AdminOfflineResponse">AdminOfflineResponse</a> gpudb::GPUdb::adminOffline </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>Take the system offline. </p>
      <p>When the system is offline, no user operations can be performed with the exception of a system shutdown.</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.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a48ad0bf32eb3b6518fb1ad33016a67cb">admin\_offline\_flush\_to\_disk</a>: Flush to disk when going offline. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5568a4cf7f218648a3798addaf1428c7">admin\_offline\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a07fc9ef868a8baf4eef6f7a9eae1d52d">admin\_offline\_false</a> </li>
                    </ul>
                  </li>
                </ul>

                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_1AdminOfflineResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a9287388ae6e705b7265529115fa564cb" />

  <h2 className="memtitle"><span className="permalink"><a href="#a9287388ae6e705b7265529115fa564cb">◆ </a></span>adminOffline() <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_1AdminOfflineResponse">AdminOfflineResponse</a> & gpudb::GPUdb::adminOffline </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_1AdminOfflineResponse">AdminOfflineResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Take the system offline. </p>
      <p>When the system is offline, no user operations can be performed with the exception of a system shutdown.</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.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a48ad0bf32eb3b6518fb1ad33016a67cb">admin\_offline\_flush\_to\_disk</a>: Flush to disk when going offline. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5568a4cf7f218648a3798addaf1428c7">admin\_offline\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a07fc9ef868a8baf4eef6f7a9eae1d52d">admin\_offline\_false</a> </li>
                    </ul>
                  </li>
                </ul>

                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_1AdminOfflineResponse">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_1AdminOfflineResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>