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

# gpudb::AdminSwitchoverRequest

> gpudb::AdminSwitchoverRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a2c4d8fe04dc3c5feb4e5e343889bddf8">GPUdb::adminSwitchover</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/admin__switchover_8h_source">gpudb/protocol/admin\_switchover.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a7f2b2800c8b864c9c37aa96bf58b51b1" id="r_a7f2b2800c8b864c9c37aa96bf58b51b1">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7f2b2800c8b864c9c37aa96bf58b51b1">AdminSwitchoverRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a7f2b2800c8b864c9c37aa96bf58b51b1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverRequest" title="A set of parameters for GPUdb::adminSwitchover.">AdminSwitchoverRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a7f2b2800c8b864c9c37aa96bf58b51b1">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a4f8bf4d2aab1cea49cd006962a458018" id="r_a4f8bf4d2aab1cea49cd006962a458018">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4f8bf4d2aab1cea49cd006962a458018">AdminSwitchoverRequest</a> (const std::vector\< std::string > \&processes\_, const std::vector\< std::string > \&destinations\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a4f8bf4d2aab1cea49cd006962a458018">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverRequest" title="A set of parameters for GPUdb::adminSwitchover.">AdminSwitchoverRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a4f8bf4d2aab1cea49cd006962a458018">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a32798d7d2c5f749127dba9b228e4f99e" id="r_a32798d7d2c5f749127dba9b228e4f99e">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a32798d7d2c5f749127dba9b228e4f99e">processes</a></td>
      </tr>

      <tr className="memdesc:a32798d7d2c5f749127dba9b228e4f99e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates the process identifier to switch over to another host. <br /></td>
      </tr>

      <tr className="separator:a32798d7d2c5f749127dba9b228e4f99e">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a35cbccceda9faa88fe53453a85ed6bc0" id="r_a35cbccceda9faa88fe53453a85ed6bc0">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a35cbccceda9faa88fe53453a85ed6bc0">destinations</a></td>
      </tr>

      <tr className="memdesc:a35cbccceda9faa88fe53453a85ed6bc0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates to which host to switch over each corresponding process given in <a className="el" href="#a32798d7d2c5f749127dba9b228e4f99e">processes</a>. <br /></td>
      </tr>

      <tr className="separator:a35cbccceda9faa88fe53453a85ed6bc0">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a33e28e24a20079b26fb1a0fd8c6779e7" id="r_a33e28e24a20079b26fb1a0fd8c6779e7">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a33e28e24a20079b26fb1a0fd8c6779e7">options</a></td>
      </tr>

      <tr className="memdesc:a33e28e24a20079b26fb1a0fd8c6779e7">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a33e28e24a20079b26fb1a0fd8c6779e7">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a2c4d8fe04dc3c5feb4e5e343889bddf8">GPUdb::adminSwitchover</a>. </p>
      <p>Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7f2b2800c8b864c9c37aa96bf58b51b1">◆ </a></span>AdminSwitchoverRequest() <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">gpudb::AdminSwitchoverRequest::AdminSwitchoverRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </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>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverRequest" title="A set of parameters for GPUdb::adminSwitchover.">AdminSwitchoverRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4f8bf4d2aab1cea49cd006962a458018">◆ </a></span>AdminSwitchoverRequest() <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">gpudb::AdminSwitchoverRequest::AdminSwitchoverRequest </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>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminSwitchoverRequest" title="A set of parameters for GPUdb::adminSwitchover.">AdminSwitchoverRequest</a> object with the specified parameters. </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">processes\_</td>
                <td>Indicates the process identifier to switch over to another host. Options 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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00081">81</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a35cbccceda9faa88fe53453a85ed6bc0">◆ </a></span>destinations</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::AdminSwitchoverRequest::destinations</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Indicates to which host to switch over each corresponding process given in <a className="el" href="#a32798d7d2c5f749127dba9b228e4f99e">processes</a>. </p>
        <p>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 <a className="el" href="#a32798d7d2c5f749127dba9b228e4f99e">processes</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00110">110</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a33e28e24a20079b26fb1a0fd8c6779e7">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AdminSwitchoverRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

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

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00131">131</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a32798d7d2c5f749127dba9b228e4f99e">◆ </a></span>processes</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::AdminSwitchoverRequest::processes</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Indicates the process identifier to switch over to another host. </p>
        <p>Options 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 <a className="el" href="#a35cbccceda9faa88fe53453a85ed6bc0">destinations</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__switchover_8h_source#l00099">99</a> of file <a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/admin__switchover_8h_source">admin\_switchover.h</a></li>
    </ul>
  </div>
</div>