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

# adminSwitchover

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

  <h2 className="memtitle"><span className="permalink"><a href="#ad6bf151abf662b20713a239122586b29">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> kinetica.Kinetica.adminSwitchover </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AdminSwitchoverRequest">AdminSwitchoverRequest</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>Manually switch over one or more processes to another host. </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>
      <p>This method should be used for on-premise deployments only. </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#L3005">3005</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="a84914b98cd006f1ac717f312e92f88c9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a84914b98cd006f1ac717f312e92f88c9">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> kinetica.Kinetica.adminSwitchover </td>
                <td>(</td>
                <td className="paramtype">IList\< string ></td>
                <td className="paramname"><span className="paramname"><span className="em">processes</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< string ></td>
                <td className="paramname"><span className="paramname"><span className="em">destinations</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>Manually switch over one or more processes to another host. </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>
      <p>This method should be used for on-premise deployments only. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">processes</td>
              <td>Indicates the process identifier to switch over to another host. <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica_1_1Options" title="Connection Options.">Options</a> are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the <a href="/content/config/#config-main-network" target="_top">Network</a> section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in <span className="em">destinations</span> .</td>
            </tr>

            <tr>
              <td className="paramname">destinations</td>
              <td>Indicates to which host to switch over each corresponding process given in <span className="em">processes</span> . Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the <a href="/content/config/#config-main-network" target="_top">Network</a> section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in <span className="em">processes</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#a96f25deeb2d9faf075eefbe4259ef546">DRY\_RUN</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#ad6805aa9de1b9b4ccafe17464c5eebd0">TRUE</a>, only validation checks will be performed. Nothing is switched over. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#ad6805aa9de1b9b4ccafe17464c5eebd0">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#acc4832f7bf6baf91bccbb5ca402deca5">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#acc4832f7bf6baf91bccbb5ca402deca5">FALSE</a>.
                  </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#L3087">3087</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="acea66c498927009fb51e2e392dd01a63" />

  <h2 className="memtitle"><span className="permalink"><a href="#acea66c498927009fb51e2e392dd01a63">◆ </a></span>AdminSwitchoverAsync() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> > kinetica.Kinetica.AdminSwitchoverAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AdminSwitchoverRequest">AdminSwitchoverRequest</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>Manually switch over one or more processes to another host. </p>
      <p>(async) </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>
      <p>This method should be used for on-premise deployments only. </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#L3025">3025</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="a0f6a27fabb4f55184bb892dfdb110fa9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a0f6a27fabb4f55184bb892dfdb110fa9">◆ </a></span>AdminSwitchoverAsync() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> > kinetica.Kinetica.AdminSwitchoverAsync </td>
                <td>(</td>
                <td className="paramtype">IList\< string ></td>
                <td className="paramname"><span className="paramname"><span className="em">processes</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< string ></td>
                <td className="paramname"><span className="paramname"><span className="em">destinations</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>Manually switch over one or more processes to another host. </p>
      <p>(async) </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>
      <p>This method should be used for on-premise deployments only. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">processes</td>
              <td>Indicates the process identifier to switch over to another host. <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica_1_1Options" title="Connection Options.">Options</a> are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the <a href="/content/config/#config-main-network" target="_top">Network</a> section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in <span className="em">destinations</span> .</td>
            </tr>

            <tr>
              <td className="paramname">destinations</td>
              <td>Indicates to which host to switch over each corresponding process given in <span className="em">processes</span> . Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the <a href="/content/config/#config-main-network" target="_top">Network</a> section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in <span className="em">processes</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#a96f25deeb2d9faf075eefbe4259ef546">DRY\_RUN</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#ad6805aa9de1b9b4ccafe17464c5eebd0">TRUE</a>, only validation checks will be performed. Nothing is switched over. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#ad6805aa9de1b9b4ccafe17464c5eebd0">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#acc4832f7bf6baf91bccbb5ca402deca5">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminSwitchoverRequest_1_1Options#acc4832f7bf6baf91bccbb5ca402deca5">FALSE</a>.
                  </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#L3151">3151</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>