<div id="docs-body">
 <div class="section">
  <div class="titlepage">
   <div>
    <div>
     <h4 class="title">
      <a name="keyring-options">
      </a>
      8.4.4.15 Keyring Command Options
     </h4>
    </div>
   </div>
  </div>
  <p>
   MySQL supports the following keyring-related command-line
        options:
  </p>
  <div class="itemizedlist">
   <ul class="itemizedlist" style="list-style-type: disc; ">
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-destination">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-destination">
       <code class="option">
        --keyring-migration-destination=
        <em class="replaceable">
         <code>
          plugin
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239360176">
     </a>
     <a class="indexterm" name="idm46045239358672">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-destination">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-destination=plugin_name
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      The destination keyring plugin or component for key
            migration. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      . The
            option value interpretation depends on whether
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-to-component">
       <code class="option">
        --keyring-migration-to-component
       </code>
      </a>
      or
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-from-component">
       <code class="option">
        --keyring-migration-from-component
       </code>
      </a>
      is specified:
     </p>
     <div class="itemizedlist">
      <ul class="itemizedlist" style="list-style-type: circle; ">
       <li class="listitem">
        <p>
         If
         <code class="option">
          --keyring-migration-to-component
         </code>
         is
                used, the option value is a keyring plugin, interpreted
                the same way as for
         <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-source">
          <code class="option">
           --keyring-migration-source
          </code>
         </a>
         .
        </p>
       </li>
       <li class="listitem">
        <p>
         If
         <code class="option">
          --keyring-migration-to-component
         </code>
         is
                used, the option value is a keyring component, specified
                as the component library name in the plugin directory,
                including any platform-specific extension such as
         <code class="filename">
          .so
         </code>
         or
         <code class="filename">
          .dll
         </code>
         .
        </p>
       </li>
      </ul>
     </div>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-source">
        <code class="option">
         --keyring-migration-source
        </code>
       </a>
       and
       <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-destination">
        <code class="option">
         --keyring-migration-destination
        </code>
       </a>
       are mandatory for all keyring migration operations. The
              source and destination must differ, and the migration
              server must support both.
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-from-component">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-from-component">
       <code class="option">
        --keyring-migration-from-component
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239335280">
     </a>
     <a class="indexterm" name="idm46045239333776">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-from-component">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-from-component[={OFF|ON}]
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Boolean
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           OFF
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Indicates that a key migration is from a keyring component
            to a keyring plugin. This option makes it possible to
            migrate keys from a keyring component to a keyring plugin.
     </p>
     <p>
      For migration from a keyring plugin to a keyring component,
            use the
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-to-component">
       <code class="option">
        --keyring-migration-to-component
       </code>
      </a>
      option. For key migration from one keyring component to
            another, use the
      <a class="link" href="mysql-migrate-keyring.html" title="6.6.8 mysql_migrate_keyring — Keyring Key Migration Utility">
       <span class="command">
        <strong>
         mysql_migrate_keyring
        </strong>
       </span>
      </a>
      utility. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-host">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-host">
       <code class="option">
        --keyring-migration-host=
        <em class="replaceable">
         <code>
          host_name
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239315696">
     </a>
     <a class="indexterm" name="idm46045239314192">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-host">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-host=host_name
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           localhost
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      The host location of the running server that is currently
            using one of the key migration keystores. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      . Migration always
            occurs on the local host, so the option always specifies a
            value for connecting to a local server, such as
      <code class="literal">
       localhost
      </code>
      ,
      <code class="literal">
       127.0.0.1
      </code>
      ,
      <code class="literal">
       ::1
      </code>
      , or the local host IP address or host
            name.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-password">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-password">
       <code class="option">
        --keyring-migration-password[=
        <em class="replaceable">
         <code>
          password
         </code>
        </em>
        ]
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239296400">
     </a>
     <a class="indexterm" name="idm46045239294896">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-password">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-password[=password]
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      The password of the MySQL account used for connecting to the
            running server that is currently using one of the key
            migration keystores. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
     <p>
      The password value is optional. If not given, the server
            prompts for one. If given, there must be
      <span class="emphasis">
       <em>
        no
            space
       </em>
      </span>
      between
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-password">
       <code class="option">
        --keyring-migration-password=
       </code>
      </a>
      and the password following it. If no password option is
            specified, the default is to send no password.
     </p>
     <p>
      Specifying a password on the command line should be
            considered insecure. See
      <a class="xref" href="password-security-user.html" title="8.1.2.1 End-User Guidelines for Password Security">
       Section 8.1.2.1, “End-User Guidelines for Password Security”
      </a>
      . You can use an
            option file to avoid giving the password on the command
            line. In this case, the file should have a restrictive mode
            and be accessible only to the account used to run the
            migration server.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-port">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-port">
       <code class="option">
        --keyring-migration-port=
        <em class="replaceable">
         <code>
          port_num
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239278528">
     </a>
     <a class="indexterm" name="idm46045239277024">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-port">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-port=port_num
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Numeric
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           3306
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      For TCP/IP connections, the port number for connecting to
            the running server that is currently using one of the key
            migration keystores. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-socket">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-socket">
       <code class="option">
        --keyring-migration-socket=
        <em class="replaceable">
         <code>
          path
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239261728">
     </a>
     <a class="indexterm" name="idm46045239260224">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-socket">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-socket={file_name|pipe_name}
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      For Unix socket file or Windows named pipe connections, the
            socket file or named pipe for connecting to the running
            server that is currently using one of the key migration
            keystores. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-source">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-source">
       <code class="option">
        --keyring-migration-source=
        <em class="replaceable">
         <code>
          plugin
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239247312">
     </a>
     <a class="indexterm" name="idm46045239245808">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-source">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-source=plugin_name
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      The source keyring plugin for key migration. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
     <p>
      The option value is similar to that for
      <a class="link" href="server-options.html#option_mysqld_plugin-load">
       <code class="option">
        --plugin-load
       </code>
      </a>
      , except that
            only one plugin library can be specified. The value is given
            as
      <em class="replaceable">
       <code>
        plugin_library
       </code>
      </em>
      or
      <em class="replaceable">
       <code>
        name
       </code>
      </em>
      <code class="literal">
       =
      </code>
      <em class="replaceable">
       <code>
        plugin_library
       </code>
      </em>
      ,
            where
      <em class="replaceable">
       <code>
        plugin_library
       </code>
      </em>
      is the name
            of a library file that contains plugin code, and
      <em class="replaceable">
       <code>
        name
       </code>
      </em>
      is the name of a plugin to
            load. If a plugin library is named without any preceding
            plugin name, the server loads all plugins in the library.
            With a preceding plugin name, the server loads only the
            named plugin from the library. The server looks for plugin
            library files in the directory named by the
      <a class="link" href="server-system-variables.html#sysvar_plugin_dir">
       <code class="literal">
        plugin_dir
       </code>
      </a>
      system variable.
     </p>
     <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
      <div class="admon-title">
       Note
      </div>
      <p>
       <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-source">
        <code class="option">
         --keyring-migration-source
        </code>
       </a>
       and
       <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-destination">
        <code class="option">
         --keyring-migration-destination
        </code>
       </a>
       are mandatory for all keyring migration operations. The
              source and destination plugins must differ, and the
              migration server must support both plugins.
      </p>
     </div>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-to-component">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-to-component">
       <code class="option">
        --keyring-migration-to-component
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239224464">
     </a>
     <a class="indexterm" name="idm46045239222960">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-to-component">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-to-component[={OFF|ON}]
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          Boolean
         </td>
        </tr>
        <tr>
         <th>
          Default Value
         </th>
         <td>
          <code class="literal">
           OFF
          </code>
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      Indicates that a key migration is from a keyring plugin to a
            keyring component. This option makes it possible to migrate
            keys from a keyring plugin to a keyring component.
     </p>
     <p>
      For migration from a keyring component to a keyring plugin,
            use the
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-from-component">
       <code class="option">
        --keyring-migration-from-component
       </code>
      </a>
      option. For key migration from one keyring component to
            another, use the
      <a class="link" href="mysql-migrate-keyring.html" title="6.6.8 mysql_migrate_keyring — Keyring Key Migration Utility">
       <span class="command">
        <strong>
         mysql_migrate_keyring
        </strong>
       </span>
      </a>
      utility. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
    </li>
    <li class="listitem">
     <p>
      <a name="option_mysqld_keyring-migration-user">
      </a>
      <a class="link" href="keyring-options.html#option_mysqld_keyring-migration-user">
       <code class="option">
        --keyring-migration-user=
        <em class="replaceable">
         <code>
          user_name
         </code>
        </em>
       </code>
      </a>
     </p>
     <a class="indexterm" name="idm46045239204816">
     </a>
     <a class="indexterm" name="idm46045239203312">
     </a>
     <div class="informaltable">
      <table frame="box" rules="all" summary="Properties for keyring-migration-user">
       <colgroup>
        <col style="width: 30%"/>
        <col style="width: 70%"/>
       </colgroup>
       <tbody>
        <tr>
         <th>
          Command-Line Format
         </th>
         <td>
          <code class="literal">
           --keyring-migration-user=user_name
          </code>
         </td>
        </tr>
        <tr>
         <th>
          Type
         </th>
         <td>
          String
         </td>
        </tr>
       </tbody>
      </table>
     </div>
     <p>
      The user name of the MySQL account used for connecting to
            the running server that is currently using one of the key
            migration keystores. See
      <a class="xref" href="keyring-key-migration.html" title="8.4.4.11 Migrating Keys Between Keyring Keystores">
       Section 8.4.4.11, “Migrating Keys Between Keyring Keystores”
      </a>
      .
     </p>
    </li>
   </ul>
  </div>
 </div>
 <br/>
</div>
