Skip to main content
admin_switchover(processes=None, destinations=None, options=)[source]

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

Note

This method should be used for on-premise deployments only.

Parameters

processes (list of str) –

Indicates the process identifier to switch over 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

destinations (list of str) –

Indicates to which host to switch over 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • dry_run – If set to true, only validation checks will be performed. Nothing is switched over. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

info (dict of str to str) –

Additional information.