admin_remove_host - Kinetica Docs

admin_remove_host

admin_remove_host(
host: string,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<AdminRemoveHostResponse>
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 admin_remove_ranks or manually switched over to a new host using admin_switchover 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 admin_switchover.
Note: This method should be used for on-premise deployments only.
Parameters
- host: string
  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.
- Optionaloptions: Record<string, string>
  Optional parameters.
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<AdminRemoveHostResponse>
Promise<Types.AdminRemoveHostResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2245

admin_remove_host_request

admin_remove_host_request(
request: AdminRemoveHostRequest,
callback?: GPUdbCallback,
): Promise<AdminRemoveHostResponse>
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 admin_remove_ranks or manually switched over to a new host using admin_switchover 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 admin_switchover.
Note: This method should be used for on-premise deployments only.
Parameters
- request: AdminRemoveHostRequest
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<AdminRemoveHostResponse>
Promise<Types.AdminRemoveHostResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2215