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

# kinetica.AdminAddHostRequest.Options

> kinetica.AdminAddHostRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostRequest#a183b9a0c07c316ad857a36048ac48ee7" title="Optional parameters.">AdminAddHostRequest.options</a>. <a href="#details">More...</a></p>

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

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

      <tr className="memitem:a05bf8cd0fb63542bb8852e6621183c54" id="r_a05bf8cd0fb63542bb8852e6621183c54">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a05bf8cd0fb63542bb8852e6621183c54">DRY\_RUN</a> = "dry\_run"</td>
      </tr>

      <tr className="memdesc:a05bf8cd0fb63542bb8852e6621183c54">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If set to <a className="el" href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, only validation checks will be performed. <br /></td>
      </tr>

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

      <tr className="memitem:ad8bf376a040c9880d5fe2f8fd2bcc9a8" id="r_ad8bf376a040c9880d5fe2f8fd2bcc9a8">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:ad8bf376a040c9880d5fe2f8fd2bcc9a8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options" title="A set of string constants for the parameter AdminAddHostRequest.options.">AdminAddHostRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a2a22715d61f1e6ecc0f3c7c25b9e3abd" id="r_a2a22715d61f1e6ecc0f3c7c25b9e3abd">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:a2a22715d61f1e6ecc0f3c7c25b9e3abd">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options" title="A set of string constants for the parameter AdminAddHostRequest.options.">AdminAddHostRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a00a9f242128d0f6bf5ecf4fc7c2fde30" id="r_a00a9f242128d0f6bf5ecf4fc7c2fde30">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a00a9f242128d0f6bf5ecf4fc7c2fde30">ACCEPTS\_FAILOVER</a> = "accepts\_failover"</td>
      </tr>

      <tr className="memdesc:a00a9f242128d0f6bf5ecf4fc7c2fde30">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If set to <a className="el" href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. <br /></td>
      </tr>

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

      <tr className="memitem:aeb22a91e25cbe893a46973b091d47169" id="r_aeb22a91e25cbe893a46973b091d47169">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeb22a91e25cbe893a46973b091d47169">PUBLIC\_ADDRESS</a> = "public\_address"</td>
      </tr>

      <tr className="memdesc:aeb22a91e25cbe893a46973b091d47169">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. <br /></td>
      </tr>

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

      <tr className="memitem:a0fcd48d4b8baed26894db886e8dd18a8" id="r_a0fcd48d4b8baed26894db886e8dd18a8">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0fcd48d4b8baed26894db886e8dd18a8">HOST\_MANAGER\_PUBLIC\_URL</a> = "host\_manager\_public\_url"</td>
      </tr>

      <tr className="memdesc:a0fcd48d4b8baed26894db886e8dd18a8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">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>. <br /></td>
      </tr>

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

      <tr className="memitem:aa0ba50bdfb734d0b1d8fec679864e1a2" id="r_aa0ba50bdfb734d0b1d8fec679864e1a2">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> = "ram\_limit"</td>
      </tr>

      <tr className="memdesc:aa0ba50bdfb734d0b1d8fec679864e1a2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The desired RAM limit for the host being added, i.e. <br /></td>
      </tr>

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

      <tr className="memitem:a9fb30b1281b5ea72679c13826de72165" id="r_a9fb30b1281b5ea72679c13826de72165">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9fb30b1281b5ea72679c13826de72165">GPUS</a> = "gpus"</td>
      </tr>

      <tr className="memdesc:a9fb30b1281b5ea72679c13826de72165">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. <br /></td>
      </tr>

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

    <div id="details" />

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

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AdminAddHostRequest#a183b9a0c07c316ad857a36048ac48ee7" title="Optional parameters.">AdminAddHostRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L20">20</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
    </div>

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

    <div id="a00a9f242128d0f6bf5ecf4fc7c2fde30" />

    <h2 className="memtitle"><span className="permalink"><a href="#a00a9f242128d0f6bf5ecf4fc7c2fde30">◆ </a></span>ACCEPTS\_FAILOVER</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.ACCEPTS\_FAILOVER = "accepts\_failover"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>If set to <a className="el" href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. </p>
        <p>Supported values:</p>

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

        <p>The default value is <a className="el" href="#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L68">68</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="a05bf8cd0fb63542bb8852e6621183c54" />

    <h2 className="memtitle"><span className="permalink"><a href="#a05bf8cd0fb63542bb8852e6621183c54">◆ </a></span>DRY\_RUN</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.DRY\_RUN = "dry\_run"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>If set to <a className="el" href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">TRUE</a>, only validation checks will be performed. </p>
        <p>No host is added. Supported values:</p>

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

        <p>The default value is <a className="el" href="#a2a22715d61f1e6ecc0f3c7c25b9e3abd">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L40">40</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="a2a22715d61f1e6ecc0f3c7c25b9e3abd" />

    <h2 className="memtitle"><span className="permalink"><a href="#a2a22715d61f1e6ecc0f3c7c25b9e3abd">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options" title="A set of string constants for the parameter AdminAddHostRequest.options.">AdminAddHostRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L48">48</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="a9fb30b1281b5ea72679c13826de72165" />

    <h2 className="memtitle"><span className="permalink"><a href="#a9fb30b1281b5ea72679c13826de72165">◆ </a></span>GPUS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.GPUS = "gpus"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. </p>
        <p>If left blank, all GPUs on the host being added will be eligible.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L101">101</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="a0fcd48d4b8baed26894db886e8dd18a8" />

    <h2 className="memtitle"><span className="permalink"><a href="#a0fcd48d4b8baed26894db886e8dd18a8">◆ </a></span>HOST\_MANAGER\_PUBLIC\_URL</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.HOST\_MANAGER\_PUBLIC\_URL = "host\_manager\_public\_url"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>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>. </p>
        <p>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>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L83">83</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="aeb22a91e25cbe893a46973b091d47169" />

    <h2 className="memtitle"><span className="permalink"><a href="#aeb22a91e25cbe893a46973b091d47169">◆ </a></span>PUBLIC\_ADDRESS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.PUBLIC\_ADDRESS = "public\_address"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. </p>
        <p>This setting is required if any other host(s) in the cluster specify a public address.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L75">75</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="aa0ba50bdfb734d0b1d8fec679864e1a2" />

    <h2 className="memtitle"><span className="permalink"><a href="#aa0ba50bdfb734d0b1d8fec679864e1a2">◆ </a></span>RAM\_LIMIT</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.RAM\_LIMIT = "ram\_limit"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>The desired RAM limit for the host being added, i.e. </p>
        <p>the sum of RAM usage for all processes on the host will not be able to exceed this value. </p>
        <p>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="#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> is set to 10M, the resulting RAM limit is 10 million bytes. Set <a className="el" href="#aa0ba50bdfb734d0b1d8fec679864e1a2">RAM\_LIMIT</a> to -1 to have no RAM limit.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L95">95</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <div id="ad8bf376a040c9880d5fe2f8fd2bcc9a8" />

    <h2 className="memtitle"><span className="permalink"><a href="#ad8bf376a040c9880d5fe2f8fd2bcc9a8">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AdminAddHostRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AdminAddHostRequest_1_1Options" title="A set of string constants for the parameter AdminAddHostRequest.options.">AdminAddHostRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs#L44">44</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminAddHost.cs">AdminAddHost.cs</a></li>
    </ul>
  </div>
</div>


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