Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.AdminAddHostRequest.Options Struct Reference

Optional parameters. 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

Optional parameters.

  • DRY_RUN: If set to true, only validation checks will be performed. No host is added. Supported values: The default value is 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. Supported values: The default value is 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.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 103 of file AdminAddHost.cs.

Member Data Documentation

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:

The default value is FALSE.

Definition at line 141 of file AdminAddHost.cs.

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

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

No host is added. Supported values:

The default value is FALSE.

Definition at line 121 of file AdminAddHost.cs.

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

Definition at line 123 of file AdminAddHost.cs.

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

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

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

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

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

Definition at line 122 of file AdminAddHost.cs.

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