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.

Input Parameter Description

host_addressstringIP 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.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description

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

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. See Cluster Resilience for more information. The default value is false. The supported values are:

  • true
  • false
public_addressThe 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_urlThe publicly-accessible full path URL to the host manager on the host being added, e.g., ''. The default host manager port can be found in the list of ports used by Kinetica.
ram_limitThe 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.
gpusComma-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:

statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'admin_add_host_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

added_hoststringIdentifier 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.
infomap of string to stringsAdditional information.

Empty string in case of an error.