> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="adminRemoveHost(com.gpudb.protocol.AdminRemoveHostRequest)">
        <h3>adminRemoveHost</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostResponse" title="class in com.gpudb.protocol">AdminRemoveHostResponse</a></span> <span className="element-name">adminRemoveHost</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest" title="class in com.gpudb.protocol">AdminRemoveHostRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using <a href="#adminRemoveRanks(com.gpudb.protocol.AdminRemoveRanksRequest)"><code>adminRemoveRanks</code></a> or manually switched over to a new host using <a href="#adminSwitchover(com.gpudb.protocol.AdminSwitchoverRequest)"><code>adminSwitchover</code></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 href="#adminSwitchover(com.gpudb.protocol.AdminSwitchoverRequest)"><code>adminSwitchover</code></a>.
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="adminRemoveHost(java.lang.String,java.util.Map)">
        <h3>adminRemoveHost</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostResponse" title="class in com.gpudb.protocol">AdminRemoveHostResponse</a></span> <span className="element-name">adminRemoveHost</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> host, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using <a href="#adminRemoveRanks(java.util.List,java.util.Map)"><code>adminRemoveRanks</code></a> or manually switched over to a new host using <a href="#adminSwitchover(java.util.List,java.util.List,java.util.Map)"><code>adminSwitchover</code></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 href="#adminSwitchover(java.util.List,java.util.List,java.util.Map)"><code>adminSwitchover</code></a>.
          <p> <span className="b">Note:</span> This method should be used for on-premise deployments only.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>host</code> - 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.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest.Options#TRUE"><code>TRUE</code></a>, only validation checks will be performed. No host is removed. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AdminRemoveHostResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>
