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

# adminAddHost

<div className="kinetica-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="adminAddHost(com.gpudb.protocol.AdminAddHostRequest)">
        <h3>adminAddHost</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminAddHostResponse" title="class in com.gpudb.protocol">AdminAddHostResponse</a></span> <span className="element-name">adminAddHost</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest" title="class in com.gpudb.protocol">AdminAddHostRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds a host to an existing cluster.
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AdminAddHostResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="adminAddHost(java.lang.String,java.util.Map)">
        <h3>adminAddHost</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminAddHostResponse" title="class in com.gpudb.protocol">AdminAddHostResponse</a></span> <span className="element-name">adminAddHost</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> hostAddress, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds a host to an existing cluster.
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>hostAddress</code> - 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.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#TRUE"><code>TRUE</code></a>, only validation checks will be performed. No host is added. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#ACCEPTS_FAILOVER"><code>ACCEPTS\_FAILOVER</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#TRUE"><code>TRUE</code></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 href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#PUBLIC_ADDRESS"><code>PUBLIC\_ADDRESS</code></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 href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#HOST_MANAGER_PUBLIC_URL"><code>HOST\_MANAGER\_PUBLIC\_URL</code></a>: The publicly-accessible full path URL to the host manager on the host being added, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'. 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 href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#RAM_LIMIT"><code>RAM\_LIMIT</code></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 href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#RAM_LIMIT"><code>RAM\_LIMIT</code></a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#RAM_LIMIT"><code>RAM\_LIMIT</code></a> to -1 to have no RAM limit. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AdminAddHostRequest.Options#GPUS"><code>GPUS</code></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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AdminAddHostResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>