OS Manuals

mysqlrouter_keyring(1)

mysqlrouter_keyring - MySQL Router Keyring Tool

MYSQLROUTER_KEYRING(1) MySQL Router MYSQLROUTER_KEYRING(1)

mysqlrouter_keyring - MySQL Router Keyring Tool

mysqlrouter_keyring [options]

The mysqlrouter_keyring utility is a command line application to manage MySQL Router key rings.


Note

This feature was added in MySQL Router 8.0.18.

Usage information:

Generic commands

•--help: usage information.

•--version: the tool's version.

Keyring commands; all commands also accept --master-key-reader and --master-key-writer instead of --master-key-file.

•init: Initialize keyring with a master-key-file.

Creates a keyring and master-key-file if they do not exist; and adds keyring to master-key-file if it does not yet exist there.

•list: List usernames stored in the keyring; or list properties of a user stored in the keyring.

•get: Get property of user from the keyring.

•export: Export all entries of the keyring as JSON.

•set: Add or overwrite account of the user in the keyring file

•delete: Delete user from the keyring.

Master-key commands

•master-key-list: List keyring-ids from master-key-file.

•master-key-delete: Delete master-key from "keyring" from master-key-file.

•master-key-rename: Rename keyring-id in a master-key-file.

Examples:

$> mysqlrouter_keyring init --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring list --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring list --master-key-file=mysqlrouter.key data/keyring user   
$> mysqlrouter_keyring get --master-key-file=mysqlrouter.key data/keyring someuser key
$> mysqlrouter_keyring export --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring set --master-key-file=mysqlrouter.key data/keyring user key value
$> mysqlrouter_keyring delete --master-key-file=mysqlrouter.key data/keyring user
$> mysqlrouter_keyring delete --master-key-file=mysqlrouter.key data/keyring user key
$> mysqlrouter_keyring master-key-list --master-key-file=mysqlrouter.key
$> mysqlrouter_keyring master-key-delete --master-key-file=mysqlrouter.key data/keyring 
$> mysqlrouter_keyring master-key-rename --master-key-file=mysqlrouter.key data/keyring other/data/keyring

Copyright © 2006, 2023, Oracle and/or its affiliates.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

Oracle Corporation (http://dev.mysql.com/).

08/28/2023 MySQL 8.0

percona-xtrabackup-8.0 8.0.35.36-r5 · enterprise-packages · ingested 2026-10-10