/admin/switchover

URL: http://GPUDB_IP_ADDRESS:HOST_MANAGER_PORT/admin/switchover

Manually switchover one or more processes to another host. Individual ranks or entire hosts may be moved to another host.

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
processes array of strings Indicates the process identifier to switchover to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file, e.g., 'host[N].address' or 'rank[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in input parameter destinations.
destinations array of strings Indicates to which host to switchover each corresponding process given in input parameter processes. Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file, e.g., 'host[N].address'. Each entry in this array will receive the corresponding process entry at the same index in input parameter processes.
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. Nothing is switched over. 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_switchover_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/switchover endpoint:

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

Empty string in case of an error.