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

> gpudb::AdminAddHostRequest — 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/adminaddhost#a9ea80722f2b7f5f7ade6fc07c8b33dc3">GPUdb::adminAddHost</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">gpudb/protocol/admin\_add\_host.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-methods" />

            Public Member Functions
          </h2>
        </td>
      </tr>

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

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

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

      <tr className="memitem:a3b0d17dbf689d0103032e943009ebfb4" id="r_a3b0d17dbf689d0103032e943009ebfb4">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3b0d17dbf689d0103032e943009ebfb4">AdminAddHostRequest</a> (const std::string \&hostAddress\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-attribs" />

            Public Attributes
          </h2>
        </td>
      </tr>

      <tr className="memitem:a3a9dde11957b70594c4e414019853d4e" id="r_a3a9dde11957b70594c4e414019853d4e">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3a9dde11957b70594c4e414019853d4e">hostAddress</a></td>
      </tr>

      <tr className="memdesc:a3a9dde11957b70594c4e414019853d4e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">IP address of the host that will be added to the cluster. <br /></td>
      </tr>

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

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

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

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

    <div id="details" />

    <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/adminaddhost#a9ea80722f2b7f5f7ade6fc07c8b33dc3">GPUdb::adminAddHost</a>. </p>
      <p>Adds a host to an existing cluster. </p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h#L18">18</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>

    <div id="a1d651773f0653472696bbe6000d499d3" />

    <h2 className="memtitle"><span className="permalink"><a href="#a1d651773f0653472696bbe6000d499d3">◆ </a></span>AdminAddHostRequest() <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::AdminAddHostRequest::AdminAddHostRequest </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_1AdminAddHostRequest" title="A set of parameters for GPUdb::adminAddHost.">AdminAddHostRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h#L23">23</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.h</a>.</p>
      </div>
    </div>

    <div id="a3b0d17dbf689d0103032e943009ebfb4" />

    <h2 className="memtitle"><span className="permalink"><a href="#a3b0d17dbf689d0103032e943009ebfb4">◆ </a></span>AdminAddHostRequest() <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::AdminAddHostRequest::AdminAddHostRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">hostAddress\_</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_1AdminAddHostRequest" title="A set of parameters for GPUdb::adminAddHost.">AdminAddHostRequest</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">hostAddress\_</td>
                <td>IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added. </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#a6b9c4a4f28ff350e583ebabdbb9ea9d0">admin\_add\_host\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">true</a>, only validation checks will be performed. No host is added. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">admin\_add\_host\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a9d5d5f4e173c940b5b47e5582e18604c">admin\_add\_host\_accepts\_failover</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">true</a>, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">admin\_add\_host\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae458957af8c057509db05fa618d440a0">admin\_add\_host\_public\_address</a>: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a54bc9ac75ad2fee1ec35f8d1bcbf871a">admin\_add\_host\_host\_manager\_public\_url</a>: The publicly-accessible full path URL to the host manager on the host being added, e.g., '<a href="http://172.123.45.67:9300'">[http://172.123.45.67:9300](http://172.123.45.67:9300)'</a>. The default host manager port can be found in the <a href="/content/install/shared/ports/" target="_top">list of ports</a> used by Kinetica. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">admin\_add\_host\_ram\_limit</a>: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">ram\_limit</a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">ram\_limit</a> to -1 to have no RAM limit. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3cab389d3f406fd4ae5d4578e7d25458">admin\_add\_host\_gpus</a>: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible. </li>
                  </ul>

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

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h#L121">121</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a3a9dde11957b70594c4e414019853d4e" />

    <h2 className="memtitle"><span className="permalink"><a href="#a3a9dde11957b70594c4e414019853d4e">◆ </a></span>hostAddress</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AdminAddHostRequest::hostAddress</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>IP address of the host that will be added to the cluster. </p>
        <p>This host must have installed the same version of Kinetica as the cluster to which it is being added. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h#L132">132</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.h</a>.</p>
      </div>
    </div>

    <div id="a5d7abf812920f5696cbee4187d503928" />

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a6b9c4a4f28ff350e583ebabdbb9ea9d0">admin\_add\_host\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">true</a>, only validation checks will be performed. No host is added. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">admin\_add\_host\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a9d5d5f4e173c940b5b47e5582e18604c">admin\_add\_host\_accepts\_failover</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">true</a>, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe33956c9bcada52ea76e180fc6207c4">admin\_add\_host\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a1a027fc195451fec3d35f4d665d1d1d0">admin\_add\_host\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae458957af8c057509db05fa618d440a0">admin\_add\_host\_public\_address</a>: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a54bc9ac75ad2fee1ec35f8d1bcbf871a">admin\_add\_host\_host\_manager\_public\_url</a>: The publicly-accessible full path URL to the host manager on the host being added, e.g., '<a href="http://172.123.45.67:9300'">[http://172.123.45.67:9300](http://172.123.45.67:9300)'</a>. The default host manager port can be found in the <a href="/content/install/shared/ports/" target="_top">list of ports</a> used by Kinetica. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">admin\_add\_host\_ram\_limit</a>: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">ram\_limit</a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a className="el" href="/content/api/cpp/namespacegpudb#ab668ed4429090f5a90dd9d6b09cf7654">ram\_limit</a> to -1 to have no RAM limit. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3cab389d3f406fd4ae5d4578e7d25458">admin\_add\_host\_gpus</a>: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h#L194">194</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.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="https://github.com/kineticadb/kinetica-api-cpp/blob/master/gpudb/protocol/admin_add_host.h">admin\_add\_host.h</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.