gpudb::AdminAddHostRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/admin_add_host.h>

Public Member Functions
	AdminAddHostRequest ()
	Constructs an AdminAddHostRequest object with default parameter values. More...
	AdminAddHostRequest (const std::string &hostAddress_, const std::map< std::string, std::string > &options_)
	Constructs an AdminAddHostRequest object with the specified parameters. More...

Public Attributes
std::string	hostAddress
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Adds a host to an existing cluster.

Definition at line 18 of file admin_add_host.h.

Constructor & Destructor Documentation

gpudb::AdminAddHostRequest::AdminAddHostRequest ( )

inline

Constructs an AdminAddHostRequest object with default parameter values.

Definition at line 25 of file admin_add_host.h.

gpudb::AdminAddHostRequest::AdminAddHostRequest ( const std::string &  hostAddress_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AdminAddHostRequest object with the specified parameters.

Parameters

[in]	hostAddress_	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.
[in]	options_	Optional parameters. gpudb::admin_add_host_dry_run: If set to true, only validation checks will be performed. No host is added. gpudb::admin_add_host_true gpudb::admin_add_host_false The default value is gpudb::admin_add_host_false. gpudb::admin_add_host_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. gpudb::admin_add_host_true gpudb::admin_add_host_false The default value is gpudb::admin_add_host_false. gpudb::admin_add_host_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. gpudb::admin_add_host_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. gpudb::admin_add_host_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. gpudb::admin_add_host_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.

Definition at line 96 of file admin_add_host.h.

Member Data Documentation

std::string gpudb::AdminAddHostRequest::hostAddress

Definition at line 102 of file admin_add_host.h.

std::map<std::string, std::string> gpudb::AdminAddHostRequest::options

Definition at line 103 of file admin_add_host.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/admin_add_host.h