Skip to main content

​
◆ adminAddHost() [1/2]

AdminAddHostResponse kinetica.Kinetica.adminAddHost (AdminAddHostRequestrequest_)
 inline

Adds a host to an existing cluster.

This method should be used for on-premise deployments only.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 28 of file KineticaFunctions.cs.

​
◆ adminAddHost() [2/2]

AdminAddHostResponse kinetica.Kinetica.adminAddHost (stringhost_address,
IDictionary< string, string >options = null )
 inline

Adds a host to an existing cluster.

This method should be used for on-premise deployments only.

Parameters
host_addressIP 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.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 158 of file KineticaFunctions.cs.

​
◆ AdminAddHostAsync() [1/2]

async System.Threading.Tasks.Task< AdminAddHostResponse > kinetica.Kinetica.AdminAddHostAsync (AdminAddHostRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Adds a host to an existing cluster.

(async)

This method should be used for on-premise deployments only.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 45 of file KineticaFunctions.cs.

​
◆ AdminAddHostAsync() [2/2]

async System.Threading.Tasks.Task< AdminAddHostResponse > kinetica.Kinetica.AdminAddHostAsync (stringhost_address,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Adds a host to an existing cluster.

(async)

This method should be used for on-premise deployments only.

Parameters
host_addressIP 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.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 271 of file KineticaFunctions.cs.