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

# AdminSwitchoverRequest

> AdminSwitchoverRequest — Kinetica Node.js API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="tsd-signature"><span className="tsd-signature-keyword">interface</span> <span className="tsd-kind-interface">AdminSwitchoverRequest</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#destinations">destinations</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#options">options</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#processes">processes</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /><span className="tsd-signature-symbol">{"}"}</span></div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L432">src/types.ts:432</a></li>
    </ul>
  </div>

  <div className="section tsd-panel-group tsd-index-group">
    <div className="section tsd-panel tsd-index-panel">
      <div className="details tsd-index-content tsd-accordion" open="">
        <div className="summary tsd-accordion-summary tsd-index-summary">
          <h5 className="tsd-index-heading uppercase">Index</h5>
        </div>

        <div className="tsd-accordion-details">
          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#destinations" className="tsd-index-link"><span>destinations</span></a> <a href="#options" className="tsd-index-link"><span>options?</span></a> <a href="#processes" className="tsd-index-link"><span>processes</span></a> </div>
          </div>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="destinations"><span>destinations</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">destinations</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Indicates to which host to switch over each corresponding process given in <code>processes</code>. Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in <code>processes</code>.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L451">src/types.ts:451</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="options"><code className="tsd-tag">Optional</code><span>options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Optional parameters.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L453">src/types.ts:453</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="processes"><span>processes</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">processes</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in <code>destinations</code>.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L442">src/types.ts:442</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>
</div>


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