/admin/remove/host

URL: http://GPUDB_IP_ADDRESS:HOST_MANAGER_PORT/admin/remove/host

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 endpoint is serviced by the host manager, not the database cluster itself, so the port specified needs to be the host manager port instead. The default host manager port can be found under Default Ports. For more information on the host manager, see Host Manager.

NOTE: This endpoint should be used for on-premise deployments only.

Input Parameter Description

Name Type Description
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
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
dry_run

If set to true, only validation checks will be performed. No host is removed. The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'admin_remove_host_response' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /admin/remove/host endpoint:

Name Type Description
info map of string to strings Additional information.

Empty string in case of an error.