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

# adminAlterHost

<div className="kinetica-doxygen">
  <div id="ac3888c404412d7e4095a5298fc985533" />

  <h2 className="memtitle"><span className="permalink"><a href="#ac3888c404412d7e4095a5298fc985533">◆ </a></span>adminAlterHost() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> gpudb::GPUdb::adminAlterHost </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostRequest">AdminAlterHostRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Alter properties on an existing host in the cluster. </p>
      <p>Currently, the only property that can be altered is a hosts ability to accept failover processes.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostRequest">Request</a> 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"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="abe8d5b26c89c904d69e47d350fbd8a99" />

  <h2 className="memtitle"><span className="permalink"><a href="#abe8d5b26c89c904d69e47d350fbd8a99">◆ </a></span>adminAlterHost() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> & gpudb::GPUdb::adminAlterHost </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostRequest">AdminAlterHostRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Alter properties on an existing host in the cluster. </p>
      <p>Currently, the only property that can be altered is a hosts ability to accept failover processes.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a2c34940d8cd5b11c42c518cbb7417930" />

  <h2 className="memtitle"><span className="permalink"><a href="#a2c34940d8cd5b11c42c518cbb7417930">◆ </a></span>adminAlterHost() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> gpudb::GPUdb::adminAlterHost </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Alter properties on an existing host in the cluster. </p>
      <p>Currently, the only property that can be altered is a hosts ability to accept failover processes.</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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a45ba2c611f5cdc0089013bcd2193fcfb" />

  <h2 className="memtitle"><span className="permalink"><a href="#a45ba2c611f5cdc0089013bcd2193fcfb">◆ </a></span>adminAlterHost() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> & gpudb::GPUdb::adminAlterHost </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">AdminAlterHostResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Alter properties on an existing host in the cluster. </p>
      <p>Currently, the only property that can be altered is a hosts ability to accept failover processes.</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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AdminAlterHostResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>