A set of string constants for the parameter options. More...

Public Attributes
const string	DRY_RUN = "dry_run"
	If set to TRUE, only validation checks will be performed. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	ACCEPTS_FAILOVER = "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. More...

const string	PUBLIC_ADDRESS = "public_address"
	The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. More...

const string	HOST_MANAGER_PUBLIC_URL = "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'. More...

const string	RAM_LIMIT = "ram_limit"
	The desired RAM limit for the host being added, i.e. More...

const string	GPUS = "gpus"
	Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 20 of file AdminAddHost.cs.

Member Data Documentation

◆ ACCEPTS_FAILOVER

const string kinetica.AdminAddHostRequest.Options.ACCEPTS_FAILOVER = "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.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 54 of file AdminAddHost.cs.

◆ DRY_RUN

const string kinetica.AdminAddHostRequest.Options.DRY_RUN = "dry_run"

If set to TRUE, only validation checks will be performed.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 35 of file AdminAddHost.cs.

◆ FALSE

const string kinetica.AdminAddHostRequest.Options.FALSE = "false"

Definition at line 38 of file AdminAddHost.cs.

◆ GPUS

const string kinetica.AdminAddHostRequest.Options.GPUS = "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 87 of file AdminAddHost.cs.

◆ HOST_MANAGER_PUBLIC_URL

const string kinetica.AdminAddHostRequest.Options.HOST_MANAGER_PUBLIC_URL = "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.

Definition at line 69 of file AdminAddHost.cs.

◆ PUBLIC_ADDRESS

const string kinetica.AdminAddHostRequest.Options.PUBLIC_ADDRESS = "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.

Definition at line 61 of file AdminAddHost.cs.

◆ RAM_LIMIT

const string kinetica.AdminAddHostRequest.Options.RAM_LIMIT = "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.

Definition at line 81 of file AdminAddHost.cs.

◆ TRUE

const string kinetica.AdminAddHostRequest.Options.TRUE = "true"

Definition at line 37 of file AdminAddHost.cs.

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

Kinetica/Protocol/AdminAddHost.cs

Public Attributes