<div id="docs-body">
 <div class="section">
  <div class="titlepage">
   <div>
    <div>
     <h3 class="title">
      <a name="mysql-cluster-programs-ndbxfrm">
      </a>
      25.5.32 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt
Files Created by NDB Cluster
     </h3>
    </div>
   </div>
  </div>
  <a class="indexterm" name="idm46045095072560">
  </a>
  <p>
   The
   <a class="link" href="mysql-cluster-programs-ndbxfrm.html" title="25.5.32 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt Files Created by NDB Cluster">
    <span class="command">
     <strong>
      ndbxfrm
     </strong>
    </span>
   </a>
   utility can be used to
        decompress, decrypt, and output information about files created
        by NDB Cluster that are compressed, encrypted, or both. It can
        also be used to compress or encrypt files.
  </p>
  <p>
  </p>
  <h4>
   <a name="idm46045095069040">
   </a>
   Usage
  </h4>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting language-terminal"><div class="docs-select-all right" id="sa39489309"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal">ndbxfrm <span class="token property">--info</span> <em class="replaceable">file</em><span class="token punctuation">[</span> <em class="replaceable">file</em> <span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">]</span>

ndbxfrm <span class="token property">--compress</span> <em class="replaceable">input_file</em> <em class="replaceable">output_file</em>

ndbxfrm <span class="token constant">--decrypt-password</span><span class="token attr-value"><span class="token punctuation">=</span><em class="replaceable">password</em></span> <em class="replaceable">input_file</em> <em class="replaceable">output_file</em>

ndbxfrm <span class="token punctuation">[</span><span class="token constant">--encrypt-ldf-iter-count</span><span class="token attr-value"><span class="token punctuation">=</span>#<span class="token punctuation">]</span></span> <span class="token constant">--encrypt-password</span><span class="token attr-value"><span class="token punctuation">=</span><em class="replaceable">password</em></span> <em class="replaceable">input_file</em> <em class="replaceable">output_file</em></code></pre>
  </div>
  <p>
   <em class="replaceable">
    <code>
     input_file
    </code>
   </em>
   and
   <em class="replaceable">
    <code>
     output_file
    </code>
   </em>
   cannot be the same file.
  </p>
  <h4>
   <a name="idm46045095061760">
   </a>
   Options
  </h4>
  <div class="itemizedlist">
   <ul class="itemizedlist" style="list-style-type: disc; ">
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_compress">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_compress">
       <code class="option">
        --compress
       </code>
      </a>
      ,
      <code class="option">
       -c
      </code>
     </p>
     <a class="indexterm" name="idm46045095058352">
     </a>
     <a class="indexterm" name="idm46045095056864">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for compress">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --compress
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Compresses the input file, using the same compression method
            as is used for compressing NDB Cluster backups, and writes
            the output to an output file. To decompress a compressed
      <code class="literal">
       NDB
      </code>
      backup file that is not encrypted, it
            is necessary only to invoke
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html" title="25.5.32 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt Files Created by NDB Cluster">
       <span class="command">
        <strong>
         ndbxfrm
        </strong>
       </span>
      </a>
      using
            the names of the compressed file and an output file (with no
            options required).
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_decrypt-key">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-key">
       <code class="option">
        --decrypt-key=
        <em class="replaceable">
         <code>
          key
         </code>
        </em>
       </code>
      </a>
      ,
      <code class="option">
       -K
      </code>
      <em class="replaceable">
       <code>
        key
       </code>
      </em>
     </p>
     <a class="indexterm" name="idm46045095043776">
     </a>
     <a class="indexterm" name="idm46045095042288">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for decrypt-key">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --decrypt-key=key
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Decrypts a file encrypted by
      <code class="literal">
       NDB
      </code>
      using
            the supplied key.
     </p>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       This option cannot be used together with
       <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-password">
        <code class="option">
         --decrypt-password
        </code>
       </a>
       .
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_decrypt-key-from-stdin">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-key-from-stdin">
       <code class="option">
        --decrypt-key-from-stdin
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045095029888">
     </a>
     <a class="indexterm" name="idm46045095028384">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for decrypt-key-from-stdin">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --decrypt-key-from-stdin
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Decrypts a file encrypted by
      <code class="literal">
       NDB
      </code>
      using
            the key supplied from
      <code class="literal">
       stdin
      </code>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_decrypt-password">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-password">
       <code class="option">
        --decrypt-password=
        <em class="replaceable">
         <code>
          password
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045095016992">
     </a>
     <a class="indexterm" name="idm46045095015504">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for decrypt-password">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --decrypt-password=password
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Decrypts a file encrypted by
      <code class="literal">
       NDB
      </code>
      using
            the password supplied.
     </p>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       This option cannot be used together with
       <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-key">
        <code class="option">
         --decrypt-key
        </code>
       </a>
       .
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_decrypt-password-from-stdin">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-password-from-stdin">
       <code class="option">
        --decrypt-password-from-stdin[=TRUE|FALSE]
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094998560">
     </a>
     <a class="indexterm" name="idm46045094997056">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for decrypt-password-from-stdin">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --decrypt-password-from-stdin
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Decrypts a file encrypted by
      <code class="literal">
       NDB
      </code>
      , using a
            password supplied from standard input. This is similar to
            entering a password after invoking
      <a class="link" href="mysql.html" title="6.5.1 mysql — The MySQL Command-Line Client">
       <span class="command">
        <strong>
         mysql
        </strong>
       </span>
      </a>
      <a class="link" href="mysql-command-options.html#option_mysql_password">
       <code class="option">
        --password
       </code>
      </a>
      with no password
            following the option.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_defaults-extra-file">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_defaults-extra-file">
       <code class="option">
        --defaults-extra-file
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094984240">
     </a>
     <a class="indexterm" name="idm46045094982784">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-extra-file">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-extra-file=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read given file after global files are read.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_defaults-file">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_defaults-file">
       <code class="option">
        --defaults-file
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094968496">
     </a>
     <a class="indexterm" name="idm46045094967008">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-file">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-file=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read default options from given file only.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_defaults-group-suffix">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_defaults-group-suffix">
       <code class="option">
        --defaults-group-suffix
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094952736">
     </a>
     <a class="indexterm" name="idm46045094951280">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for defaults-group-suffix">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --defaults-group-suffix=string
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Also read groups with
      <code class="literal">
       CONCAT(
       <em class="replaceable">
        <code>
         group
        </code>
       </em>
       ,
       <em class="replaceable">
        <code>
         suffix
        </code>
       </em>
       )
      </code>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_detailed-info">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_detailed-info">
       <code class="option">
        --detailed-info
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094935360">
     </a>
     <a class="indexterm" name="idm46045094933872">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for detailed-info">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-block-size=#
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Boolean
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           FALSE
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Print out file information like
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_info">
       <code class="option">
        --info
       </code>
      </a>
      , but include the
            file's header and trailer.
     </p>
     <p>
      Example:
     </p>
     <div class="copytoclipboard-wrapper">
      <pre class="programlisting language-simple"><div class="docs-select-all right" id="sa90998230"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-simple">$<span class="token operator">&gt;</span> ndbxfrm <span class="token operator">--</span>detailed<span class="token operator">-</span>info S0<span class="token punctuation">.</span>sysfile
File<span class="token operator">=</span><span class="token operator">/</span>var<span class="token operator">/</span>lib<span class="token operator">/</span>cluster<span class="token operator">-</span>data<span class="token operator">/</span>ndb_7_fs<span class="token operator">/</span>D1<span class="token operator">/</span>NDBCNTR<span class="token operator">/</span>S0<span class="token punctuation">.</span>sysfile<span class="token punctuation">,</span> compression<span class="token operator">=</span>no<span class="token punctuation">,</span> encryption<span class="token operator">=</span>yes
header<span class="token operator">:</span> <span class="token punctuation">{</span>
  fixed_header<span class="token operator">:</span> <span class="token punctuation">{</span>
    magic<span class="token operator">:</span> <span class="token punctuation">{</span>
      magic<span class="token operator">:</span> <span class="token punctuation">{</span> 78<span class="token punctuation">,</span> 68<span class="token punctuation">,</span> 66<span class="token punctuation">,</span> 88<span class="token punctuation">,</span> 70<span class="token punctuation">,</span> 82<span class="token punctuation">,</span> 77<span class="token punctuation">,</span> 49 <span class="token punctuation">}</span><span class="token punctuation">,</span>
      endian<span class="token operator">:</span> 18364758544493064720<span class="token punctuation">,</span>
      header_size<span class="token operator">:</span> 32768<span class="token punctuation">,</span>
      fixed_header_size<span class="token operator">:</span> 160<span class="token punctuation">,</span>
      zeros<span class="token operator">:</span> <span class="token punctuation">{</span> 0<span class="token punctuation">,</span> 0 <span class="token punctuation">}</span>
    <span class="token punctuation">}</span><span class="token punctuation">,</span>
    flags<span class="token operator">:</span> 73728<span class="token punctuation">,</span>
    flag_extended<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_zeros<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_file_checksum<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_data_checksum<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_compress<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_compress_method<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_compress_padding<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_encrypt<span class="token operator">:</span> 18<span class="token punctuation">,</span>
    flag_encrypt_cipher<span class="token operator">:</span> 2<span class="token punctuation">,</span>
    flag_encrypt_krm<span class="token operator">:</span> 1<span class="token punctuation">,</span>
    flag_encrypt_padding<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_encrypt_key_selection_mode<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    dbg_writer_ndb_version<span class="token operator">:</span> 524320<span class="token punctuation">,</span>
    octets_size<span class="token operator">:</span> 32<span class="token punctuation">,</span>
    file_block_size<span class="token operator">:</span> 32768<span class="token punctuation">,</span>
    trailer_max_size<span class="token operator">:</span> 80<span class="token punctuation">,</span>
    file_checksum<span class="token operator">:</span> <span class="token punctuation">{</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    data_checksum<span class="token operator">:</span> <span class="token punctuation">{</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    zeros01<span class="token operator">:</span> <span class="token punctuation">{</span> 0 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    compress_dbg_writer_header_version<span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
    compress_dbg_writer_library_version<span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
    encrypt_dbg_writer_header_version<span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
    encrypt_dbg_writer_library_version<span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
    encrypt_key_definition_iterator_count<span class="token operator">:</span> 100000<span class="token punctuation">,</span>
    encrypt_krm_keying_material_size<span class="token operator">:</span> 32<span class="token punctuation">,</span>
    encrypt_krm_keying_material_count<span class="token operator">:</span> 1<span class="token punctuation">,</span>
    encrypt_key_data_unit_size<span class="token operator">:</span> 32768<span class="token punctuation">,</span>
    encrypt_krm_keying_material_position_in_octets<span class="token operator">:</span> 0<span class="token punctuation">,</span>
  <span class="token punctuation">}</span><span class="token punctuation">,</span>
  octets<span class="token operator">:</span> <span class="token punctuation">{</span>
     102<span class="token punctuation">,</span> 68<span class="token punctuation">,</span> 56<span class="token punctuation">,</span> 125<span class="token punctuation">,</span> 78<span class="token punctuation">,</span> 217<span class="token punctuation">,</span> 110<span class="token punctuation">,</span> 94<span class="token punctuation">,</span> 145<span class="token punctuation">,</span> 121<span class="token punctuation">,</span> 203<span class="token punctuation">,</span> 234<span class="token punctuation">,</span> 26<span class="token punctuation">,</span> 164<span class="token punctuation">,</span> 137<span class="token punctuation">,</span> 180<span class="token punctuation">,</span>
     100<span class="token punctuation">,</span> 224<span class="token punctuation">,</span> 7<span class="token punctuation">,</span> 88<span class="token punctuation">,</span> 173<span class="token punctuation">,</span> 123<span class="token punctuation">,</span> 209<span class="token punctuation">,</span> 110<span class="token punctuation">,</span> 185<span class="token punctuation">,</span> 227<span class="token punctuation">,</span> 85<span class="token punctuation">,</span> 174<span class="token punctuation">,</span> 109<span class="token punctuation">,</span> 123<span class="token punctuation">,</span> 96<span class="token punctuation">,</span> 156<span class="token punctuation">,</span>
  <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
trailer<span class="token operator">:</span> <span class="token punctuation">{</span>
  fixed_trailer<span class="token operator">:</span> <span class="token punctuation">{</span>
    flags<span class="token operator">:</span> 48<span class="token punctuation">,</span>
    flag_extended<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_zeros<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_file_checksum<span class="token operator">:</span> 0<span class="token punctuation">,</span>
    flag_data_checksum<span class="token operator">:</span> 3<span class="token punctuation">,</span>
    data_size<span class="token operator">:</span> 512<span class="token punctuation">,</span>
    file_checksum<span class="token operator">:</span> <span class="token punctuation">{</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0<span class="token punctuation">,</span> 0 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    data_checksum<span class="token operator">:</span> <span class="token punctuation">{</span> 226<span class="token punctuation">,</span> 223<span class="token punctuation">,</span> 102<span class="token punctuation">,</span> 207 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    magic<span class="token operator">:</span> <span class="token punctuation">{</span>
      zeros<span class="token operator">:</span> <span class="token punctuation">{</span> 0<span class="token punctuation">,</span> 0 <span class="token punctuation">}</span>
      fixed_trailer_size<span class="token operator">:</span> 56<span class="token punctuation">,</span>
      trailer_size<span class="token operator">:</span> 32256<span class="token punctuation">,</span>
      endian<span class="token operator">:</span> 18364758544493064720<span class="token punctuation">,</span>
      magic<span class="token operator">:</span> <span class="token punctuation">{</span> 78<span class="token punctuation">,</span> 68<span class="token punctuation">,</span> 66<span class="token punctuation">,</span> 88<span class="token punctuation">,</span> 70<span class="token punctuation">,</span> 82<span class="token punctuation">,</span> 77<span class="token punctuation">,</span> 49 <span class="token punctuation">}</span><span class="token punctuation">,</span>
    <span class="token punctuation">}</span><span class="token punctuation">,</span>
  <span class="token punctuation">}</span>
<span class="token punctuation">}</span></code></pre>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-block-size">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-block-size">
       <code class="option">
        --encrypt-block-size=
        <em class="replaceable">
         <code>
          #
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094914560">
     </a>
     <a class="indexterm" name="idm46045094913104">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-block-size">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-block-size=#
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Integer
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           0
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Minimum Value
         </th>
         <td>
          <code class="literal">
           0
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Maximum Value
         </th>
         <td>
          <code class="literal">
           2147483647
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Size of input data chunks that are encrypted as a unit. Used
            with XTS; set to
      <code class="literal">
       0
      </code>
      (the default) for CBC
            mode.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-cipher">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-cipher">
       <code class="option">
        --encrypt-cipher=
        <em class="replaceable">
         <code>
          #
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094892928">
     </a>
     <a class="indexterm" name="idm46045094891440">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-cipher">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-cipher=#
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Integer
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           1
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Minimum Value
         </th>
         <td>
          <code class="literal">
           0
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Maximum Value
         </th>
         <td>
          <code class="literal">
           2147483647
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Cipher used for encryption. Set to
      <code class="literal">
       1
      </code>
      for
            CBC mode (the default), or
      <code class="literal">
       2
      </code>
      for XTS.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-kdf-iter-count">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-kdf-iter-count">
       <code class="option">
        --encrypt-kdf-iter-count=
        <em class="replaceable">
         <code>
          #
         </code>
        </em>
       </code>
      </a>
      ,
      <code class="option">
       -k
       <em class="replaceable">
        <code>
         #
        </code>
       </em>
      </code>
     </p>
     <a class="indexterm" name="idm46045094870048">
     </a>
     <a class="indexterm" name="idm46045094868544">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-kdf-iter-count">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-kdf-iter-count=#
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Integer
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           0
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Minimum Value
         </th>
         <td>
          <code class="literal">
           0
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Maximum Value
         </th>
         <td>
          <code class="literal">
           2147483647
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      When encrypting a file, specifies the number of iterations
            to use for the encryption key. Requires the
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-password">
       <code class="option">
        --encrypt-password
       </code>
      </a>
      option.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-key">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-key">
       <code class="option">
        --encrypt-key=
        <em class="replaceable">
         <code>
          key
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094847920">
     </a>
     <a class="indexterm" name="idm46045094846432">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-key">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-key=key
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Encrypts a file using the supplied key.
     </p>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       This option cannot be used together with
       <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-password">
        <code class="option">
         --encrypt-password
        </code>
       </a>
       .
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-key-from-stdin">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-key-from-stdin">
       <code class="option">
        --encrypt-key-from-stdin
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094834848">
     </a>
     <a class="indexterm" name="idm46045094833344">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-key-from-stdin">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-key-from-stdin
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Encrypt a file using the key supplied from
      <code class="literal">
       stdin
      </code>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-password">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-password">
       <code class="option">
        --encrypt-password=
        <em class="replaceable">
         <code>
          password
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094822656">
     </a>
     <a class="indexterm" name="idm46045094821168">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-password">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-password=password
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Encrypts the backup file using the password supplied by the
            option. The password must meet the requirements listed here:
     </p>
     <div class="itemizedlist">
      <ul class="itemizedlist" style="list-style-type: circle; ">
       <li class="listitem">
        <p>
         Uses any of the printable ASCII characters except
         <code class="literal">
          !
         </code>
         ,
         <code class="literal">
          '
         </code>
         ,
         <code class="literal">
          "
         </code>
         ,
         <code class="literal">
          $
         </code>
         ,
         <code class="literal">
          %
         </code>
         ,
         <code class="literal">
          \
         </code>
         ,
         <code class="literal">
          `
         </code>
         , and
         <code class="literal">
          ^
         </code>
        </p>
       </li>
       <li class="listitem">
        <p>
         Is no more than 256 characters in length
        </p>
       </li>
       <li class="listitem">
        <p>
         Is enclosed by single or double quotation marks
        </p>
       </li>
      </ul>
     </div>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       This option cannot be used together with
       <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-key">
        <code class="option">
         --encrypt-key
        </code>
       </a>
       .
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_encrypt-password-from-stdin">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-password-from-stdin">
       <code class="option">
        --encrypt-password-from-stdin[=TRUE|FALSE]
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094796608">
     </a>
     <a class="indexterm" name="idm46045094795104">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for encrypt-password-from-stdin">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --encrypt-password-from-stdin
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Encrypts a file using a password supplied from standard
            input. This is similar to entering a password is entered
            after invoking
      <a class="link" href="mysql.html" title="6.5.1 mysql — The MySQL Command-Line Client">
       <span class="command">
        <strong>
         mysql
        </strong>
       </span>
      </a>
      <a class="link" href="mysql-command-options.html#option_mysql_password">
       <code class="option">
        --password
       </code>
      </a>
      with no password
            following the option.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_help">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_help">
       <code class="option">
        --help
       </code>
      </a>
      ,
      <code class="option">
       -?
      </code>
     </p>
     <a class="indexterm" name="idm46045094782720">
     </a>
     <a class="indexterm" name="idm46045094781232">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for help">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --help
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Prints usage information for the program.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_info">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_info">
       <code class="option">
        --info
       </code>
      </a>
      ,
      <code class="option">
       -i
      </code>
     </p>
     <a class="indexterm" name="idm46045094771328">
     </a>
     <a class="indexterm" name="idm46045094769840">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for info">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --info
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Prints the following information about one or more input
            files:
     </p>
     <div class="itemizedlist">
      <ul class="itemizedlist" style="list-style-type: circle; ">
       <li class="listitem">
        <p>
         The name of the file
        </p>
       </li>
       <li class="listitem">
        <p>
         Whether the file is compressed
                (
         <code class="literal">
          compression=yes
         </code>
         or
         <code class="literal">
          compression=no
         </code>
         )
        </p>
       </li>
       <li class="listitem">
        <p>
         Whether the file is encrypted
                (
         <code class="literal">
          encryption=yes
         </code>
         or
         <code class="literal">
          encryption=no
         </code>
         )
        </p>
       </li>
      </ul>
     </div>
     <p>
      Example:
     </p>
     <div class="copytoclipboard-wrapper">
      <pre class="programlisting language-terminal"><div class="docs-select-all right" id="sa38042283"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal"><span class="token prompt">$&gt; </span><span class="token command">ndbxfrm</span> <span class="token property">-i</span> BACKUP-10-0<span class="token punctuation">.</span>5<span class="token punctuation">.</span>Data BACKUP-10<span class="token punctuation">.</span>5<span class="token punctuation">.</span>ctl BACKUP-10<span class="token punctuation">.</span>5<span class="token punctuation">.</span>log
File<span class="token attr-value"><span class="token punctuation">=</span>BACKUP-10-0.5.Data,</span> compression<span class="token attr-value"><span class="token punctuation">=</span>no,</span> encryption<span class="token attr-value"><span class="token punctuation">=</span>yes</span>
File<span class="token attr-value"><span class="token punctuation">=</span>BACKUP-10.5.ctl,</span> compression<span class="token attr-value"><span class="token punctuation">=</span>no,</span> encryption<span class="token attr-value"><span class="token punctuation">=</span>yes</span>
File<span class="token attr-value"><span class="token punctuation">=</span>BACKUP-10.5.log,</span> compression<span class="token attr-value"><span class="token punctuation">=</span>no,</span> encryption<span class="token attr-value"><span class="token punctuation">=</span>yes</span></code></pre>
     </div>
     <p>
      You can also see the file's header and trailer using
            the
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_detailed-info">
       <code class="option">
        --detailed-info
       </code>
      </a>
      option.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_login-path">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_login-path">
       <code class="option">
        --login-path
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094750544">
     </a>
     <a class="indexterm" name="idm46045094749056">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for login-path">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --login-path=path
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           [none]
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Read given path from login file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_no-login-paths">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_no-login-paths">
       <code class="option">
        --no-login-paths
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094734784">
     </a>
     <a class="indexterm" name="idm46045094733296">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for no-login-paths">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --no-login-paths
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Skips reading options from the login path file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_no-defaults">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_no-defaults">
       <code class="option">
        --no-defaults
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094723584">
     </a>
     <a class="indexterm" name="idm46045094722096">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for no-defaults">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --no-defaults
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Do not read default options from any option file other than
            login file.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_print-defaults">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_print-defaults">
       <code class="option">
        --print-defaults
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045094712272">
     </a>
     <a class="indexterm" name="idm46045094710784">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for print-defaults">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --print-defaults
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Print program argument list and exit.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_usage">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_usage">
       <code class="option">
        --usage
       </code>
      </a>
      ,
      <code class="option">
       -?
      </code>
     </p>
     <a class="indexterm" name="idm46045094700800">
     </a>
     <a class="indexterm" name="idm46045094699312">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for usage">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --usage
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Synonym for
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_help">
       <code class="option">
        --help
       </code>
      </a>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_ndbxfrm_version">
      </a>
      <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_version">
       <code class="option">
        --version
       </code>
      </a>
      ,
      <code class="option">
       -V
      </code>
     </p>
     <a class="indexterm" name="idm46045094688336">
     </a>
     <a class="indexterm" name="idm46045094686848">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for version">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --version
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Prints out version information.
     </p>
    </li>
   </ul>
  </div>
  <p>
   <a class="link" href="mysql-cluster-programs-ndbxfrm.html" title="25.5.32 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt Files Created by NDB Cluster">
    <span class="command">
     <strong>
      ndbxfrm
     </strong>
    </span>
   </a>
   can encrypt backups created by any
        version of NDB Cluster. The
   <code class="filename">
    .Data
   </code>
   ,
   <code class="filename">
    .ctl
   </code>
   , and
   <code class="filename">
    .log
   </code>
   files
        comprising the backup must be encrypted separately, and these
        files must be encrypted separately for each data node. Once
        encrypted, such backups can be decrypted only by
   <a class="link" href="mysql-cluster-programs-ndbxfrm.html" title="25.5.32 ndbxfrm — Compress, Decompress, Encrypt, and Decrypt Files Created by NDB Cluster">
    <span class="command">
     <strong>
      ndbxfrm
     </strong>
    </span>
   </a>
   ,
   <a class="link" href="mysql-cluster-programs-ndb-restore.html" title="25.5.23 ndb_restore — Restore an NDB Cluster Backup">
    <span class="command">
     <strong>
      ndb_restore
     </strong>
    </span>
   </a>
   , or
   <span class="command">
    <strong>
     ndb_print_backup
    </strong>
   </span>
   .
  </p>
  <p>
   An encrypted file can be re-encrypted with a new password using
        the
   <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_encrypt-password">
    <code class="option">
     --encrypt-password
    </code>
   </a>
   and
   <a class="link" href="mysql-cluster-programs-ndbxfrm.html#option_ndbxfrm_decrypt-password">
    <code class="option">
     --decrypt-password
    </code>
   </a>
   options
        together, like this:
  </p>
  <div class="copytoclipboard-wrapper">
   <pre class="programlisting one-line language-terminal"><div class="docs-select-all right" id="sa43389308"><div class="copy-help left">Press ⌘+C to copy</div> <div class="right"><button class="clipboard-btn" title="Copy to Clipboard"><span class="icon-clipboard"></span></button></div></div><code class="language-terminal">ndbxfrm <span class="token constant">--decrypt-password</span><span class="token attr-value"><span class="token punctuation">=</span><em class="replaceable">old</em></span> <span class="token constant">--encrypt-password</span><span class="token attr-value"><span class="token punctuation">=</span><em class="replaceable">new</em></span> <em class="replaceable">input_file</em> <em class="replaceable">output_file</em></code></pre>
  </div>
  <p>
   In the example just shown,
   <em class="replaceable">
    <code>
     old
    </code>
   </em>
   and
   <em class="replaceable">
    <code>
     new
    </code>
   </em>
   are the old and new passwords,
        respectively; both of these must be quoted. The input file is
        decrypted and then encrypted as the output file. The input file
        itself is not changed; if you do not want it to be accessible
        using the old password, you must remove the input file manually.
  </p>
 </div>
 <br/>
</div>
