> ## 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.

# admin_alter_host

### admin\_alter\_host

<ul>
  <li>
    admin\_alter\_host(\
    &#x20;host: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminAlterHostResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostResponse.md)>

    Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.

    #### Parameters

    <ul>
      <li>
        host: string

        Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminAlterHostResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostResponse.md)>

    Promise\<Types.AdminAlterHostResponse> - Promise resolving to the response

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

### admin\_alter\_host\_request

<ul>
  <li>
    admin\_alter\_host\_request(\
    &#x20;request: [AdminAlterHostRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminAlterHostResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostResponse.md)>

    Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.

    #### Parameters

    <ul>
      <li>
        request: [AdminAlterHostRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminAlterHostResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminAlterHostResponse.md)>

    Promise\<Types.AdminAlterHostResponse> - Promise resolving to the response

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


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