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

# adminRemoveHost

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

  <h2 className="memtitle"><span className="permalink"><a href="#afc27231b396dfca335854fb0094d16e6">◆ </a></span>adminRemoveHost() <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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> gpudb::GPUdb::adminRemoveHost </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveHostRequest">AdminRemoveHostRequest</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>Removes a host from an existing cluster. </p>
      <p>If the host to be removed has any ranks running on it, the ranks must be removed using <a className="el" href="#af47d6fbc166de5aa113aacbd9cad9ca7">adminRemoveRanks</a> or manually switched over to a new host using <a className="el" href="#a2c4d8fe04dc3c5feb4e5e343889bddf8">adminSwitchover</a> prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using <a className="el" href="#a2c4d8fe04dc3c5feb4e5e343889bddf8">adminSwitchover</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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_1AdminRemoveHostRequest">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_1AdminRemoveHostResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="ac77e1ed2b6f9e9552b6187bf9553be5f" />

  <h2 className="memtitle"><span className="permalink"><a href="#ac77e1ed2b6f9e9552b6187bf9553be5f">◆ </a></span>adminRemoveHost() <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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> & gpudb::GPUdb::adminRemoveHost </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AdminRemoveHostRequest">AdminRemoveHostRequest</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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Removes a host from an existing cluster. </p>
      <p>If the host to be removed has any ranks running on it, the ranks must be removed using <a className="el" href="#af47d6fbc166de5aa113aacbd9cad9ca7">adminRemoveRanks</a> or manually switched over to a new host using <a className="el" href="#a2c4d8fe04dc3c5feb4e5e343889bddf8">adminSwitchover</a> prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using <a className="el" href="#a2c4d8fe04dc3c5feb4e5e343889bddf8">adminSwitchover</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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_1AdminRemoveHostRequest">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_1AdminRemoveHostResponse">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_1AdminRemoveHostResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="ab4f8c2922e78db2407c488ce3388ebe3" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab4f8c2922e78db2407c488ce3388ebe3">◆ </a></span>adminRemoveHost() <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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> gpudb::GPUdb::adminRemoveHost </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>Removes a host from an existing cluster. </p>
      <p>If the host to be removed has any ranks running on it, the ranks must be removed using <a className="el" href="#a25fe31989868ca19f1e69c67dd67e3c0">adminRemoveRanks</a> or manually switched over to a new host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a> prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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#aa8697bd541887a40667747ceabd91198">admin\_remove\_host\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a486c0f0df4eec1c3174ea18952fd2e0e">true</a>, only validation checks will be performed. No host is removed. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a486c0f0df4eec1c3174ea18952fd2e0e">admin\_remove\_host\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a72ff1372a511e0e43f83fbebe235f4da">admin\_remove\_host\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a72ff1372a511e0e43f83fbebe235f4da">admin\_remove\_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_1AdminRemoveHostResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a6a88a2a737e8b825f3c201e806346b8f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a6a88a2a737e8b825f3c201e806346b8f">◆ </a></span>adminRemoveHost() <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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> & gpudb::GPUdb::adminRemoveHost </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_1AdminRemoveHostResponse">AdminRemoveHostResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Removes a host from an existing cluster. </p>
      <p>If the host to be removed has any ranks running on it, the ranks must be removed using <a className="el" href="#a25fe31989868ca19f1e69c67dd67e3c0">adminRemoveRanks</a> or manually switched over to a new host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a> prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using <a className="el" href="#a48a805373da1ea7f31119c18ead8750a">adminSwitchover</a>.</p>

      <div className="dl section attention">
        <div className="dt">Attention</div>
        <div className="dd">This method should be used for on-premise deployments only.</div>
      </div>

      <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#aa8697bd541887a40667747ceabd91198">admin\_remove\_host\_dry\_run</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a486c0f0df4eec1c3174ea18952fd2e0e">true</a>, only validation checks will be performed. No host is removed. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a486c0f0df4eec1c3174ea18952fd2e0e">admin\_remove\_host\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a72ff1372a511e0e43f83fbebe235f4da">admin\_remove\_host\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a72ff1372a511e0e43f83fbebe235f4da">admin\_remove\_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_1AdminRemoveHostResponse">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_1AdminRemoveHostResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>