maxctrl options in 23.02

Overview

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

Option

Description

--config (-c)

MaxCtrl configuration file [string] [default: "~/.maxctrl.cnf"]

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

--skip-sync

Disable configuration synchronization for this command [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 23.02

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 23.02

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 api patch options in 23.02

In addition to the global options above, the maxctrl api patch 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 post options in 23.02

In addition to the global options above, the maxctrl api post 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 monitor options in 23.02

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

Option

Description

--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 23.02

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

Option

Description

--monitors

Link the created server to these monitors [array]

--services

Link the created server to these services [array]

maxctrl create service options in 23.02

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 23.02

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 23.02

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 23.02

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 23.02

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 23.02

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 destroy session options in 23.02

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

Option

Description

--ttl

Give session this many seconds to gracefully close [number] [default: 0]

maxctrl list queries options in 23.02

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

Option

Description

--max-length (-l)

Maximum SQL length to display. Use --max-length=0 for no limit. [number] [default: 120]

maxctrl set options in 23.02

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 23.02

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]

maxctrl stop listener options in 23.02

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

Option

Description

--force

Close existing connections after stopping the listener [boolean] [default: false]

maxctrl stop service options in 23.02

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

Option

Description

--force

Close existing connections after stopping the service [boolean] [default: false]

maxctrl stop services options in 23.02

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

Option

Description

--force

Close existing connections after stopping all services [boolean] [default: false]