kinetica.AdminAddHostRequest Class Reference

A set of parameters for Kinetica.adminAddHost(string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AdminAddHostRequest:

Collaboration diagram for kinetica.AdminAddHostRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	AdminAddHostRequest ()
	Constructs an AdminAddHostRequest object with default parameters. More...
	AdminAddHostRequest (string host_address, IDictionary< string, string > options=null)
	Constructs an AdminAddHostRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	host_address [get, set]
	IP address of the host that will be added to the cluster. More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.adminAddHost(string,IDictionary{string, string}).

Adds a host to an existing cluster.

Definition at line 18 of file AdminAddHost.cs.

Constructor & Destructor Documentation

kinetica.AdminAddHostRequest.AdminAddHostRequest ( )

inline

Constructs an AdminAddHostRequest object with default parameters.

Definition at line 263 of file AdminAddHost.cs.

kinetica.AdminAddHostRequest.AdminAddHostRequest ( string  host_address, IDictionary< string, string >  options = null  )

inline

Constructs an AdminAddHostRequest object with the specified parameters.

Parameters

host_address

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.

options

Optional parameters. DRY_RUN: If set to true, only validation checks will be performed. No host is added. Supported values: TRUE FALSE 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: TRUE FALSE 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.

Definition at line 353 of file AdminAddHost.cs.

Property Documentation

string kinetica.AdminAddHostRequest.host_address

getset

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.

Definition at line 176 of file AdminAddHost.cs.

IDictionary<string, string> kinetica.AdminAddHostRequest.options

getset

Optional parameters.

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

Definition at line 258 of file AdminAddHost.cs.

---

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

• Kinetica/Protocol/AdminAddHost.cs