> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AdminAddRanksRequest

> AdminAddRanksRequest — Kinetica JavaScript API

interface AdminAddRanksRequest \{\
&#x20;[config\_params](#config_params): Record\<string, string>\[];\
&#x20;[hosts](#hosts): string\[];\
&#x20;[options](#options)?: Record\<string, string>;\
}

<ul>
  <li>Defined in [src/types.ts:56](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L56)</li>
</ul>

##### Index

### Properties

[config\_params](#config_params) [hosts](#hosts) [options?](#options)&#x20;

## Properties

### config\_params

config\_params: Record\<string, string>\[]

Array of maps containing configuration parameters to apply to the new ranks found in `hosts`. For example, '\{"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by `hosts` instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in `config_params` as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the `hosts`. This array must either be completely empty or have the same number of elements as the `hosts`. An empty `config_params` array will result in the new ranks being set with default parameters.

<ul>
  <li>Defined in [src/types.ts:76](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L76)</li>
</ul>

### hosts

hosts: string\[]

Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use `admin_add_host`. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, `hosts` could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the `config_params`.

<ul>
  <li>Defined in [src/types.ts:58](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L58)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:78](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L78)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.