Skip to main content

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

​
Static Public Attributes

const string DRY_RUN = “dry_run”
 If set to TRUE, only validation checks will be performed.
 
const string TRUE = “true”
 A boolean constant for the AdminAddHostRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AdminAddHostRequest.Options options.
 
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.
 
const string PUBLIC_ADDRESS = “public_address”
 The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations.
 
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’.
 
const string RAM_LIMIT = “ram_limit”
 The desired RAM limit for the host being added, i.e.
 
const string GPUS = “gpus”
 Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes.
 

​
Detailed Description

A set of string constants for the parameter AdminAddHostRequest.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”
 static

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:

The default value is FALSE.

Definition at line 68 of file AdminAddHost.cs.

​
◆ DRY_RUN

const string kinetica.AdminAddHostRequest.Options.DRY_RUN = “dry_run”
 static

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

No host is added. Supported values:

The default value is FALSE.

Definition at line 40 of file AdminAddHost.cs.

​
◆ FALSE

const string kinetica.AdminAddHostRequest.Options.FALSE = “false”
 static

A boolean constant for the AdminAddHostRequest.Options options.

Definition at line 48 of file AdminAddHost.cs.

​
◆ GPUS

const string kinetica.AdminAddHostRequest.Options.GPUS = “gpus”
 static

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 101 of file AdminAddHost.cs.

​
◆ HOST_MANAGER_PUBLIC_URL

const string kinetica.AdminAddHostRequest.Options.HOST_MANAGER_PUBLIC_URL = “host_manager_public_url”
 static

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 83 of file AdminAddHost.cs.

​
◆ PUBLIC_ADDRESS

const string kinetica.AdminAddHostRequest.Options.PUBLIC_ADDRESS = “public_address”
 static

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 75 of file AdminAddHost.cs.

​
◆ RAM_LIMIT

const string kinetica.AdminAddHostRequest.Options.RAM_LIMIT = “ram_limit”
 static

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 95 of file AdminAddHost.cs.

​
◆ TRUE

const string kinetica.AdminAddHostRequest.Options.TRUE = “true”
 static

A boolean constant for the AdminAddHostRequest.Options options.

Definition at line 44 of file AdminAddHost.cs.

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