maxctrl options in 2.5

Overview

The following options are global to the maxctrl command and its sub-commands:

Option

Description

--help

Show help [boolean]

--hosts (-h)

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 (-p)

Password for the user. To input the password manually, use -p '' or --password='' [string] [default: "mariadb"]

--quiet (-q)

Silence all output. Ignored while in interactive mode. [boolean] [default: false]

--secure (-s)

Enable HTTPS requests [boolean] [default: false]

--timeout (-t)

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"]

--tls-ca-cert

Path to TLS CA certificate [string]

--tls-cert

Path to TLS public certificate [string]

--tls-key

Path to TLS private key [string]

--tls-passphrase

Password for the TLS private key [string]

--tls-verify-server-cert (-n)

Whether to verify server TLS certificates [boolean] [default: true]

--tsv

Print tab separated output [boolean] [default: false]

--user (-u)

Username to use [string] [default: "admin"]

--version

Show version number [boolean]

maxctrl api options in 2.5

In addition to the global options above, the maxctrl api sub-command accepts the following options:

Option

Description

--pretty

Pretty-print output. [boolean] [default: false]

--sum

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.5

In addition to the global options above, the maxctrl api get sub-command accepts the following options:

Option

Description

--pretty

Pretty-print output. [boolean] [default: false]

--sum

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.5

In addition to the global options above, the maxctrl create listener sub-command accepts the following options:

Option

Description

--authenticator

Authenticator module name [string]

--authenticator-options

Option string for the authenticator [string]

--interface

Interface to listen on [string] [default: "::"]

--protocol

Protocol module name [string] [default: "mariadbclient"]

--tls-ca-cert

Path to TLS CA certificate [string]

--tls-cert

Path to TLS certificate [string]

--tls-cert-verify-depth

TLS certificate verification depth [number]

--tls-crl

TLS CRL to use [string]

--tls-key

Path to TLS key [string]

--tls-verify-peer-certificate

Enable TLS peer certificate verification [boolean]

--tls-verify-peer-host

Enable TLS peer host verification [boolean]

--tls-version

TLS version to use [string]

maxctrl create monitor options in 2.5

In addition to the global options above, the maxctrl create monitor sub-command accepts the following options:

Option

Description

--monitor-password

Password for the monitor user [string]

--monitor-user

Username for the monitor user [string]

--servers

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 2.5

In addition to the global options above, the maxctrl create server sub-command accepts the following options:

Option

Description

--authenticator

Authenticator module name (deprecated) [string]

--authenticator-options

Option string for the authenticator (deprecated) [string]

--monitors

Link the created server to these monitors [array]

--protocol

Protocol module name [string] [default: "mariadbbackend"]

--services

Link the created server to these services [array]

--tls

Enable TLS [boolean]

--tls-ca-cert

Path to TLS CA certificate [string]

--tls-cert

Path to TLS certificate [string]

--tls-cert-verify-depth

TLS certificate verification depth [number]

--tls-key

Path to TLS key [string]

--tls-verify-peer-certificate

Enable TLS peer certificate verification [boolean]

--tls-verify-peer-host

Enable TLS peer host verification [boolean]

--tls-version

TLS version to use [string]

maxctrl create service options in 2.5

In addition to the global options above, the maxctrl create service sub-command accepts the following options:

Option

Description

--cluster

Link the created service to this cluster (i.e., a monitor) [string]

--filters

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]

--servers

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]

--services

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 2.5

In addition to the global options above, the maxctrl create user sub-command accepts the following options:

Option

Description

--type

Type of user to create [string] [choices: "admin", "basic"] [default: "basic"]

maxctrl destroy filter options in 2.5

In addition to the global options above, the maxctrl destroy filter sub-command accepts the following options:

Option

Description

--force

Automatically remove the filter from all services before destroying it [boolean] [default: false]

maxctrl destroy monitor options in 2.5

In addition to the global options above, the maxctrl destroy monitor sub-command accepts the following options:

Option

Description

--force

Remove monitored servers from the monitor before destroying it [boolean] [default: false]

maxctrl destroy server options in 2.5

In addition to the global options above, the maxctrl destroy server sub-command accepts the following options:

Option

Description

--force

Remove the server from monitors and services before destroying it [boolean] [default: false]

maxctrl destroy service options in 2.5

In addition to the global options above, the maxctrl destroy service sub-command accepts the following options:

Option

Description

--force

Remove filters, listeners and servers from service before destroying it [boolean] [default: false]

maxctrl drain options in 2.5

In addition to the global options above, the maxctrl drain sub-command accepts the following options:

Option

Description

--drain-timeout

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.5

In addition to the global options above, the maxctrl drain server sub-command accepts the following options:

Option

Description

--drain-timeout

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 set options in 2.5

In addition to the global options above, the maxctrl set sub-command accepts the following options:

Option

Description

--force

If combined with the `maintenance` state, this forcefully closes all connections to the target server [boolean] [default: false]

maxctrl set server options in 2.5

In addition to the global options above, the maxctrl set server sub-command accepts the following options:

Option

Description

--force

If combined with the `maintenance` state, this forcefully closes all connections to the target server [boolean] [default: false]