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

> gpudb::AdminAlterHostRequest — 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#ac3888c404412d7e4095a5298fc985533">GPUdb::adminAlterHost</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/admin__alter__host_8h_source">gpudb/protocol/admin\_alter\_host.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:a3e2e56f42a310167d215838db72850bd" id="r_a3e2e56f42a310167d215838db72850bd">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3e2e56f42a310167d215838db72850bd">AdminAlterHostRequest</a> ()</td>
      </tr>

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

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

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

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

      <tr className="separator:ab2f3fd76de53a2040f766c5f98aea59f">
        <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:a659febc52903e0090e632ded924a9568" id="r_a659febc52903e0090e632ded924a9568">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a659febc52903e0090e632ded924a9568">host</a></td>
      </tr>

      <tr className="memdesc:a659febc52903e0090e632ded924a9568">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Identifies the host this applies to. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a641b9bca8484126ce706309b62b36908">
        <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#ac3888c404412d7e4095a5298fc985533">GPUdb::adminAlterHost</a>. </p>
      <p>Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__host_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_host.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a3e2e56f42a310167d215838db72850bd">◆ </a></span>AdminAlterHostRequest() <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::AdminAlterHostRequest::AdminAlterHostRequest </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_1AdminAlterHostRequest" title="A set of parameters for GPUdb::adminAlterHost.">AdminAlterHostRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__host_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_host.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab2f3fd76de53a2040f766c5f98aea59f">◆ </a></span>AdminAlterHostRequest() <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::AdminAlterHostRequest::AdminAlterHostRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">host\_</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_1AdminAlterHostRequest" title="A set of parameters for GPUdb::adminAlterHost.">AdminAlterHostRequest</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">host\_</td>
                <td>Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf. </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#a23200136ca0f3b8117145e3541da8846">admin\_alter\_host\_accepts\_failover</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a3205582cf2412cf631505da3f866093b">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#a3205582cf2412cf631505da3f866093b">admin\_alter\_host\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a51342d54993c89e9eccd38d4453dc920">admin\_alter\_host\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a51342d54993c89e9eccd38d4453dc920">admin\_alter\_host\_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__alter__host_8h_source#l00064">64</a> of file <a className="el" href="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_host.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Identifies the host this applies to. </p>
        <p>Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__alter__host_8h_source#l00075">75</a> of file <a className="el" href="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_host.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a23200136ca0f3b8117145e3541da8846">admin\_alter\_host\_accepts\_failover</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a3205582cf2412cf631505da3f866093b">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#a3205582cf2412cf631505da3f866093b">admin\_alter\_host\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a51342d54993c89e9eccd38d4453dc920">admin\_alter\_host\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a51342d54993c89e9eccd38d4453dc920">admin\_alter\_host\_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__alter__host_8h_source#l00097">97</a> of file <a className="el" href="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_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="/content/api/cpp/admin__alter__host_8h_source">admin\_alter\_host.h</a></li>
    </ul>
  </div>
</div>