maxctrl options in 6
This page is part of MariaDB's Documentation.
The parent of this page is: Command-Line Interfaces for MariaDB MaxScale 6
Topics on this page:
Overview
The following options are global to the maxctrl command and its sub-commands:
Option | Description |
|---|---|
MaxCtrl configuration file [string] [default: "~/.maxctrl.cnf"] | |
Show help [boolean] | |
List of MaxScale hosts. The hosts must be in HOST:PORT format and each value must be separated by a comma. [string] [default: "127.0.0.1:8989"] | |
Password for the user. To input the password manually, use -p '' or --password='' [string] [default: "mariadb"] | |
Silence all output. Ignored while in interactive mode. [boolean] [default: false] | |
Enable HTTPS requests [boolean] [default: false] | |
Disable configuration synchronization for this command [boolean] [default: false] | |
Request timeout in plain milliseconds, e.g., '-t 1000', or as duration with suffix [h|m|s|ms], e.g., '-t 10s' [string] [default: "10000"] | |
Path to TLS CA certificate [string] | |
Path to TLS public certificate [string] | |
Path to TLS private key [string] | |
Password for the TLS private key [string] | |
Whether to verify server TLS certificates [boolean] [default: true] | |
Print tab separated output [boolean] [default: false] | |
Username to use [string] [default: "admin"] | |
Show version number [boolean] |
maxctrl api options in 6
In addition to the global options above, the maxctrl api sub-command accepts the following options:
Option | Description |
|---|---|
Pretty-print output. [boolean] [default: false] | |
Calculate sum of API result. Only works for arrays of numbers e.g., `api get --sum servers data[].attributes.statistics.connections`. [boolean] [default: false] |
maxctrl api get options in 6
In addition to the global options above, the maxctrl api get sub-command accepts the following options:
Option | Description |
|---|---|
Pretty-print output. [boolean] [default: false] | |
Calculate sum of API result. Only works for arrays of numbers e.g., `api get --sum servers data[].attributes.statistics.connections`. [boolean] [default: false] |
maxctrl api patch options in 6
In addition to the global options above, the maxctrl api patch sub-command accepts the following options:
Option | Description |
|---|---|
Pretty-print output. [boolean] [default: false] | |
Calculate sum of API result. Only works for arrays of numbers e.g., `api get --sum servers data[].attributes.statistics.connections`. [boolean] [default: false] |
maxctrl api post options in 6
In addition to the global options above, the maxctrl api post sub-command accepts the following options:
Option | Description |
|---|---|
Pretty-print output. [boolean] [default: false] | |
Calculate sum of API result. Only works for arrays of numbers e.g., `api get --sum servers data[].attributes.statistics.connections`. [boolean] [default: false] |
maxctrl create listener options in 6
In addition to the global options above, the maxctrl create listener sub-command accepts the following options:
Option | Description |
|---|---|
Authenticator module name [string] | |
Option string for the authenticator [string] | |
Interface to listen on [string] [default: "::"] | |
Protocol module name [string] [default: "mariadbclient"] | |
Path to TLS CA certificate [string] | |
Path to TLS certificate [string] | |
TLS certificate verification depth [number] | |
TLS CRL to use [string] | |
Path to TLS key [string] | |
Enable TLS peer certificate verification [boolean] | |
Enable TLS peer host verification [boolean] | |
TLS version to use [string] |
maxctrl create monitor options in 6
In addition to the global options above, the maxctrl create monitor sub-command accepts the following options:
Option | Description |
|---|---|
Password for the monitor user [string] | |
Username for the monitor user [string] | |
Link the created monitor to these servers. All non-option arguments after --servers are interpreted as server names e.g., `--servers srv1 srv2 srv3`. [array] |
maxctrl create server options in 6
In addition to the global options above, the maxctrl create server sub-command accepts the following options:
Option | Description |
|---|---|
Authenticator module name (deprecated) [string] | |
Option string for the authenticator (deprecated) [string] | |
Link the created server to these monitors [array] | |
Protocol module name [string] [default: "mariadbbackend"] | |
Link the created server to these services [array] | |
Enable TLS [boolean] | |
Path to TLS CA certificate [string] | |
Path to TLS certificate [string] | |
TLS certificate verification depth [number] | |
Path to TLS key [string] | |
Enable TLS peer certificate verification [boolean] | |
Enable TLS peer host verification [boolean] | |
TLS version to use [string] |
maxctrl create service options in 6
In addition to the global options above, the maxctrl create service sub-command accepts the following options:
Option | Description |
|---|---|
Link the created service to this cluster (i.e., a monitor) [string] | |
Link the created service to these filters. All non-option arguments after --filters are interpreted as filter names e.g., `--filters f1 f2 f3`. [array] | |
Link the created service to these servers. All non-option arguments after --servers are interpreted as server names e.g., `--servers srv1 srv2 srv3`. [array] | |
Link the created service to these services. All non-option arguments after --services are interpreted as service names e.g., `--services svc1 svc2 svc3`. [array] |
maxctrl create user options in 6
In addition to the global options above, the maxctrl create user sub-command accepts the following options:
Option | Description |
|---|---|
Type of user to create [string] [choices: "admin", "basic"] [default: "basic"] |
maxctrl destroy filter options in 6
In addition to the global options above, the maxctrl destroy filter sub-command accepts the following options:
Option | Description |
|---|---|
Automatically remove the filter from all services before destroying it [boolean] [default: false] |
maxctrl destroy monitor options in 6
In addition to the global options above, the maxctrl destroy monitor sub-command accepts the following options:
Option | Description |
|---|---|
Remove monitored servers from the monitor before destroying it [boolean] [default: false] |
maxctrl destroy server options in 6
In addition to the global options above, the maxctrl destroy server sub-command accepts the following options:
Option | Description |
|---|---|
Remove the server from monitors and services before destroying it [boolean] [default: false] |
maxctrl destroy service options in 6
In addition to the global options above, the maxctrl destroy service sub-command accepts the following options:
Option | Description |
|---|---|
Remove filters, listeners and servers from service before destroying it [boolean] [default: false] |
maxctrl drain options in 6
In addition to the global options above, the maxctrl drain sub-command accepts the following options:
Option | Description |
|---|---|
Timeout for the drain operation in seconds. If exceeded, the server is added back to all services without putting it into maintenance mode. [number] [default: 90] |
maxctrl drain server options in 6
In addition to the global options above, the maxctrl drain server sub-command accepts the following options:
Option | Description |
|---|---|
Timeout for the drain operation in seconds. If exceeded, the server is added back to all services without putting it into maintenance mode. [number] [default: 90] |
maxctrl list queries options in 6
In addition to the global options above, the maxctrl list queries sub-command accepts the following options:
Option | Description |
|---|---|
Maximum SQL length to display. Use --max-length=0 for no limit. [number] [default: 120] |
maxctrl set options in 6
In addition to the global options above, the maxctrl set sub-command accepts the following options:
Option | Description |
|---|---|
If combined with the `maintenance` state, this forcefully closes all connections to the target server [boolean] [default: false] |
maxctrl set server options in 6
In addition to the global options above, the maxctrl set server sub-command accepts the following options:
Option | Description |
|---|---|
If combined with the `maintenance` state, this forcefully closes all connections to the target server [boolean] [default: false] |
maxctrl stop listener options in 6
In addition to the global options above, the maxctrl stop listener sub-command accepts the following options:
Option | Description |
|---|---|
Close existing connections after stopping the listener [boolean] [default: false] |
maxctrl stop service options in 6
In addition to the global options above, the maxctrl stop service sub-command accepts the following options:
Option | Description |
|---|---|
Close existing connections after stopping the service [boolean] [default: false] |
maxctrl stop services options in 6
In addition to the global options above, the maxctrl stop services sub-command accepts the following options:
Option | Description |
|---|---|
Close existing connections after stopping all services [boolean] [default: false] |