> ## 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="a882db0cc0becff6a6fa84423929e8bae" />

  <h2 className="memtitle"><span className="permalink"><a href="#a882db0cc0becff6a6fa84423929e8bae">◆ </a></span>adminOffline() <span className="overload">\[1/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname"><a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineResponse">AdminOfflineResponse</a> kinetica.Kinetica.adminOffline </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineRequest">AdminOfflineRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
                <td>)</td>

                <td />
              </tr>
            </table>
          </td>

          <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </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="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L1118">1118</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a151396da8b7ca455e2c3acfdc7b1ba40" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname"><a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineResponse">AdminOfflineResponse</a> kinetica.Kinetica.adminOffline </td>
                <td>(</td>
                <td className="paramtype">bool</td>
                <td className="paramname"><span className="paramname"><span className="em">offline</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span> )</td>
              </tr>
            </table>
          </td>

          <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </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="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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#afa5c499419c638f03681c825b12d24a6">FLUSH\_TO\_DISK</a>: Flush to disk when going offline. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac7a65a814e7a719010f50f565485545b">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac6efef5d844ce30b2d9090f0ba47b1fe">FALSE</a> </li>
                    </ul>
                  </li>
                </ul>

                The default value is an empty Dictionary.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L1182">1182</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a76b06e2983cad0a49b6ae8f27352c3c1" />

  <h2 className="memtitle"><span className="permalink"><a href="#a76b06e2983cad0a49b6ae8f27352c3c1">◆ </a></span>AdminOfflineAsync() <span className="overload">\[1/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineResponse">AdminOfflineResponse</a> > kinetica.Kinetica.AdminOfflineAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_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">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</span> )</td>
              </tr>
            </table>
          </td>

          <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Take the system offline. </p>
      <p>(async) </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="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L1135">1135</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a6c8c04acca2a0fa9d0179882ded5de4e" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineResponse">AdminOfflineResponse</a> > kinetica.Kinetica.AdminOfflineAsync </td>
                <td>(</td>
                <td className="paramtype">bool</td>
                <td className="paramname"><span className="paramname"><span className="em">offline</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</span> )</td>
              </tr>
            </table>
          </td>

          <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Take the system offline. </p>
      <p>(async) </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="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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#afa5c499419c638f03681c825b12d24a6">FLUSH\_TO\_DISK</a>: Flush to disk when going offline. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac7a65a814e7a719010f50f565485545b">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac6efef5d844ce30b2d9090f0ba47b1fe">FALSE</a> </li>
                    </ul>
                  </li>
                </ul>

                The default value is an empty Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L1229">1229</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>