/admin/add/host

URL: http://<db.host>:<hm.port>/admin/add/host

Adds a host to an existing cluster.

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_address

string

IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.

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 added. The default value is false. The supported values are: true false
accepts_failover	If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. The default value is false. The supported values are: true false
public_address	The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
host_manager_public_url	The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
ram_limit	The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram_limit to -1 to have no RAM limit.
gpus	Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.

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_add_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/add/host endpoint:

Name	Type	Description
added_host	string	Identifier for the newly added host, of the format 'hostN' where N is the integer identifier of that host. Note that the host identifier is transient, i.e. it may change in the future if other hosts are removed.
info	map of string to strings	Additional information.

Empty string in case of an error.