> ## 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::AdminAddRanksRequest

> gpudb::AdminAddRanksRequest — 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#a6278c393c68970163b7af72e4504235b">GPUdb::adminAddRanks</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">gpudb/protocol/admin\_add\_ranks.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:aa85a511d7b308915706233cb6a741712" id="r_aa85a511d7b308915706233cb6a741712">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa85a511d7b308915706233cb6a741712">AdminAddRanksRequest</a> ()</td>
      </tr>

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

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

      <tr className="memitem:abe2f2423c6903a77eaabcfba0c4909c3" id="r_abe2f2423c6903a77eaabcfba0c4909c3">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abe2f2423c6903a77eaabcfba0c4909c3">AdminAddRanksRequest</a> (const std::vector\< std::string > \&hosts\_, const std::vector\< std::map\< std::string, std::string > > \&configParams\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:abe2f2423c6903a77eaabcfba0c4909c3">
        <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:a235f555606ba1872e1e7af726346d60b" id="r_a235f555606ba1872e1e7af726346d60b">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a></td>
      </tr>

      <tr className="memdesc:a235f555606ba1872e1e7af726346d60b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. <br /></td>
      </tr>

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

      <tr className="memitem:a91781e9348c1f357bbaeb977b26a98e1" id="r_a91781e9348c1f357bbaeb977b26a98e1">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::map\< std::string, std::string > > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a91781e9348c1f357bbaeb977b26a98e1">configParams</a></td>
      </tr>

      <tr className="memdesc:a91781e9348c1f357bbaeb977b26a98e1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Array of maps containing configuration parameters to apply to the new ranks found in <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:ad6dbeafbd1e273a0da94ffbb5eb4050d">
        <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#a6278c393c68970163b7af72e4504235b">GPUdb::adminAddRanks</a>. </p>
      <p>Add one or more ranks to an existing Kinetica cluster. The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a12ddec404e39c247d808318977c10d6b">GPUdb::adminRebalance</a>.</p>
      <p>The database must be offline for this operation, see <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a9458238afaafde877e568a92d45abb75">GPUdb::adminOffline</a></p>
      <p>For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:</p>

      <ul>
        <li><a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a> would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)</li>
        <li><a className="el" href="#a91781e9348c1f357bbaeb977b26a98e1">configParams</a> would be an array of maps, with each map corresponding to the ranks being added in <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a>. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"{"}"rank.gpu":"1"{"}"}'</li>
      </ul>

      <p>This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a02ef4c58e395bbf2c83325cf592397af">GPUdb::createJob</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source#l00046">46</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aa85a511d7b308915706233cb6a741712">◆ </a></span>AdminAddRanksRequest() <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::AdminAddRanksRequest::AdminAddRanksRequest </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_1AdminAddRanksRequest" title="A set of parameters for GPUdb::adminAddRanks.">AdminAddRanksRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source#l00051">51</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#abe2f2423c6903a77eaabcfba0c4909c3">◆ </a></span>AdminAddRanksRequest() <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::AdminAddRanksRequest::AdminAddRanksRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">hosts\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::vector\< std::map\< std::string, std::string > > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">configParams\_</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_1AdminAddRanksRequest" title="A set of parameters for GPUdb::adminAddRanks.">AdminAddRanksRequest</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">hosts\_</td>
                <td>Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a9ea80722f2b7f5f7ade6fc07c8b33dc3">GPUdb::adminAddHost</a>. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, <span className="em arg">hosts\_</span> could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the <span className="em arg">configParams\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">configParams\_</td>
                <td>Array of maps containing configuration parameters to apply to the new ranks found in <span className="em arg">hosts\_</span>. For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the <a href="/content/config/#config-main-network" target="_top">Network</a>, <a href="/content/config/#config-main-hardware" target="_top">Hardware</a>, <a href="/content/config/#config-main-text-search" target="_top">Text Search</a>, and <a href="/content/config/#config-main-ram-tier" target="_top">RAM Tiered Storage</a> sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by <span className="em arg">hosts\_</span> instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in <span className="em arg">configParams\_</span> as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the <span className="em arg">hosts\_</span>. This array must either be completely empty or have the same number of elements as the <span className="em arg">hosts\_</span>. An empty <span className="em arg">configParams\_</span> array will result in the new ranks being set with default parameters. </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#a0de2975076bb989ff78dcba20d5dffa7">admin\_add\_ranks\_dry\_run</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a44ef24a11304d580b4e98f46d1beea7d">true</a>, only validation checks will be performed. No ranks are added. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a44ef24a11304d580b4e98f46d1beea7d">admin\_add\_ranks\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a292a5b353184dc0b1e8385df128c0e0b">admin\_add\_ranks\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a292a5b353184dc0b1e8385df128c0e0b">admin\_add\_ranks\_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__add__ranks_8h_source#l00134">134</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Array of maps containing configuration parameters to apply to the new ranks found in <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a>. </p>
        <p>For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the <a href="/content/config/#config-main-network" target="_top">Network</a>, <a href="/content/config/#config-main-hardware" target="_top">Hardware</a>, <a href="/content/config/#config-main-text-search" target="_top">Text Search</a>, and <a href="/content/config/#config-main-ram-tier" target="_top">RAM Tiered Storage</a> sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a> instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in <a className="el" href="#a91781e9348c1f357bbaeb977b26a98e1">configParams</a> as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a>. This array must either be completely empty or have the same number of elements as the <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a>. An empty <a className="el" href="#a91781e9348c1f357bbaeb977b26a98e1">configParams</a> array will result in the new ranks being set with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source#l00182">182</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a235f555606ba1872e1e7af726346d60b">◆ </a></span>hosts</h2>

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

      <div className="memdoc">
        <p>Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. </p>
        <p>The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a9ea80722f2b7f5f7ade6fc07c8b33dc3">GPUdb::adminAddHost</a>. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, <a className="el" href="#a235f555606ba1872e1e7af726346d60b">hosts</a> could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the <a className="el" href="#a91781e9348c1f357bbaeb977b26a98e1">configParams</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source#l00156">156</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a0de2975076bb989ff78dcba20d5dffa7">admin\_add\_ranks\_dry\_run</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a44ef24a11304d580b4e98f46d1beea7d">true</a>, only validation checks will be performed. No ranks are added. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a44ef24a11304d580b4e98f46d1beea7d">admin\_add\_ranks\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a292a5b353184dc0b1e8385df128c0e0b">admin\_add\_ranks\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a292a5b353184dc0b1e8385df128c0e0b">admin\_add\_ranks\_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__add__ranks_8h_source#l00203">203</a> of file <a className="el" href="/content/api/cpp/admin__add__ranks_8h_source">admin\_add\_ranks.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__add__ranks_8h_source">admin\_add\_ranks.h</a></li>
    </ul>
  </div>
</div>