A set of parameters for Kinetica.adminAddHost. More…
Inheritance diagram for kinetica.AdminAddHostRequest:
[legend]
Collaboration diagram for kinetica.AdminAddHostRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter AdminAddHostRequest.options. More… | |
Public Member Functions | |
| AdminAddHostRequest () | |
| Constructs an AdminAddHostRequest object with default parameters. | |
| AdminAddHostRequest (string host_address, IDictionary< string, string > options=null) | |
| Constructs an AdminAddHostRequest object with the specified parameters. | |
| AdminAddHostRequest () | |
| Constructs an AdminAddHostRequest object with default parameters. | |
| AdminAddHostRequest (string host_address, IDictionary< string, string > options=null) | |
| Constructs an AdminAddHostRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | host_address [get, set] |
| IP address of the host that will be added to the cluster. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.adminAddHost.
Adds a host to an existing cluster.
Definition at line 15 of file AdminAddHost.cs.
Constructor & Destructor Documentation
◆ AdminAddHostRequest() [1/4]
| inline |
Constructs an AdminAddHostRequest object with default parameters.
Definition at line 210 of file AdminAddHost.cs.
◆ AdminAddHostRequest() [2/4]
| 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.
|
Definition at line 314 of file AdminAddHost.cs.
◆ AdminAddHostRequest() [3/4]
| inline |
Constructs an AdminAddHostRequest object with default parameters.
Definition at line 210 of file AdminAddHost.cs.
◆ AdminAddHostRequest() [4/4]
| 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.
|
Definition at line 314 of file AdminAddHost.cs.
Property Documentation
◆ 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 108 of file AdminAddHost.cs.
◆ options
| getset |
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.
Definition at line 206 of file AdminAddHost.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AdminAddHost.cs
- Kinetica/Protocol/AdminAddHost.cs