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

  <h2 className="memtitle"><span className="permalink"><a href="#a2c4d8fe04dc3c5feb4e5e343889bddf8">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> gpudb::GPUdb::adminSwitchover </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverRequest">AdminSwitchoverRequest</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>Manually switch over one or more processes to another host. </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

  <div id="a2d0d5e334a3de21e3794c94494d4a4c9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a2d0d5e334a3de21e3794c94494d4a4c9">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> & gpudb::GPUdb::adminSwitchover </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_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"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

  <div id="a48a805373da1ea7f31119c18ead8750a" />

  <h2 className="memtitle"><span className="permalink"><a href="#a48a805373da1ea7f31119c18ead8750a">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> gpudb::GPUdb::adminSwitchover </td>
          <td>(</td>
          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">processes</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">destinations</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>Manually switch over one or more processes to another host. </p>
      <p>Individual ranks or entire hosts may be moved to another host.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">processes</td>
              <td>Indicates the process identifier to switch over to another host. <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb_1_1Options">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 arg">destinations</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">destinations</td>
              <td>Indicates to which host to switch over each corresponding process given in <span className="em arg">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 arg">processes</span>. </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#acd3f534dccc021ffcc5aafeee1cfc902">admin\_switchover\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a925dd1792a5d66c16430da2ca9b80f3d">true</a>, only validation checks will be performed. Nothing is switched over. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a925dd1792a5d66c16430da2ca9b80f3d">admin\_switchover\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9a9e59d6e159b9ebb9724dc5e5dc63cc">admin\_switchover\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9a9e59d6e159b9ebb9724dc5e5dc63cc">admin\_switchover\_false</a>.
                  </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_1AdminSwitchoverResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a3809c13a0fefaf894419355760f09e5e" />

  <h2 className="memtitle"><span className="permalink"><a href="#a3809c13a0fefaf894419355760f09e5e">◆ </a></span>adminSwitchover() <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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> & gpudb::GPUdb::adminSwitchover </td>
          <td>(</td>
          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">processes</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::vector\< std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">destinations</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_1AdminSwitchoverResponse">AdminSwitchoverResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">processes</td>
              <td>Indicates the process identifier to switch over to another host. <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb_1_1Options">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 arg">destinations</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">destinations</td>
              <td>Indicates to which host to switch over each corresponding process given in <span className="em arg">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 arg">processes</span>. </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#acd3f534dccc021ffcc5aafeee1cfc902">admin\_switchover\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a925dd1792a5d66c16430da2ca9b80f3d">true</a>, only validation checks will be performed. Nothing is switched over. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a925dd1792a5d66c16430da2ca9b80f3d">admin\_switchover\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9a9e59d6e159b9ebb9724dc5e5dc63cc">admin\_switchover\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9a9e59d6e159b9ebb9724dc5e5dc63cc">admin\_switchover\_false</a>.
                  </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_1AdminSwitchoverResponse">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_1AdminSwitchoverResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>