maxctrl options in 2.4
This page is part of MariaDB's Documentation.
The parent of this page is: Command-Line Interfaces for MariaDB MaxScale 2.4
Topics on this page:
Overview
The following options are global to the maxctrl command and its sub-commands:
Option | Description |
|---|---|
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, give -p as the last argument or use --password='' [string] [default: "mariadb"] | |
Silence all output. Ignored while in interactive mode. [boolean] [default: false] | |
Enable HTTPS requests [boolean] [default: false] | |
Request timeout in milliseconds [number] [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 2.4
In addition to the global options above, the maxctrl api sub-command accepts the following options:
Option | Description |
|---|---|
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 2.4
In addition to the global options above, the maxctrl api get sub-command accepts the following options:
Option | Description |
|---|---|
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 2.4
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] | |
Path to TLS key [string] | |
TLS version to use [string] |
maxctrl create monitor options in 2.4
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 service 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 2.4
In addition to the global options above, the maxctrl create server sub-command accepts the following options:
Option | Description |
|---|---|
Authenticator module name [string] | |
Option string for the authenticator [string] | |
--monitors Link the created server to this monitor [string] | |
Protocol module name [string] [default: "mariadbbackend"] | |
Link the created server to these services [array] | |
Path to TLS CA certificate [string] | |
Path to TLS certificate [string] | |
Path to TLS key [string] | |
TLS version to use [string] |
The following Command-line Options are not present in MariaDB MaxScale 2.4.17 but are present in one or more older 2.4 versions. Click on an item to see its details, including when it was removed.
Option | Description |
|---|---|
Link the created server to these monitors [array] |
maxctrl create service options in 2.4
In addition to the global options above, the maxctrl create service sub-command accepts the following options:
Option | Description |
|---|---|
Link the created service to these filters [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] |
maxctrl create user options in 2.4
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 drain options in 2.4
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 2.4
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 enable options in 2.4
In addition to the global options above, the maxctrl enable sub-command accepts the following options:
Option | Description |
|---|---|
Type of user to create [string] [choices: "admin", "basic"] [default: "basic"] |
maxctrl enable account options in 2.4
In addition to the global options above, the maxctrl enable account sub-command accepts the following options:
Option | Description |
|---|---|
Type of user to create [string] [choices: "admin", "basic"] [default: "basic"] |
maxctrl enable log-priority options in 2.4
In addition to the global options above, the maxctrl enable log-priority sub-command accepts the following options:
Option | Description |
|---|---|
Type of user to create [string] [choices: "admin", "basic"] [default: "basic"] |
maxctrl set options in 2.4
In addition to the global options above, the maxctrl set sub-command accepts the following options:
Option | Description |
|---|---|
Forcefully close all connections to the target server [boolean] [default: false] |
maxctrl set server options in 2.4
In addition to the global options above, the maxctrl set server sub-command accepts the following options:
Option | Description |
|---|---|
Forcefully close all connections to the target server [boolean] [default: false] |