OS Manuals

/usr/bin/mysql_migrate_keyring

The MySQL open source relational database

From mysql-9.6 9.6.1-r14 (enterprise-packages), captured 2026-11-08 by running mysql_migrate_keyring --help (exit 0). permalink

/usr/bin/mysql_migrate_keyring  Ver 9.6.1 for Linux on x86_64 (Source distribution)
Copyright (c) 2021, 2026, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

MySQL Keyring Migration Utility
Usage: /usr/bin/mysql_migrate_keyring [OPTIONS]
  -?, --help          Display this help and exit.
  -V, --version       Output version information and exit.
  --component-dir=name
                      Directory for components/plugins.
  --source-keyring=name
                      Source keyring name (without extension)
  --source-keyring-configuration-dir=name
                      Source keyring configuration directory
  --destination-keyring=name
                      Destination keyring component name (without extension)
  --destination-keyring-configuration-dir=name
                      Destination keyring configuration directory
  --online-migration  Signal the utility that source of migration is an active
                      server
  -h, --host=name     Connect to host.
  -P, --port=#        Port number to use for connection or 0 for default to, in
                      order of preference, my.cnf, $MYSQL_TCP_PORT,
                      /etc/services, built-in default (3306).
  -S, --socket=name   The socket file to use for connection.
  -u, --user=name     User for login if not current user.
  -p, --password[=name]
                      Password to use when connecting to server. If password is
                      not given it's asked from the tty.
  --ssl-mode=name     SSL connection mode.
  --ssl-ca=name       CA file in PEM format.
  --ssl-capath=name   CA directory.
  --ssl-cert=name     X509 cert in PEM format.
  --ssl-cipher=name   SSL cipher to use.
  --ssl-key=name      X509 key in PEM format.
  --ssl-crl=name      Certificate revocation list.
  --ssl-crlpath=name  Certificate revocation list path.
  --tls-version=name  TLS version to use, permitted values are: TLSv1.2,
                      TLSv1.3
  --ssl-fips-mode=name
                      SSL FIPS mode (applies only for OpenSSL); permitted
                      values are: OFF, ON, STRICT
  --tls-ciphersuites=name
                      TLS v1.3 cipher to use.
  --ssl-session-data=name
                      Session data file to use to enable ssl session reuse
  --ssl-session-data-continue-on-failed-reuse
                      If set to ON, this option will allow connection to
                      succeed even if session data cannot be reused.
  --tls-sni-servername=name
                      The SNI server name to pass to server
  --server-public-key-path=name
                      File path to the server public RSA key in PEM format.
  --get-server-public-key
                      Get server public key
  -v, --verbose       Write more.

Default options are read from the following files in the given order:
/etc/mysql/my.cnf /etc/my.cnf ~/.my.cnf
The following groups are read: mysql_migrate_keyring
The following options may be given as the first argument:
--print-defaults        Print the program argument list and exit.
--no-defaults           Don't read default options from any option file,
                        except for login file.
--defaults-file=#       Only read default options from the given file #.
--defaults-extra-file=# Read this file after the global files are read.
--defaults-group-suffix=#
                        Also read groups with concat(group, suffix)
--login-path=#          Read this path from the login file.
--no-login-paths        Don't read login paths from the login path file.

Variables (--variable-name=value)
and boolean options {FALSE|TRUE}          Value (after reading options)
----------------------------------------- --------------------------------
component-dir                             (No default value)
source-keyring                            (No default value)
source-keyring-configuration-dir          (No default value)
destination-keyring                       (No default value)
destination-keyring-configuration-dir     (No default value)
online-migration                          FALSE
host                                      (No default value)
port                                      0
socket                                    (No default value)
user                                      (No default value)
ssl-ca                                    (No default value)
ssl-capath                                (No default value)
ssl-cert                                  (No default value)
ssl-cipher                                (No default value)
ssl-key                                   (No default value)
ssl-crl                                   (No default value)
ssl-crlpath                               (No default value)
tls-version                               (No default value)
tls-ciphersuites                          (No default value)
ssl-session-data                          (No default value)
ssl-session-data-continue-on-failed-reuse FALSE
tls-sni-servername                        (No default value)
server-public-key-path                    (No default value)
get-server-public-key                     FALSE
Options (36)
OptionDescriptionSource
-?, --helpDisplay this help and exit.help
-V, --versionOutput version information and exit.help
--component-dir nameDirectory for components/plugins.help
--source-keyring nameSource keyring name (without extension)help
--source-keyring-configuration-dir nameSource keyring configuration directoryhelp
--destination-keyring nameDestination keyring component name (without extension)help
--destination-keyring-configuration-dir nameDestination keyring configuration directoryhelp
--online-migrationSignal the utility that source of migration is an active serverhelp
-h, --host nameConnect to host.help
-P, --port #Port number to use for connection or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306).help
-S, --socket nameThe socket file to use for connection.help
-u, --user nameUser for login if not current user.help
-p, --password namePassword to use when connecting to server.help
--ssl-mode nameSSL connection mode.help
--ssl-ca nameCA file in PEM format.help
--ssl-capath nameCA directory.help
--ssl-cert nameX509 cert in PEM format.help
--ssl-cipher nameSSL cipher to use.help
--ssl-key nameX509 key in PEM format.help
--ssl-crl nameCertificate revocation list.help
--ssl-crlpath nameCertificate revocation list path.help
--tls-version nameTLS version to use, permitted values are: TLSv1.2, TLSv1.3help
--ssl-fips-mode nameSSL FIPS mode (applies only for OpenSSL);help
--tls-ciphersuites nameTLS v1.3 cipher to use.help
--ssl-session-data nameSession data file to use to enable ssl session reusehelp
--ssl-session-data-continue-on-failed-reuseIf set to ON, this option will allow connection to succeed even if session data cannot be reused.help
--tls-sni-servername nameThe SNI server name to pass to serverhelp
--server-public-key-path nameFile path to the server public RSA key in PEM format.help
--get-server-public-keyGet server public keyhelp
-v, --verboseWrite more.help
--print-defaultsPrint the program argument list and exit.help
--no-defaultsDon't read default options from any option file, except for login file.help
--defaults-file #Only read default options from the given file #.help
--defaults-group-suffix #Also read groups with concat(group, suffix)help
--login-path #Read this path from the login file.help
--no-login-pathsDon't read login paths from the login path file.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.