> ## 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-doxygen">
  <div id="a64c693befeaaa1d989cb5803ed90a16e" />

  <h2 className="memtitle"><span className="permalink"><a href="#a64c693befeaaa1d989cb5803ed90a16e">◆ </a></span>adminAddHost() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostResponse">AdminAddHostResponse</a> kinetica.Kinetica.adminAddHost </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostRequest">AdminAddHostRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Adds a host to an existing cluster. </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L28">28</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a135029f76185064b1c90b9f17f652582" />

  <h2 className="memtitle"><span className="permalink"><a href="#a135029f76185064b1c90b9f17f652582">◆ </a></span>adminAddHost() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostResponse">AdminAddHostResponse</a> kinetica.Kinetica.adminAddHost </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">host\_address</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Adds a host to an existing cluster. </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">host\_address</td>
              <td>IP address of the host that will be added to the cluster. This host must have installed the same version of <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> as the cluster to which it is being added.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a05bf8cd0fb63542bb8852e6621183c54">DRY\_RUN</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, only validation checks will be performed. No host is added. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a00a9f242128d0f6bf5ecf4fc7c2fde30">ACCEPTS\_FAILOVER</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aeb22a91e25cbe893a46973b091d47169">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a0fcd48d4b8baed26894db886e8dd18a8">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 <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a>. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> to -1 to have no RAM limit. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a9fb30b1281b5ea72679c13826de72165">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 Dictionary.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L158">158</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="ad30e98824e439bf866f6b167dcbdbea4" />

  <h2 className="memtitle"><span className="permalink"><a href="#ad30e98824e439bf866f6b167dcbdbea4">◆ </a></span>AdminAddHostAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostResponse">AdminAddHostResponse</a> > kinetica.Kinetica.AdminAddHostAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostRequest">AdminAddHostRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Adds a host to an existing cluster. </p>
      <p>(async) </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L45">45</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a83b11a2e9a7501577508db0e34def972" />

  <h2 className="memtitle"><span className="permalink"><a href="#a83b11a2e9a7501577508db0e34def972">◆ </a></span>AdminAddHostAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostResponse">AdminAddHostResponse</a> > kinetica.Kinetica.AdminAddHostAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">host\_address</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Adds a host to an existing cluster. </p>
      <p>(async) </p>
      <p>This method should be used for on-premise deployments only.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">host\_address</td>
              <td>IP address of the host that will be added to the cluster. This host must have installed the same version of <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> as the cluster to which it is being added.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a05bf8cd0fb63542bb8852e6621183c54">DRY\_RUN</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, only validation checks will be performed. No host is added. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a00a9f242128d0f6bf5ecf4fc7c2fde30">ACCEPTS\_FAILOVER</a>: If set to <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aeb22a91e25cbe893a46973b091d47169">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a0fcd48d4b8baed26894db886e8dd18a8">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 <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a>. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">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/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> to -1 to have no RAM limit. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options#a9fb30b1281b5ea72679c13826de72165">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 Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L271">271</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>