MySQL Router Ver 9.7.0 for Linux on x86_64 (Source distribution) Copyright (c) 2015, 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. Configuration read from the following files in the given order (enclosed in parentheses means not available for reading): (/usr/bin/.././mysqlrouter.conf) (/usr/bin/.././mysqlrouter.ini) (/tmp/.mysqlrouter.conf) (/tmp/.mysqlrouter.ini) Plugins Path: /usr/lib/mysqlrouter Default Log Directory: /usr Default Persistent Data Directory: /usr/var/lib/mysqlrouter Default Runtime State Directory: /usr/run # Usage mysqlrouter (-?|--help) mysqlrouter (-V|--version) mysqlrouter [--account-host=] (-B|--bootstrap=) [--bootstrap-socket=] [--client-ssl-cert=] [--client-ssl-cipher=] [--client-ssl-curves=] [--client-ssl-key=] [--client-ssl-mode=] [--conf-base-port=] [--conf-skip-tcp] [--conf-use-sockets] [--connect-timeout=[]] [--conf-use-gr-notifications=[]] [--conf-local-cluster=] [-d|--directory=] [--force] [--force-password-validation] [--master-key-reader=] [--master-key-writer=] [--name=[]] [--password-retries=[]] [--read-timeout=[]] [--report-host=] [--server-ssl-ca=] [--server-ssl-capath=] [--server-ssl-cipher=] [--server-ssl-crl=] [--server-ssl-crlpath=] [--server-ssl-curves=] [--server-ssl-mode=] [--server-ssl-verify=] [--ssl-ca=] [--ssl-cert=] [--ssl-cipher=] [--ssl-crl=] [--ssl-crlpath=] [--ssl-key=] [--ssl-mode=] [--tls-version=] [--conf-set-option=] [--core-file=[]] [-u|--user=] mysqlrouter [--core-file=[]] [--pid-file=] [-u|--user=] [-c|--config=] [-a|--extra-config=] # Options --account Account (username) to be used by Router when talking to cluster. (bootstrap) --account-create Specifies account creation policy (useful for guarding against accidentally bootstrapping using a wrong account). is one of: 'always' - bootstrap only if account doesn't exist 'never' - bootstrap only if account exists 'if-not-exists' - bootstrap either way (default) This option can only be used if option '--account' is also used. Argument 'never' cannot be used together with option '--account-host' (bootstrap) --account-host Host pattern to be used when creating Router's database user, default='%'. It can be used multiple times to provide multiple patterns. (bootstrap) -B , --bootstrap Bootstrap and configure Router for operation with a MySQL InnoDB cluster. --bootstrap-socket Bootstrap and configure Router via a Unix socket --client-ssl-cert name of a PEM file containing a SSL certificate used for accepting TLS connections between client and router --client-ssl-cipher list of one or more colon separated cipher names used for accepting TLS connections between client and router --client-ssl-curves list of one or more colon separated elliptic curve names used for accepting TLS connections between client and router --client-ssl-key name of a PEM file containing a SSL private key used for accepting TLS connections between client and router --client-ssl-mode SSL mode for connections from client to router. One of DISABLED, PREFERRED, REQUIRED or PASSTHROUGH. --client-ssl-dh-params name of a PEM file containing DH paramaters --conf-base-port Base port to use for listening router ports. (bootstrap) --conf-bind-address
IP address of the interface to which router's listening sockets should bind. (bootstrap) --conf-skip-tcp Whether to disable binding of a TCP port for incoming connections. (bootstrap) --conf-use-sockets Whether to use Unix domain sockets. (bootstrap) --conf-skip-x-protocol Whether to disable routing of X protocol connections. (bootstrap) --connect-timeout [ ] The time in seconds after which trying to connect to metadata server should timeout. It is used when bootstrapping and also written to the configuration file (bootstrap) --conf-use-gr-notifications [ ] Whether to enable handling of cluster state change GR notifications. --conf-target-cluster Router's target Cluster from the ClusterSet('current' or 'primary'). --conf-target-cluster-by-name Name of the target Cluster for the Router when bootstrapping against the ClusterSet --conf-local-cluster Name of the local cluster used for routing purposes -d , --directory Creates a self-contained directory for a new instance of the Router. (bootstrap) --force Force reconfiguration of a possibly existing instance of the router. (bootstrap) --force-password-validation When autocreating database account do not use HASHED password - this is the default behavior now, this parameter is not needed, it is kept for backward compatibility.(bootstrap) --master-key-reader The tool that can be used to read master key, it has to be used together with --master-key-writer. (bootstrap) --master-key-writer The tool that can be used to store master key, it has to be used together with --master-key-reader. (bootstrap) --name [ ] Gives a symbolic name for the router instance. (bootstrap) --password-retries [ ] Number of the retries for generating the router's user password. (bootstrap) --read-timeout [ ] The time in seconds after which reads from metadata server should timeout. It is used when bootstrapping and is also written to configuration file. (bootstrap) --report-host Host name of this computer (it will be queried from OS if not provided). It is used as suffix (the part after '@') in Router's database user name; should match host name as seen by the cluster nodes (bootstrap) --server-ssl-ca path name of the Certificate Authority (CA) certificate file in PEM format. Used when forwarding a client connection from router to a server. --server-ssl-capath path name of the directory that contains trusted SSL Certificate Authority (CA) certificate files in PEM format. Used when forwarding a client connection from router to a server. --server-ssl-cipher list of one or more colon separated cipher names. Used when forwarding client connection from router to a server. --server-ssl-crl path name of the file containing certificate revocation lists in PEM format. Used when forwarding a client connection from router to a server. --server-ssl-crlpath path name of the directory that contains certificate revocation-list files in PEM format. Used when forwarding a client connection from router to a server. --server-ssl-curves list of one or more colon separated elliptic curve names. Used when forwarding a client connection from router to a server. --server-ssl-mode SSL mode to use when forwarding a client connection from router to a server. One of DISABLED, PREFERRED, REQUIRED or AS_CLIENT. --server-ssl-verify verification mode when forwarding a client connection from router to server. One of DISABLED, VERIFY_CA or VERIFY_IDENTITY. --ssl-ca Path to SSL CA file to verify server's certificate against when connecting to the metadata servers --ssl-capath Path to directory containing SSL CA files to verify server's certificate against when connecting to the metadata servers. --ssl-cert Path to a SSL certificate, to be used if client certificate verification is required when connecting to the metadata servers. --ssl-cipher : separated list of SSL ciphers to allow when connecting to the metadata servers, if SSL is enabled. --ssl-crl Path to SSL CRL file to use when connecting to metadata-servers and verifying their SSL certificate --ssl-crlpath Path to directory containing SSL CRL files to use when connecting to metadata-servers and verifying their SSL certificate. --ssl-key Path to private key for client SSL certificate, to be used if client certificate verification is required when connecting to metadata-servers. --disable-rw-split Do not generate routing section for RW Split endpoint --disable-rest Disable REST web service for Router monitoring --https-port HTTPS port for Router monitoring REST web service --ssl-mode SSL connection mode for use during bootstrap and normal operation, when connecting to the metadata server. Analogous to --ssl-mode in mysql client. One of DISABLED|PREFERRED|REQUIRED|VERIFY_CA|VERIFY_IDENTITY. Default = PREFERRED. (bootstrap) --strict Upgrades account verification failure warning into a fatal error. (bootstrap) --tls-version , separated list of TLS versions to request, if SSL is enabled. --conf-set-option Allows forcing selected option in the configuration file when bootstrapping (--conf-set-option=section_name.option_name=value) --core-file [ ] Write a core file if mysqlrouter dies. --pid-file Path and filename of pid file -u , --user Run the mysqlrouter as the user having the name user_name. -c , --config Only read configuration from given file. -a , --extra-config Read this file after configuration files are read from either default locations or from files specified by the --config option. -V, --version Display version information and exit. -?, --help Display this help and exit. # Examples Bootstrap for use with InnoDB cluster into system-wide installation sudo mysqlrouter --bootstrap root@clusterinstance01 --user=mysqlrouter Start router sudo mysqlrouter --user=mysqlrouter Bootstrap for use with InnoDb cluster in a self-contained directory mysqlrouter --bootstrap root@clusterinstance01 -d myrouter Start router myrouter/start.sh