arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

MaxScale Configuration Settings

Browse the comprehensive list of MariaDB MaxScale configuration parameters. This reference details valid values, default settings, and dynamic capabilities for servers, services, and monitors.

hashtag
General

hashtag
MaxScale

hashtag
Filter

  • Type: filter

  • Mandatory: Yes

  • Dynamic: No

  • Description: The module parameter specifies the name of the filter module that is included in the routing chain.

hashtag
Global Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: GET

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: /var/log/maxscale/admin_audit.csv

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: "127.0.0.1"

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: auto

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: maxscale

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 24h

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: password

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: auto

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 8989

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: %

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Description: Defines additional TLS cipher configuration for the REST API.

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: MAX

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

allow_duplicate_servers

  • Type: boolean

  • Default: false

  • Description: Allows multiple server definitions to use the same IP address and port combination.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string list

  • Values: all or list of auto tunable parameters, separated by ,

  • Default: No

  • Type: monitor

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: mysql

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5s

  • Type: password

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: OS Dependent

  • Type:

  • Default: false

  • Dynamic: No

  • Description: Specifies whether a core dump file is generated in the event that MaxScale crashes.

cors_allow_origin

  • Type: string

  • Default: N/A

  • Description: Enables CORS and sets the Access-Control-Allow-Origin header to the specified value.

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

disable_fcrdns

  • Type: boolean

  • Default: false

  • Description: Disables Forward-Confirmed Reverse DNS (fcRDNS) lookups for client connections.

disable_module_unloading

  • Type: boolean

  • Default: false

  • Description: Disables the unloading of modules at exit. This provides more accurate Valgrind leak reports when memory is allocated within shared libraries.

disable_statement_logging

  • Type: boolean

  • Default: true

  • Description: Disables the logging of SQL statements sent by MaxScale to backend servers.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: on_close

dump_network_traffic

  • Type: boolean

  • Default: false

  • Description: Dumps all raw network traffic to the log as info level messages.

enable_cors

  • Type: boolean

  • Default: false

  • Description: Enables Cross-Origin Resource Sharing (CORS) support for the MaxScale REST API.

enable_module_unloading

  • Type: boolean

  • Default: true

  • Description: Re-enables module unloading at exit (overrides disable-module-unloading)

enable_statement_logging

  • Type: boolean

  • Default: false

  • Description: Enables logging of all SQL statements sent by MaxScale monitors and authenticators to the backend servers.

exception_frequency

  • Type: integer

  • Default: true

  • Description: Defines the frequency of generated API exceptions.

gdb_stacktrace

  • Type: boolean

  • Default: true

  • Description: When enabled, MaxScale attempts to use GDB to generate detailed stack traces during a crash. Can be disabled with gdb-stacktrace=false.

  • Type: integer

  • Default: 128

  • Dynamic: Yes

  • Description: Sets the number of entries in the reverse DNS lookup cache for client hostnames.

  • Type:

  • Dynamic: Yes

  • Values: none, file, kmip, vault

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: OS Dependent

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number, ,

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10, 1000ms, 10000ms

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/log/maxscale

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /etc/maxscale.modules.d/

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Default: true

  • Dynamic: No

  • Description: Save runtime configuration changes to disk.

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale/maxscale.cnf.d/

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /run/maxscale

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: System Dependent

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 1

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 20

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

redirect_output_to_file

  • Type: boolean

  • Default: false

  • Description: Redirects stdout and stderr to the specified file path.

  • Type:

  • Default: false

  • Dynamic: No

  • Description: Requires SSL for all listeners, servers, and the REST API.

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /usr/share/maxscale

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: default

sql_batch_size

  • Type: size

  • Default: 10MiB

  • Description: Sets the maximum batch size for REST API SQL statement processing.

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: stringlist

  • Default: empty

  • Dynamic: Yes

  • Mandatory: No

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 60s

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: http://localhost:4318/v1/metrics

  • Type: number or auto

  • Mandatory: No

  • Dynamic: No

  • Type: positive integer

  • Default: 256

  • Dynamic: No

  • Description: Hard limit for the number of worker threads.

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Description: Directory for low-overhead trace log files.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Description: Amount of log data to keep in trace files.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 30s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 65536

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1024

hashtag
Service

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: monitor

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 300s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: filter list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0 in MaxScale, 15 in MaxScale Trial.

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 50

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 60s

  • Type:

  • Mandatory No

  • Dynamic: Yes

  • Default: 0s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the password the service uses to retrieve user accounts from backends.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: router

  • Mandatory: Yes

  • Dynamic: No

  • Description: Defines the router module that a service uses to direct client connections to backend servers.

  • Type: server list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: target list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Username for retrieving user account information from backends.

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: add_when_load_ok

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 28800s

hashtag
Settings for File-based Key Manager

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Path to file containing encryption keys.

hashtag
Settings for HashiCorp Vault Key Manager

  • Type: path

  • Default: ""

  • Dynamic: Yes

  • Type: string

  • Default: localhost

  • Dynamic: Yes

  • Type: string

  • Default: secret

  • Dynamic: Yes

  • Type: integer

  • Default: 8200

  • Dynamic: Yes

  • Type:

  • Default: 30s

  • Dynamic: Yes

  • Description: Sets the timeout for requests and connections to the Vault server.

  • Type:

  • Default: true

  • Dynamic: Yes

  • Description: Manages whether encrypted (HTTPS) or unencrypted (HTTP) connections are used when communicating with the Vault server.

  • Type: password

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Provides the authentication token to access the Vault server.

hashtag
Settings for KMIP Key Manager

  • Type: path

  • Default: ""

  • Dynamic: Yes

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Client certificate for KMIP authentication.

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the client private key used for connecting to the KMIP server.

  • Type: integer

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Defines the port on which the KMIP server listens.

hashtag
Settings for TLS/SSL Encryption

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 9

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: MAX

hashtag
reference

hashtag

hashtag
Settings

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: "::"

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: stringlist

  • Default: character_set_client=auto,character_set_connection=auto,character_set_results=auto,max_allowed_packet=auto,system_time_zone=auto,time_zone=auto,tx_isolation=auto,maxscale=auto

  • Dynamic: Yes

  • Type: number

  • Mandatory: Yes, if socket is not provided.

  • Dynamic: No

  • Type: protocol

  • Mandatory: No

  • Dynamic: No

  • Default: mariadb

  • Type: URL

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: service

  • Mandatory: Yes

  • Dynamic: No

  • Description: Identifies the service that the listener is connected to.

  • Type: string

  • Mandatory: Yes, if port is not provided.

  • Dynamic: No

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: default

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

hashtag

hashtag
Settings

  • Type: string

  • Mandatory: Yes, if socket is not provided.

  • Dynamic: Yes

  • Type: Custom

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: down

  • Type: string list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0 in MaxScale, 15 in MaxScale Trial.

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3306

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: primary

  • Type: string

  • Default: None

  • Dynamic: Yes

  • Description: Defines custom options added to replication commands for server.

  • Type: string

  • Mandatory: Yes, if address is not provided.

  • Dynamic: Yes

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

hashtag
reference/maxscale-authenticators

hashtag

Settings

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: Kerberos Default

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: mariadb/localhost.localdomain

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: none

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: password

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

hashtag
reference/maxscale-filters

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: never

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: shared

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 0s

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: never

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 0

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 0

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: assume_cacheable

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 0s

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: storage_inmemory

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default:

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 5s

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: mixed

storage_memcached

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 1Mi

  • Type: The Memcached server address specified as host[:port]

  • Mandatory: Yes

  • Dynamic: No

storage_redis

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: The Redis server address specified as host[:port]

  • Mandatory: Yes

  • Dynamic: No

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: Path to existing readable file.

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: Path to existing readable file.

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: Path to existing readable file.

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

hashtag

Settings

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the comment injected before statements.

hashtag

Settings

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: ignorecase

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 60s

hashtag

Settings

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: s3.amazonaws.com

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Description: Defines the S3 access key used for authentication.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: us-east-1

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Description: Describes the S3 secret key that is used for verification.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignore

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Determines the path to the file containing masking rules.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: never

hashtag

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: empty

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: (no limit)

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 64Ki

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: milliseconds

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifies the base filename for session log files with unique session identifiers appended to create individual output files.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: service

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: session

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: " "

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: case

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ","

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Description: Defines a regex pattern for excluding requests from specified client IP addresses or hosts from logging.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Description: Defines a regex pattern to include only queries from specific client IP addresses or hosts from logging.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Description: Defines a regex pattern that prevent requests from specific users from being logged.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Description: Specifies a regex pattern to include queries only from specific users for logging.

hashtag

Settings

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Defines the regex pattern in SQL statements that filter should identify and replace.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the string that will replace SQL query parts that match

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: Native

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Default: No default value

Settings per template in the template file

  • Type:

  • Default: From maxscale.cnf

  • Description: Overrides the global template configuration to specify whether pattern matching is case-sensitive.

  • Type:

  • Default: false

  • Description: Identifies whether to use subsequent templates on a query once the previous template has been matched and replaced.

  • Type:

  • Default: true

  • Description: Specifies whether whitespace differences between the template and SQL inout should be ignored during matching.

  • Type: string

  • Values: Native, ECMAScript, Posix, EPosix, Awk, Grep, EGrep

  • Type:

  • Default: false

  • Description: Simulates replacements without affecting queries and logs any possible changes to the NOTICE level.

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase

  • Type: service

  • Mandatory: No

  • Dynamic: Yes

  • Default: none

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: target

  • Mandatory: No

  • Dynamic: Yes

  • Default: none

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2s

  • Type: number

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Sets the maximum number of requests per second allowed for a session during the specific sample period.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 250ms

  • Type:

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies how long a session can be throttled before being disconnected by MaxScale.

hashtag

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the base name for session log files, followed by the session ID to generate unique output files.

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: ignorecase

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

hashtag

Settings

  • Type: path

  • Default: /var/lib/maxscale/wcar/

  • Mandatory: No

  • Dynamic: No

  • Type:

  • Default: 0s

  • Maximum: Unlimited in MaxScale, 5min in MaxScale Lite.

  • Mandatory: No

  • Type:

  • Default: 0

  • Maximum: Unlimited in MaxScale, 10MB in MaxScale Lite.

  • Mandatory: No

  • Type:

  • Default: false

  • Mandatory: No

  • Dynamic: No

hashtag
reference/maxscale-monitors

hashtag

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: master_down

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 28800s

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifies which monitor module will be used, such as mariadbmon

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Defines the password for the user defined in the user parameter; overrides older passwd

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Provides a comma-separated list of servers that the monitor will track and manage.

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the monitor's username for connecting to backend servers; if defined, this overrides the server's monitoruser

hashtag

Settings

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Allows Galera nodes to continue performing normal operations while acting as donors during non-blocking SST methods, preventing them from losing synchronized or read/write state.

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Prevents MaxScale from restoring the original node to primary status after a failover; the new primary retains the role while running.

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Disables automatic primary and replica role assignment in a Galera cluster; when enabled, only the Synced status is assigned.

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Ensures that only the Galera node with wsrep_local_index = 0

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Controls whether the wsrep_sst_donor

  • Type:

  • Default: false

  • Dynamic: Yes

  • Description: Allows the monitor to automatically select the writing node and manage controlled node replacements in a Galera cluster while keeping server priorities into account.

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

Settings for Backup operations

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1G

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 4444

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 22

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings for Cluster manipulation operations

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

[switchover_on_low_disk_space\*\*](../reference/maxscale-monitors/mariadb-monitor.md#switchover_on_low_disk_space**)

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

Settings for Primary server write test

  • Type:

  • Default: log

  • Values: log, failover

  • Type:

  • Dynamic: Yes

  • Default: 0s

  • Description: Sets the interval after which a write test is performed on the primary if no changes are detected.

  • Type: string

  • Dynamic: Yes

  • Default: mxs.maxscale_write_test

hashtag
reference/maxscale-protocols

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

hashtag

Settings

  • Type: string

  • Mandatory: No

  • Default: "NoSQL"

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Default: false

  • Type:

  • Mandatory: No

  • Default: false

  • Type: string

  • Mandatory: Yes, if authentication_shared is true.

  • Description: Specifies the user used to access and manage shared NoSQL account information.

  • Type:

  • Mandatory: No

  • Default: false

  • Type:

  • Mandatory: No

  • Default: true

  • Type:

  • Mandatory: No

  • Default: true

  • Type:

  • Mandatory: No

  • Default: 60s

  • Type:

  • Mandatory: No

  • Values: none, in, out, back

  • Type: string

  • Mandatory: No

  • Default: "%"

  • Type: count

  • Mandatory: No

  • Range: [35, 2048]

  • Type: string

  • Mandatory: No

  • Default: ''

  • Description: Specifies the internal cache to use, currently supporting only the cache

  • Type:

  • Mandatory: No

  • Default: false

  • Type:

  • Mandatory: No

  • Values: return_error, return_empty

  • Type:

  • Mandatory: No

  • Values: atomic, default

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Default: ""

hashtag
reference/maxscale-rest-api

hashtag

Resource Operations

[Create a filter](../reference/maxscale-rest-api/maxscale-filter-resource.md#Create a filter)

  • Type of the object, must be filters

  • data.attributes.module

  • The filter module to use

hashtag

Resource Operations

[Create a new listener](../reference/maxscale-rest-api/maxscale-listener-resource.md#Create a new listener)

  • Type of the object, must be listeners

  • data.attributes.parameters.port OR data.attributes.parameters.socket

  • The TCP port or UNIX Domain Socket the listener listens on. Only one of the fields can be defined.

hashtag

Resource Operations

[Create a monitor](../reference/maxscale-rest-api/maxscale-monitor-resource.md#Create a monitor)

  • Type of the object, must be monitors

  • data.attributes.module

  • The monitor module to use

hashtag

Resource Operations

[Create a server](../reference/maxscale-rest-api/maxscale-server-resource.md#Create a server)

  • Type of the object, must be servers

  • data.attributes.parameters.address OR data.attributes.parameters.socket

  • The or to use. Only one of the fields can be defined.

hashtag

Resource Operations

[Create a service](../reference/maxscale-rest-api/maxscale-service-resource.md#Create a service)

  • Type of the object, must be services

  • data.attributes.router

  • The router module to use

hashtag
reference/maxscale-routers

hashtag

Settings

  • Type: string

  • Mandatory: Yes

  • Default: No

  • Dynamic: No

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: none

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale/binlogs

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: AES_CBC

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Dynamic: No

  • Values: purge, archive

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 0s

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 2

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 10s

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 2

  • Type:

  • Mandatory: No

  • Default: false

  • Dynamic: Yes

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 1234

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 15m

  • Type: server

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifes the primary server from which query results are returned to the client.

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: close

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Min: 1

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: 15m

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: always

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Min: 100

  • Type: service

  • Mandatory: Yes

  • Dynamic: No

  • Description: Defines the service that Diff will operate on.

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: read_only

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifies the Exasol ODBC connection string used to connect to the database.

  • Type: String

  • Mandatory: No

  • Dynamic: No

  • Values: auto

  • Type: String

  • Mandatory: No

  • Dynamic: No

  • Default: "UTIL.maria_preprocessor"

hashtag

Settings

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifies the list of Kafka brokers in host:port

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Values: PLAIN

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 1234

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Description: Specifies the Kafka topic where replicated events are published.

hashtag

Settings

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Default: 100

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the comma-separated list of Kafka broker addresses used to establish connections.

  • Type: string

  • Default: InnoDB

  • Mandatory: No

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: PLAIN

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: topic

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5000ms

  • Type: stringlist

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Specifies the comma-separated list of topics to subscribe to.

hashtag

Settings

  • Type:

  • Mandatory: Yes

  • Dynamic: Yes

  • Values: log

  • Type: string

  • Default: No default value

  • Mandatory: No

  • Dynamic: Yes

  • Type: string

  • Default: No default value

  • Mandatory: No

  • Dynamic: Yes

  • Type: string

  • Default: No default value

  • Mandatory: No

  • Dynamic: Yes

  • Type: target

  • Mandatory: Yes

  • Dynamic: Yes

  • Description: Defines the primary target server whose results are returned to the client and whose availability is required for the session.

  • Type:

  • Default: ignore

  • Mandatory: No

  • Type:

  • Default: always

  • Mandatory: No

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: master

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: fail_instantly

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true (>= MaxScale 24.02), false(<= MaxScale 23.08)

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Min: 0

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 255

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: least_current_operations

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true (>= MaxScale 24.02), false (<= MaxScale 23.08)

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: none

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Min: 1

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: full

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1 MiB

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 30s (>= MaxScale 24.02), 0s (<= MaxScale 23.08)

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Values: master

hashtag

Settings

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: stringlist

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 150s

  • Type:

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type:

  • Mandatory: No

  • Dynamic: Yes

  • Default: 300s

hashtag

Settings

  • Type: target

  • Mandatory: Yes

  • Dynamic: No

  • Description: Identifies the primary target cluster to which all write operations are directed.


This page is licensed: CC BY-SA / Gnu FDL

Description: Enables the logging of incoming REST API requests for auditing and monitoring purposes.

,
PUT
,
POST
,
PATCH
,
DELETE
,
HEAD
,
OPTIONS
,
CONNECT
,
TRACE
  • Default: No exclusions

  • Description: Provides a list of HTTP methods to be excluded from REST API audit logging, separated by commas.

  • Description: Defines the location of the REST API audit logs.

  • Description: Allows HTTP Basic authentication for the REST API.

  • Description: Enables or disables the MaxScale admin interface.

  • Description: Enables or disables the graphical user interface (GUI) for the admin interface.

  • Description: Provides the network interface address that the REST API is listening to.

  • ,
    HS256
    ,
    HS384
    ,
    HS512
    ,
    RS256
    ,
    RS384
    ,
    RS512
    ,
    PS256
    ,
    PS384
    ,
    PS512
    ,
    ES256
    ,
    ES384
    ,
    ES512
    ,
    ED25519
    ,
    ED448
  • Default: auto

  • Description: Specifies the algorithm for signing JSON Web Tokens (JWTs) for the REST API.

  • Description: Specifies the issuer ("iss") claim in the REST API-generated JSON Web Tokens.

  • Description: Identifies the encryption key that is used to sign JSON Web Tokens.

  • Description: Specifies the maximum duration of JWTs issued by the REST API.

  • Description: Enables logging of authentication failures for the admin interface.

  • Description: Specifies the client ID for OpenID Connect (OIDC) login authentication requests.

  • Description: Specifies the client secret used for OIDC authentication requests.

  • Description: Defines additional parameters that should be included in authorization requests for OIDC.

  • ,
    implicit
    ,
    code
  • Default: auto

  • Description: Describes the OIDC authentication flow used for SSO.

  • Description: Disables TLS certificate validation while retrieving OIDC certificates.

  • Description: Specifies the OIDC provider's URL, which is needed to validate JWT.

  • Description: Defines the PAM service that is used to verify read-only REST API users.

  • Description: Specifies the PAM service used for authentication REST API users with read and write access.

  • Description: Defines the port at which the REST API waits for incoming connections.

  • Description: Hosts can perform any REST API operation with read and write access.

  • Description: Manages whether the GUI are accessible only over secure HTTPS.

  • Description: Path to the CA sertificate for outgoing HTTPS requests.

  • Description: Provides the path of the TLS public certificate in PEM format used by the REST API.

  • Description: Indicates the location of the TLS private key in PEM format that the admin interface uses.

  • Description: Provides the passphrase needed to decrypt the admin interface's TLS private key.

  • ,
    TLSv1.0
    ,
    TLSv1.1
    ,
    TLSv1.2
    ,
    TLSv1.3
    ,
    TLSv10
    ,
    TLSv11
    ,
    TLSv12
    ,
    TLSv13
  • Default: MAX

  • Description: Specifies the allowed TLS protocol versions for the REST API.

  • Description: Delegate the validation of tokens to an external server.

  • Description: Sets the connection timeout for retrieving user authentication data from backend servers.

  • Mandatory: No

  • Dynamic: No

  • Description: Allows automatic tuning of specified configuration parameters based on backend server values.

  • Description: Monitor name used for configuration synchronization

  • Description: Identifies the database that contains the maxscale_config table, which is used to synchronize configurations.

  • Description: Specifies how often MaxScale synchronizes configuration changes with the cluster.

  • Description:

  • Description: Timeout for config sync SQL operations.

  • Description: Username used for configuration sync database access across MaxScale instances.

    Description: Specifies the ditrectory that contains MaxScale's MariaDB Connector-C authentication plugins.

  • Description: Specifies the location of MaxScale's data files directory.

  • Description: Defines debug options equivalent to the --debug command line argument.

  • ,
    on_error
    ,
    never
  • Default: never

  • Description: Manages when MaxScale logs the last statements executed by a client session.

  • Default: none

  • Description: Defines the encrytion key manager that MaxScale uses.

  • Description: Specifies the directory that MaxScale uses to locate modules.

  • Description: Loads saved runtime changes at startup.

  • Description: Defines what specific local interface to use when connecting to servers.

  • Description: Includes function names to logged messages.

  • Description: Log debug messages when enabled.

  • Description: Log detailed info messages when enabled.

  • Description: Log notice level messages when enabled.

  • Description: Manages how frequently repeated errors or warnings are logged.

  • Description: Log warning when a client with SUPER privilege connects.

  • Description: Enable service-level warning logging.

  • Description: Defines the directory where log files are stored.

  • Description: Maximum number of authentication failures before temprarily blocking a host.

  • Description: Enables logging of messages to the MaxScale log file.

  • Description: Directory for module-specific configuration files.

  • Description: Adds millisecond precision to logfile timestamps.

  • Description: Deprecated - use instead.

  • Description: Directory where runtime configuration changes are stored.

  • Description: Specifies the directory containing the MaxScale process ID (PID) file.

  • Description: Sets the maximum size of the query classifier cache.

  • Description: Deprecated and ignored.

  • Description: Deprecated and ignored.

  • Description: Defines the interval for monitoring and rebalancing worker thread load. A value of 0 disables this function.

  • Description: Load difference percentage that triggers thread rebalancing.

  • Description: Manages how many seconds of load to consider for rebalancing.

  • Description: Specifies how many statements MaxScale can store per session.

  • Description: Location of the .secrets file for password encryption.

  • Description: Defines how many log entries are stored in the session trace log.

  • Description: Specifies a refular expression pattern used to filter session trace logs.

  • Description: Defines the directory where static data assests are loaded.

  • Description: Disables reverse DNS lookups of client IP addresses.

  • ,
    oracle
  • Default: default

  • Description: Defines which SQL language mode the query classifier should expect.

  • Description: Allows use of environment variables within MaxScale configuration files.

  • Description: Writes log messages to the system journal via the system logging interface.

  • Description: Enables sending metrics to OpenTelemetry Collector.

    Description: Global attributes to send with every metric.

  • Description: Path to trusted CA certificate (PEM) used for validating TLS connections in telemetry.

  • Description: Specifies the file path to the TLS public certificate in PEM format for telemetry.

  • Description: Disable TLS certificate validation for telemetry.

  • Description: TLS private key for encrypted telemetry.

  • Description: Defines the minimum interval between sending metrics to the telemetry collector.

  • Description: Defines the OpenTelemetry endpoint where MaxScale pushes metrics.

  • Default: auto
  • Description: Manages the number of worker threads for routing client traffic.

  • Description: Defines the interval for automatically refreshing user accounts from backend servers.

  • Description: Maximum frequency for refreshing user accounts from backend servers after authentication failures.

  • Description: High water mark for network write buffer throttling.

  • Description: Low water mark to disable network write throttling.

  • Description: Manages whether authentication data is loaded from one server or aggregated from all servers.

  • Description: Monitor that defines servers for this service.

  • Auto tune:

  • Description: Send pings to keep idle backend connections alive.

  • Description: Disable session command history entirely.

  • Description: Controls whether the root user is allowed to connect through MaxScale to backend servers.

  • Description: Defines a list of filters applied to client requests before routing to backend servers.

  • Description: Send keepalive pings to any backends even when client is idle.

  • Description: Time idle before pooling backend connections.

  • Description: Log authentication failures and warnings.

  • Description: Enable service-level debug logging.

  • Description: Enable service-level info logging.

  • Description: Enable service-level notice logging.

  • Description: Enable service-level warning logging.

  • Minimum: 0 in MaxScale, 1 in MaxScale Trial.

  • Maximum: Unlimited in MaxScale, 15 in MaxScale Trial.

  • Description: Maximum number of simultaneous connections allowed to this service.

  • Description: Maximum session commands to store for replay.

  • Description: Maximum wait time for backend connection.

  • Description: Disconnects connection if data buffered longer than this duration.

  • Description: Prune old session commands when limit exceeded the configured value.

  • Description: Defines the number of statements MaxScale stores per session.

  • Description: Role to activate after connecting to a server.

    Description: Specifies the backend servers associated with the service.

  • Description: Improves accuracy by enabling backend-based transaction state tracking.

  • Description: Remove escape characters from database names when loading users grants from a backend server.

  • Description: Nested services or servers for multi-level routing.

  • Description: Specifies the path to a JSON file containing additional user accounts for client authentication.

  • ,
    file_only_always
  • Default: add_when_load_ok

  • Description: Specifies when the user accounts file is read instead of or alongside server data.

  • Description: Custom version string sent in MySQL handshake.

    (>= MaxScale 24.02.5, 25.01.2),
    0s
    (<= MaxScale 24.02.4, 25.01.1)
  • Auto tune:

  • Description: Specifies the idle timeout for client sessions before termination.

  • Description: Defines the CA certificate used for validating Vault server connections.
    Description: Specifies the hostname of the Vault server.
    Description: Provides the Key-Value mount path in Vault where secrets are stored.
    Description: Defines the port on which the Vault server listens.
    Description: CA ceritficate for KMIP server.

    Description: Enables SSL encryption for connections when set to true.

  • Description: Specifies the CA certificate used to validate the peer’s certificate.

  • Description: Deprecated - use instead.

  • Description: Specifies the maximum depth of the CA chain during verification.

  • Description: Provides the list of TLS ciphers to use for SSL connections.

  • Description: Specifies the CRL file used to validate revoked SSL certificates.

  • Description: Specifies the path to the SSL/TLS private key that is used for secure connections.

  • Description: Defines the passphrase used to decrypt the SSL/TLS private key.

  • Description: Verifies the peer's SSL/TLS certificate against a trusted CA.

  • Description: Verifies the peer's hostname or IP address using its SSL/TLS certificate.

  • ,
    TLSv1.0
    ,
    TLSv1.1
    ,
    TLSv1.2
    ,
    TLSv1.3
    ,
    TLSv10
    ,
    TLSv11
    ,
    TLSv12
    ,
    TLSv13
  • Default: MAX

  • Description: Lists the TLS protocol versions that are allowed for SSL/TLS connections.

  • Description: Indicates the hostname or address that the listener binds to when a connection is made.

  • Description: Specifies the authenticator module used for client authentication.

  • Description: Provides additional configuration settings for the authenticator module.

  • Description: Specifies a file containing SQL statements executed on backend connections after authentication.

  • Mandatory: No
  • Description: Provides the metadata that is given to clients upon connection as a list of key-value pairs separated by commas.

  • Default: 0
  • Description: Specifies the port on which the listener accepts connections.

  • Description: Defines the protocol module that clients and MaxScale use to communicate.

  • Description: Specifies the database URL that clients are sent to following authentication.

  • Default: ""
  • Description: Defines the Unix domain socket that the listener uses to receive inbound connections.

  • ,
    oracle
  • Default: default

  • Description: Specifies the listener's SQL mode, overriding the global sql_mode setting if it is set.

  • Description: Provides optional backend credentials for MariaDB protocol connections, as well as a JSON file that specifies user and group mappings.

  • Default: ""
  • Description: Specifies the hostname or IP address of the backend server to which MaxScale connects.

  • Description: Defines disk usage threshold that triggers warnings or actions when exceeded.

  • Description: Specifies an alternative port that MaxScale uses for administrative connections to the backend server.

  • ,
    up
    ,
    read
    ,
    write
  • Default: down

  • Description: Provides the initial status of the server when it starts or its reconfigured.

  • Description: Specifies a comma-separated list of user-defined labels assigned to the server.

    Minimum: 0 in MaxScale, 1 in MaxScale Trial.

  • Maximum: Unlimited in MaxScale, 15 in MaxScale Trial.

  • Description: Provides the maximum number of routing connections to the server.

  • Description: Specifies the password that is needed to authenticate server-specific monitoring.

    Description: Specifies the username used for authentication in server‑specific monitoring.

  • Description: Shows how long a connection can stay in the persistent pool before being discarded.

  • Description: Defines the server connection pool's maximum size.

  • Description: Identifies the port that connections are accepted by the backend server.

  • Description: Sets the server's priority for selecting the main node.

  • Description: An alternate hostname or IP address is used for internal communications.

  • Description: Allows the original client IP address and port to be forwarded to backend servers using PROXY protocol headers.

  • ,
    secondary
  • Default: primary

  • Description: Specifies the server's priority when making routing decisions.

  • Default: ""
  • Description: Specifies the Unix domain socket route that is used to establish a connection with the backend server.

  • Description: Manages whether service credentials are used for backend authentication before switching to the client user.

  • Description: Specifies the location of the GSSAPI authentication-related Kerberos keytab file.

  • Description: Defines the service principal name used in GSSAPI authentication.

  • Description: Allows tracking of password hash mismatches during authentication.

  • ,
    mariadb
  • Default: none

  • Description: Manages the mapping of PAM-authenticated users to backend authentication.

  • Description: Specifies a JSON file containing passwords for PAM-mapped users.

    ,
    password_2FA
    ,
    suid
  • Default: password

  • Description: Defines the PAM authentication mode for client login.

  • Description: Enables cleartext password authentication between the client and MaxScale when using PAM.

  • Description: Excludes events, which match the specified regular expression.

    Description: Includes only events that match the given regular expression.

    Description: Specifies the replacement pattern that replication events use to rewrite statements.

    Description: Describes the pattern that is used to match statements in replication events for rewriting.

    ,
    read_only_transactions
    ,
    all_transactions
  • Default: all_transactions

  • Description: Manages how the cache is used and updated during transactions.

  • ,
    thread_specific
  • Default: thread_specific

  • Description: Determines whether cached data remains thread-specific or shared across threads.

  • Description: Controls whether the cache is cleared when modifying statements are not parsed correctly.

  • Description: Uses a bitmask value to control the cache's debug logging level.

  • Description: Manages whether the cache is enabled or disabled at startup.

  • (no limit)
  • Description: Specifies how long cached data can last before being deleted and reloaded.

  • ,
    current
  • Default: never

  • Description: Manages how cached data is invalidated when changes occur.

  • (no limit)
  • Description: Specifies the maximum amount of data that cache can store.

  • (no limit)
  • Description: Defines the maximum number of rows in a result set that can be cached.

  • (no limit)
  • Description: Specifies the maximum result set size that can be cached.

  • (no limit)
  • Description: Defines the maximum total size of the cache.

  • (no rules)
  • Description: Specifies the file path containing caching rules.

  • ,
    verify_cacheable
  • Default: assume_cacheable

  • Description: Controls whether SELECT statements are considered to be cacheable or validated before caching.

  • (no limit)
  • Description: Determines how long cached data is used before being refreshed from the backend.

  • Description: Defines the storage module used by the cache.

  • Description: Deprecated. Previously used to pass configuration options to the storage module.

  • Description: Specifies the timeout for processes involving external storage backends.

  • ,
    isolated
  • Default: mixed

  • Description: Manages whether cached data is stored separately for each user or shared between users.

  • Description: Defines the maximum size of a value that can be stored in the cache.

    Description: Specifies the Memcached server address. The default port is 11211 is used when no port is provided.
  • Description: Password used for authentication.

  • Description: Defines the Redis server address. The default port is 6379 is used when no port is provided.
  • Description: Enable SSL when connectign to the Redis server.

  • Description: Specifies the CA certificate used to verify the Redis server certificate.

  • Description: Defines the SSL client certificate used when connecting to the Redis server.

  • Description: Specifies the private key for the SSL client that is used to connect to the Redis server.

  • Description: Username used for authentication.

  • Description: Defines the number of statements that are sent to the primary following a data-modifying statement.

  • Description: Manages whether write activity from a single connection affects routing behavior for all connections.

  • Description: Defines a pattern for queries that should be ignored.

  • Description: Specifies a pattern for statements that cause re-routing of statements.

  • ,
    case
    ,
    extended
  • Default: ignorecase

  • Description: Defines regular expression options used with match and ignore.

  • Description: Determines the time range during which statements are directed to the primary following a data-modifying statement.

  • Description: Specifies the S3 object storage host.

  • Description: TLS certificate verification is disabled for object storage when enabled.

    Description: Defines the port used to connect to the S3 object storage.

    Values: 0, 1, 2

  • Description: Specifies the protocol version used to communicate with object storage.

  • Description: Defines the S3 region that contains the data.

  • Description: Enables unencrypted HTTP communication with the object storage when set to true.

  • Description: Manages whether masking rules are applied to subqueries.

  • Description: Controls whether masking rules are applied to the UNION queries.

  • Description: Manages whether user variables are applied to user variables.

  • ,
    abort
  • Default: abort

  • Description: Controls how payloads larger than 16MB are managed by the masking filter.

  • Description: Manages whether queries using functions on masked columns are rejected.

  • Description: Determines whether statements that cannot be fully parsed are rejected.

  • Description: Manages if functions' string parameters are managed as fields for masking.

  • ,
    always
  • Default: never

  • Description: Controls whether a column with an unsupported type is matched by a masking rule and whether a warning is logged.

  • Description: Manages the level of debug logging for the MaxRows filter.

  • ,
    error
    ,
    ok
  • Default: empty

  • Description: Regulates the response that is sent to the client when the limitations defined by the results are exceeded.

  • Description: Specifies the maximum number of rows allowed in a result set returned to the client.

  • Description: Restricts the size of a resultset that can be returned to the client; larger resultsets are replaced with an empty result.

  • Description: Defines a numbered regex pattern to match SQL queries and apply a corresponding routing target when the pattern is matched.

    ,
    case
    ,
    extended
  • Default: ignorecase

  • Description: Describes the collection and matching process for the matchXY regular expressions (e.g., case sensitivity or extended syntax).

  • Description: Limits the filter to client connections from particular IP addresses or patterns; the regex rules will only be applied to sessions that match.

    Description: Defines the routing hint used to direct queries that match the corresponding matchXY pattern to specific server or roles.

    Description: Limit the filters to sessions authenticated with a specific username; the routing hints and regex rules will only be applied to matching users.

  • Description: Defines whether a new routing hint is added to existing ones or replaces them when applied to matching queries.

  • Description: Defines the time unit used for logging durations.

  • Description: Defines a regex pattern to exclude queries from matching and filtering.

  • Description: Manages whether log files are immediately flushed to disk after each write operation.

  • ,
    session
    ,
    date
    ,
    user
    ,
    reply_time
    ,
    total_reply_time
    ,
    query
    ,
    default_db
    ,
    num_rows
    ,
    reply_size
    ,
    transaction
    ,
    transaction_time
    ,
    num_warnings
    ,
    error_msg
  • Default: date, user, query

  • Description: Specifies the fields, such as query details, user, timing, and execution metadata, that are present in each log entry.

  • ,
    unified
    ,
    stdout
  • Default: session

  • Description: Defines the logging output type, such as per-session files, a unified log file, or standard output.

  • Description: Specifies a regex pattern for queries ti include and process by the filter.

  • Description: Specifies the string that is used to substitute newline characters in logged queries so that the log output is consistent and readable.

  • ,
    ignorecase
    ,
    extended
  • Default: case

  • Description: Defines the regex matching behavior (case sensitivity and extended syntax) for filter queries.

  • Description: Specifies the string used to separate fields within each log entry.

  • Description: Limits logging to sessions that originate from specific client source addresses.

  • Description: Log queries in canonical format,replacing user-defined constants with placeholders to ensure consistent and secure output.

  • Description: Limits logging to sessions initiated by a specific username.

  • Description: Identifies a file where all queries, matched and unmatched, are logged, mainly for diagnostic purposes.

    Description: Allows runtime logging of matched and unmatched queries with replacements at the info level for diagnostic purposes.

    ,
    case
    ,
    extended
  • Default: ignorecase

  • Description: Determines how the match regex pattern is compiled, including case sensitivity and extended syntax.

  • the specific pattern.

    Description: Restricts the match-and-replace filter to client connections originating from a specified address.

    Description: Limits the match-and-replace filter to sessions initiated by a specific username.

    Description: Defines whether template matching is case-sensitive by default.

    Description: Allows logging of query replacements at the NOTICE level for monitoring and debugging.

    Values: Native, ECMAScript, Posix, EPosix, Awk, Grep, EGrep

  • Description: Overrides the template's default regex grammar, allowing it to be used with alternative regex engines such as ECMAScript or Posix.

  • Description: Specifies the file path to the template used by the filter.

  • Default: From maxscale.cnf

  • Description: Defines the default tes such as Native, ECMAScript, and POSIX.

  • Description: Defines a regex pattern to exclude queries from processing or matching.

    Description: Defines a regex pattern to include only queries that match it for processing or filtering.

    ,
    case
    ,
    extended
  • Default: ignorecase

  • Description: Determines how regular expressions are parsed, including case sensitivity and extended syntax.

  • Description: Specifies the service for which queries are replicated; deprecated in favor of the target parameter.

    Description: Limits query replication to sessions that start from a specific client IP address.

  • Description: Allows synchronous routing, ensuring queries are executed on both the main and branch targets before continuing; branch failures close the client connection.

  • Description: Specifies the branch target, which is the service or server where queries will be replicated.

    Description: Restricts query replication to sessions initiated by a specific username.

    Description: Specifies the time interval used to decide when continuous throttling begins and finishes.

    Description: Defines the time interval during which queries per second (QPS) are mesaured for throttling purposes.

  • Description: Sets the number of SQL statements to store and include in the report.

  • Description: Defines a regex pattern that prevents the filter from logging specific queries.

    Description: Defines a regex pattern that only logs requests that match it, while ignoring others.

    ,
    case
    ,
    extended
  • Default: case

  • Description: Determines how the match and exlcude regex patterns are handled, including case sensitivity and extended syntax.

  • Description: Limits logging to sessions that start from a specific client IP address.

    Description: Limits logging to sessions initiated by a specific username.

    Description: Specifies the directory in which session capture subdirectories are kept for each filter.

    Dynamic: No

  • Description: Determines how long a session capture can run; a value of 0 indicates an infinite duration.

  • Dynamic: No

  • Description: Specifies the maximum session capture size in bytes; a value of 0 indicates no size restriction.

  • Description: Determines whether session capture starts automatically when MaxScale starts.

  • Description: Specifies the maximum number of times MaxScale attempts to connect to a backend during each monitoring cycle.

  • Description: Sets the maximum amount of time allowed to connect to a backend server; deprecated in favor of backend timeout.

  • Description: Specifies the timeout for reading query resuts from a backend server. Deprecated and ignored since MaxScale 25.08.0.

  • Description: Deprecated and ignored since MaxScale 25.10.0.

  • Description: Sets the minimum interval between disk space checks; a value of 0 disables automatic checks.

  • Description: Defines the disk usage limit (per path) that creates alerts. It can be set globally in the monitor or individually per server if disk configurations differ.

    ,
    master_up
    ,
    slave_down
    ,
    slave_up
    ,
    server_down
    ,
    server_up
    ,
    lost_master
    ,
    lost_slave
    ,
    new_master
    ,
    new_slave
  • Default: All events

  • Description: Specifies which server events cause a script to execute; if not provided, it defaults to all events.

  • Description: Sets the maximum age of journal files; older files are deleted when the monitor starts.

  • or
    orgaleramon
    .
  • Description: Determines how often the monitor checks and updates the status of servers; shorter intervals result in more frequent checks.

  • settings.

    Description: Specifies custom SQL commands to be executed on a primary (Master) server when it achieves Master status or when the monitor starts, allowing for role-based configuration changes.

    Description: Specifies custom SQL commands to run on a replica (Slave) server when they get Slave status or when the monitor starts, allowing role-based configuration changes.

    Description: Specifies a user role to activate when the monitor connects to a server, providing privilege separation between monitoring and service operations.

    Description: Specifies a command to execute when the server status changes, with the help of placeholders (such as $INITIATOR, $EVENT, and $MASTERLIST) that MaxScale replaces with relevant server information; script output is reported based on message prefixes.

  • Description: Sets a maximum period of time a script can execute; if this limit exceeds the allowed duration, the script is issued SIGTERM, followed by SIGKILL if it does not stop.

  • .
    can be chosen as the primary for writes, enabling many MaxScale instances to use the same primary node.
    global variable is set on each replica node, listing eligible donor nodes for SST in a sorted order based on priority or
    wsrep_local_index
    .
  • Description: When enabled, the monitor assumes that the server hostnames and ports in the configuration match those provided by the servers, resulting in accurate topology identification and support for cluster actions such as failover and switching.

  • ,
    majority_of_all
    ,
    majority_of_running
  • Default: none

  • Description: Controls how a monitor achieves exclusive locks in multi-MaxScale configurations; decides whether a monitor becomes primary based on the majority of all servers, only running servers, or none at all.

  • Description: Automatically sets read_only on any writable servers that are not the primary and are not under maintenance, ensuring that non-primary servers remain read-only.

  • Description: Automatically sets read_only flag on writable replica servers, allowing only privileged users to write; the primary server is unaffected.

  • Description: Ensures that the primary server is always writable by automatically disabling read-only mode during monitoring.

  • Description: Specifies how many consecutive monitor cycles a primary must fail before being considered down and requiring failover or primary reselection.

  • Description: When disk space is low, non-primary servers are automatically put into maintenance mode, which stops them from being used for sessions or failover unless they are manually removed.

  • ,
    connecting_slave
    ,
    connected_slave
    ,
    running_slave
    ,
    primary_monitor_master
    ,
    disk_space_ok
  • Default: primary_monitor_master, disk_space_ok

  • Description: Specifies additional requirements for a server to be considered primary, such as the availability of connected or running replicas, sufficient disk space, or agreement with supporting monitors.

  • Description: Sets a replication lag threshold (in seconds) that executes the monitor script when exceeded (rlag_above) or returned below (rlag_below); negative values disable this feature.

  • ,
    linked_master
    ,
    running_master
    ,
    writable_master
    ,
    primary_monitor_master
  • Default: none

  • Description: Specifies additional requirements for a server to be identified as a Slave, such as being connected to a running or writable primary; several conditions can be coupled using an enum mask.

  • Description: Provides the backup storage server's hostname or IP address. The server does not have to run MariaDB or be monitored by MaxScale. MaxScale connects via SSH, and the storage must have enough disk space to accommodate all backups.

    Description: Specifies the path to the backup storage host where backups will be saved. The SSH user specified in ssh_user must have full read and write access to this directory.

  • Description: Defines the number of parallel threads to use while running mariadb-backup. This value is used as the --parallel=<val> for mariadb-backup --backup. Increasing this value can accelerate backups on systems with multiple CPUs and fast I/O.

  • Description: Specifies how much memory mariadb-backup should use during the --prepare phase. This value is specified with the --use-memory=<val>. Setting it to an empty string disables the option and allows mariadb-backup to utilize the internal default. Increasing RAM can accelerate backup preparation, especially for large datasets.

  • Description: Specifies the TCP port on which the source server will listen for the rebuild (SST) connection during a state transfer. This port must be open (not blocked by firewalls) and free (not in use by another process). If another process uses the port when the rebuild begins, MaxScale will attempt to terminate it to free up the port.

  • Description: Manages whether MaxScale verifies the SSH host key when connecting to a backend server. When set to true, MaxScale requires that the backend server’s host key is already present in the known_hosts file of the user running MaxScale. This ensures the authenticity of the server during SSH connections.

  • Description: Specifies the SSH private key file used by MaxScale to authenticate when connecting to backend servers.

  • Description: Uses port for SSH connections when executing remote commands on backend servers.

  • Description: Specifies the maximum duration allowed for SSH commands during a rebuild before timing out.

  • Description: Specifies the SSH username for logging in to backend servers to execute commands.

    ,
    on
    ,
    yes
    ,
    1
    ,
    false
    ,
    off
    ,
    no
    ,
    0
    ,
    safe
  • Default: false

  • Description: Enables or disables automated primary failover, which allows MaxScale to select a new primary if the current one fails.

  • Description: Allows automatic redirection of servers to duplicate from the current primary, resulting in a 1-primary-N-replicas architecture.

  • Description: Specifies a SQL file to execute when a server is downgraded; equivalent to promotion_sql_file.

  • Description: Promotes a 1-primary-N-replicas cluster configuration, automatically reconnecting servers and deleting unnecessary replication sources to maintain a simple topology.

  • Description: Sets the maximum time allowed for a failover operation before it is terminated and automatic failover is disabled.

  • Description: Manages whether the monitor tracks and updates scheduled events on servers during offers, demotions, and rejoins.

  • Description: Specifies the duration MaxScale waits before considering a primary server as failed.

  • Description: Specifies a file of SQL statements to execute on a server during promotion to primary.

  • Description: Enables SSL encryption for replication by configuring generated replication commands to use secure connections.

  • Description: Specifies the password used by the replication user for authentication.

    Description: Specifies the username used for replication authentication when configuring replica connections.

  • Description: Lists the servers that are excluded from being promoted to primary during failover or automatic selection.

  • Description: Defines the maximum time allowed for switchover and rejoin operations before timing out.

  • Description: Enables verification of primary server failure using replica status before triggering automatic failover.

  • Dynamic: Yes

  • Description: Defines the action to consider when the primary fails a write text, either logging the failure or triggering a failover.

  • Description: Specifies the fully qualified table used by the monitor to perform primary server write tests.

    Description: Manages whether the replication protocol is permitted through this listener.

    Description: Specifies the database that stores NoSQL account information for authentication.
    Description: Specifies the encryption key ID used to encrypt NoSQL account information in the database.
    Description: Specifies the password for the NoSQL authentication user.
    Description: Determines whether clients are required to authenticate before accessing the service.
    Description: Controls whether NoSQL account information is stored in a shared or private manner.
    Description: Enables or disables NoSQL protocol–level authorization for user management commands.
    Description: Controls whether databases are automatically created when required.
    Description: Controls whether tables are automatically created within existing databases when required.
    Description: Sets the maximum idle time before an inactive cursor is automatically closed.
  • Default: none

  • Description: Manages which protocol events are logged, including incoming commands, backend SQL, and client responses.

  • Description: Specifies the host portion of the MariaDB user account created via the NoSQL protocol.
    *Default: 35
  • Description: Sets the length of the id column for automatically created tables.

  • filter.
    Description: Determines whether unsupported or unknown client commands are logged for debugging.

    Default: return_error

  • Description: Defines how the system responds to unrecognized client commands, either with an error or an empty result.

  • Default: default

  • Description: Controls whether multi-document inserts are performed completely or individually based on the ordered setting.

  • Description: Specifies the password used for backend connections when the MongoDB client is unauthenticated.
    Description: Specifies the username used for backend connections when the MongoDB client is unauthenticated.

    data.relationships.services.data

  • The service relationships data, must define a JSON object with an id value that defines the service to use and a type value set to services.

  • data.attributes.parameters.user
  • The to use

  • data.attributes.parameters.password

  • The to use

  • data.attributes.parameters.port

  • The to use. Needs to be defined if the address field is defined.

  • data.attributes.parameters.user
  • The to use

  • data.attributes.parameters.password

  • The to use

  • Description: Specifies the directory where files are archived when expiration_mode is set to archive.

    ,
    zstandard
  • Default: none

  • Description: Defines the compression algorithm to use for archived files.

  • Description: Shows the directory where binary log files are stored.

  • Description: When enabled, only DDL events (CREATE, ALTER, DROP) are logged, excluding data changes.

    ,
    AES_CTR
    ,
    AES_GCM
  • Default: AES_GCM

  • Description: Defines the AES encryption mode used for securing data, such as GCM, CBC, or CTR.

  • Description: Specifies the encryption key ID used to encrypt binary logs, requiring a configured key manager.

  • Default: purge

  • Description: Indicates whether expired logs are automatically deleted or archived.

  • Description: Sets the duration after which binary log files expire and are eligible for purge or archiving.

  • Description: Determines the minimum number of binary log files to keep during automatic purging.

  • Description: Sets the network connection and read timeout for the primary server connection.

  • Description: Specifies the minimum number of binary log files to keep up uncompressed.

  • Description: Enables semi-synchronous replication from a MariaDB server by sending acknowledgements for received events.

  • Description: Selects a primary server for replication automatically from a list of servers that are monitored and have Master status.

  • Description: Mentions the server ID used by MaxScale for replication and serving binary logs to replicas.

  • ,
    other
    , `both'
  • Default: both

  • Description: Determines whether queries are EXPLAINed on the main server, other servers, or both.

  • Description: Sets the maximum number of times a canonical statement is EXPLAINed throughout the explain period.

    Description: Defines the time window over which the explain_entries limit applies for EXPLAIN operations.

    Description: Sets the maximum allowed request la on replica servers before SELECTs are skipped to connect with the primary server.

    ,
    ignore
  • Default: ignore

  • Description: Determines whether errors from replica servers close the session or are are ignored.

  • Max: 100

  • Default: 99

  • Description: Defines the percentile of samples used to calculate histogram width and bin count.

  • Description: Specifies the time window over which queries per second (QPS) are calculated and logged.

    ,
    on_discrepancy
    ,
    never
  • Default: on_discrepancy

  • Description: Defines when results from main and other executions are logged: always, on discrepancy, or never.

  • Description: Controls whether replication on other is reset and restarted after a read-write Diff session completes.

  • Description: Sets how many of the fastest statements are kept in memory for summary reporting.

    Description: Sets how many of the slowest statements are kept in memory for summary reporting.

    Default: 1000

  • Description: Defines the number of samples collected to determine histrogram bin edges and counts.

  • ,
    read_write
  • Default: read_only

  • Description: Determines whether the Exasolrouter appears as read-only or read-write to other MaxScale components.

  • ,
    activate-only
    ,
    custom:<path>
    ,
    disabled
  • Default: auto

  • Description: Defines how the Exasol preprocesser script is managed: auto-installed, activate-only, custom path, or disabled.

  • Description: Specifies the name of a custom Exasol preprocessor script when using a custom preprocessor path.

    format for connecting to the cluster.
  • Description: Enables coperative replication, allowing multiple MaxScale instances to replicate from the same cluster while ensuring each event is processed only once.

  • Description: Enables idempotent Kafka producer mode to reduce duplicate message delivery and preserve message order.

  • Description: Excludes tables matching a specified pattern from being sent to Kafka.

  • Description: Specifies the initial GTID position for replication; supports newest and oldest special values.

  • ,
    SCRAM-SHA-256
    ,
    SCRAM-SHA-512
  • Default: PLAIN

  • Description: Specifies the SASL authentication mechanism for connecting to Kafka, such as PLAIN or SCRAM-SHA variants.

  • Description: Specifies the password used for SASL authentication with Kafka.

  • Description: Specifies the username used for SASL authentication with Kafka.

  • Description: Enables SSL encryption for Kafka connections.

  • Description: Specifies the path to the CA certificate file for SSL Kafka connections.

  • Description: Specifies the path to the client SSL certificate file for Kafka connections.

  • Description: Specifies the path to the client SSL private key for Kafka connections.

  • Description: Includes only tables whose combined database and table names match the specified pattern for Kafka replication.

  • Description: Determines whether to read the latest GTID from Kafka on startup to resume replication.

  • Description: Controls whether table schema change events are sent as JSON objects into the Kafka stream.

  • Description: Specifies the server ID used when connecting to the primary for replication.

  • Description: Defines the timeout for establishing and reading from the replication stream connection.

  • Description: Defines the maximum number of records to buffer before committing a batch of imported data.

  • Dynamic: Yes
  • Description: Specifies the storage engine used when creating tables for imported Kafka data.

  • ,
    SCRAM-SHA-256
    ,
    SCRAM-SHA-512
  • Default: PLAIN

  • Description: Specifies the SASL authentication mechanism used for Kafka connections.

  • Description: Specifies the SASL password for Kafka authentication, requiring a corresponding username.

  • Description: Specifies the SASL username for Kafka authentication, requiring a corresponding password.

  • Description: Enables or disables SSL encryption for Kafka connections.

  • Description: Specifies the CA certificate file used to verify Kafka SSL connections, or defaults to the system CA.

  • Description: Defines the SSL certificate file for Kafka connections, requiring a corresponding private key.

  • Description: Specifies the SSL private key file for Kafka connections, requiring a corresponding certificate.

  • ,
    key
  • Default: topic

  • Description: Defines whether the Kafka topic or message key is used to determine the target table for data insertion.

  • Description: Sets the timeout for network communication with both Kafka and MariaDB.

  • ,
    file
    ,
    kafka
  • Description: Specifies the destination where metrics are exported, such as log, file, or Kafka.

  • Description: Specifies the file path where metrics are written when the file exporter is enabled.

    Description: Specifies the list of Kafka brokers used to send metrics when the Kafka exporter is enabled.

    Description: Specifies the Kafka topic used to publish metrics when the Kafka exporter is enabled.

    Dynamic: Yes
  • Values: ignore, close

  • Description: Defines how backend connection failures are handled, either by ignoring them or closing the client connection.

  • Dynamic: Yes
  • Values: always, on_conflict

  • Description: Determines when query results are reported to the client, either always or only on conflicts.

  • Description: Determines whether read queries are routed to the primary server when selecting servers.

    Description: Sets the maximum allowed replication lag for a server to be used for routing.

    ,
    slave
    ,
    synced
    ,
    running
  • Default: running

  • Description: Specifies which server roles are eligible for connections when establishing new router sessions.

  • ,
    local
    ,
    global
    ,
    fast
    ,
    fast_global
    ,
    universal
    ,
    fast_universal
  • Default: none

  • Description: Controls causal read behavior to ensure reads reflect prior writes despite replication lag.

  • Description: Defines how long to wait for replica synchronization when using causal reads before timing out.

    Description: Enables retrying failed queries for a limited time before returning an error if no server becomes available.

    Description: Specifies how long to wait before returning an error to the client when delayed retries are enabled.

    Description: Enables on-demand creation of backend connections instead of opening all connections at session start.

    Description: Determines whether the primary server can be used to handle read queries alongside replicas.

    ,
    fail_on_write
    ,
    error_on_write
  • Default: fail_on_write (MaxScale 23.08: fail_instantly)

  • Description: Defines how the router handles primary server failure and client behavior during write operations.

  • Description: Controls whether a session can reconnect to a new primary server if the current one becomes unavailable.

    Description: Sets the maximum allowed replication lag for replicas to be eligible for routing read queries.

    Max: 255

  • Default: 255

  • Description: Limits the maximum number of replica connections a session can use simultaneously.

  • Description: Determines whether failed autocommit read queries are retried on another replica.

    Description: Specifies the initial number of replica connections a session creates for routing read queries.

    ,
    adaptive_routing
    ,
    least_behind_master
    ,
    least_router_connections
    ,
    least_global_connections
  • Default: least_current_operations

  • Description: Defines the criteria used to select replica servers for routing read queries and balancing load.

  • Description: Ensures that all queries after a multi-statement query are routed to the primary to maintain session consistency.

    Description: Ensures that queries following a stored procedure call are routed to the primary to maintain consistency.

    Description: Controls whether temporary tables block reconnections, ensuring they are not lost during primary node failovers.

    ,
    soft
    ,
    hard
  • Default: none

  • Description: Defines how transactions are synchronized across replicas, with options for no synchronization, soft (non-blocking), or hard (blocking) synchronization.

  • Max: 255

  • Default: 1

  • Description: Specifies the minimum number of backend servers required to understand a transaction before it is considered committed.

  • Description: Sets the maximum allowed transaction synchronization latency in soft mode before triggering synchronization.

    Description: Sets the maximum time a transaction waits for synchronization before returning or closing the connection.

    Description: Enables replay of interrupted transactions, automatically retrying them on a replacement server if the current one fails.

    Description: Determines the maximum number of times a transaction will be retried during replay before failing.

    ,
    result_only
    ,
    no_insert_id
  • Default: full

  • Description: Specifies the method for calculating transaction checksums to verify replayed transactions; full ensures complete consistency.

  • Description: Sets the maximum transaction size (in bytes) that can be replayed; larger transactions are not replayed.

    Description: Automatically retries transactions that encounter a deadlock until they succeed or a checksum error occurs.

    Description: Retries transactions that fail due to checksum mismatches during replay, subject to the set limits.

    Description: Prevents replaying transactions that are about to commit to avoid duplicates; enabled by default.

    Description: Sets the maximum duration for attempting transaction replay; set to 0 to disable.

    ,
    all
  • Default: all

  • Description: Controls which nodes handle SELECT statements using SQL user variables; defaults to all nodes.

  • Description: Disables the detection of duplicate tables on shards while it is enabled.

  • Description: Specifies a list of full table names to ignore when checking for duplicate tables.

  • Description: Defines a PCRE2 regular expression to ignore specific tables when checking for duplicate databases.

  • Description: Specifies how long stale database map entries can be used by new connections while an update is in progress.

  • Description: Allows the database map to be refreshed when a USE... query fails during a session.

  • Description: Sets the minimum interval between database map refreshes to maintain cluster metadata up to date.

  • module
    admin_audit
    boolean
    admin_audit_exclude_methods
    enum
    admin_audit_file
    admin_auth
    boolean
    admin_enabled
    boolean
    admin_gui
    boolean
    admin_host
    admin_jwt_algorithm
    enum
    admin_jwt_issuer
    admin_jwt_key
    admin_jwt_max_age
    duration
    admin_log_auth_failures
    boolean
    admin_oidc_client_id
    admin_oidc_client_secret
    admin_oidc_extra_options
    admin_oidc_flow
    enum
    admin_oidc_ssl_insecure
    boolean
    admin_oidc_url
    admin_pam_readonly_service
    admin_pam_readwrite_service
    admin_port
    admin_readwrite_hosts
    admin_secure_gui
    boolean
    admin_ssl_ca
    admin_ssl_cert
    admin_ssl_cipher
    admin_ssl_key
    admin_ssl_passphrase
    admin_ssl_version
    enum_mask
    admin_verify_url
    auth_connect_timeout
    duration
    auto_tune
    config_sync_cluster
    config_sync_db
    config_sync_interval
    duration
    config_sync_password
    config_sync_timeout
    duration
    config_sync_user
    connector_plugindir
    core_file
    boolean
    datadir
    debug
    dump_last_statements
    enum
    host_cache_size
    key_manager
    enum
    libdir
    load_persisted_configs
    boolean
    local_address
    log_augmentation
    log_debug
    boolean
    log_info
    boolean
    log_notice
    boolean
    log_throttling
    duration
    duration
    log_warn_super_user
    boolean
    log_warning
    boolean
    logdir
    max_auth_errors_until_block
    maxlog
    boolean
    module_configdir
    ms_timestamp
    boolean
    passive
    boolean
    persist_runtime_changes
    boolean
    persistdir
    piddir
    query_classifier_cache_size
    size
    query_retries
    query_retry_timeout
    duration
    rebalance_period
    duration
    rebalance_threshold
    rebalance_window
    require_secure_transport
    boolean
    retain_last_statements
    secretsdir
    session_trace
    session_trace_match
    regex
    sharedir
    skip_name_resolve
    boolean
    sql_mode
    enum
    substitute_variables
    boolean
    syslog
    boolean
    telemetry
    boolean
    telemetry_attributes
    telemetry_ssl_ca
    telemetry_ssl_cert
    telemetry_ssl_insecure
    boolean
    telemetry_ssl_key
    telemetry_update_interval
    duration
    telemetry_url
    threads
    threads_max
    trace_file_dir
    trace_file_size
    size
    users_refresh_interval
    duration
    users_refresh_time
    duration
    writeq_high_water
    size
    writeq_low_water
    size
    auth_all_servers
    boolean
    cluster
    connection_keepalive
    duration
    disable_sescmd_history
    boolean
    enable_root_user
    boolean
    filters
    force_connection_keepalive
    boolean
    idle_session_pool_time
    duration
    log_auth_warnings
    boolean
    log_debug
    boolean
    log_info
    boolean
    log_notice
    boolean
    log_warning
    boolean
    max_connections
    max_sescmd_history
    multiplex_timeout
    duration
    net_write_timeout
    durations
    password
    prune_sescmd_history
    boolean
    retain_last_statements
    role
    router
    servers
    session_track_trx_state
    boolean
    strip_db_esc
    boolean
    targets
    user
    user_accounts_file
    user_accounts_file_usage
    enum
    version_string
    wait_timeout
    duration
    file.keyfile
    vault.ca
    vault.host
    vault.mount
    vault.port
    vault.timeout
    duration
    vault.tls
    boolean
    vault.token
    kmip.ca
    kmip.cert
    kmip.host
    kmip.key
    kmip.port
    ssl
    boolean
    ssl_ca
    ssl_cert
    ssl_cert_verify_depth
    ssl_cipher
    ssl_crl
    ssl_key
    ssl_passphrase
    ssl_verify_peer_certificate
    boolean
    ssl_verify_peer_host
    boolean
    ssl_version
    enum_mask
    maxscale-listeners
    address
    authenticator
    authenticator_options
    connection_init_sql_file
    connection_metadata
    port
    protocol
    redirect_url
    service
    socket
    sql_mode
    enum
    user_mapping_file
    maxscale-servers
    address
    disk_space_threshold
    extra_port
    initial_status
    labels
    max_routing_connections
    monitorpw
    monitoruser
    persistmaxtime
    duration
    persistpoolmax
    port
    priority
    private_address
    proxy_protocol
    boolean
    rank
    enum
    replication_custom_options
    socket
    use_service_credentials
    boolean
    maxscale-gssapi-client-authenticator
    gssapi_keytab_path
    principal_name
    maxscale-mariadb-mysql-authenticator
    log_password_mismatch
    boolean
    maxscale-pam-authenticator
    pam_backend_mapping
    enumeration
    pam_mapped_pw_file
    pam_mode
    enumeration
    pam_use_cleartext_plugin
    boolean
    maxscale-binlog-filter
    exclude
    regex
    match
    regex
    rewrite_dest
    regex
    rewrite_src
    regex
    maxscale-cache
    cache_in_transactions
    enum
    cached_data
    enum
    clear_cache_on_parse_errors
    boolean
    debug
    enabled
    boolean
    hard_ttl
    duration
    invalidate
    enum
    max_count
    max_resultset_rows
    max_resultset_size
    size
    max_size
    size
    rules
    selects
    enum
    soft_ttl
    duration
    storage
    storage_options
    timeout
    duration
    users
    enum
    max_value_size
    size
    server
    password
    server
    ssl
    boolean
    ssl_ca
    ssl_cert
    ssl_key
    username
    maxscale-comment-filter
    inject
    maxscale-consistent-critical-read-filter
    count
    global
    boolean
    ignore
    regex
    match
    regex
    options
    enum
    time
    duration
    maxscale-ldi-filter
    host
    key
    no_verify
    boolean
    port
    protocol_version
    region
    secret
    use_http
    boolean
    maxscale-masking-filter
    check_subqueries
    bool
    check_unions
    bool
    check_user_variables
    bool
    large_payload
    enum
    prevent_function_usage
    bool
    require_fully_parsed
    bool
    rules
    treat_string_arg_as_field
    bool
    warn_type_mismatch
    enum
    maxscale-maxrows-filter
    debug
    max_resultset_return
    enum
    max_resultset_rows
    max_resultset_size
    size
    maxscale-named-server-filter
    matchXY
    regex
    options
    enum
    source
    targetXY
    user
    maxscale-query-log-all-filter
    append
    bool
    duration_unit
    exclude
    regex
    filebase
    flush
    bool
    log_data
    enum_mask
    log_type
    enum_mask
    match
    regex
    newline_replacement
    options
    enum_mask
    separator
    source
    source_exclude
    regex
    source_match
    regex
    use_canonical_form
    bool
    user
    user_exclude
    regex
    user_match
    regex
    maxscale-regex-filter
    log_file
    log_trace
    match
    regex
    options
    enum
    replace
    source
    user
    maxscale-rewrite-filter
    case_sensitive
    boolean
    log_replacement
    boolean
    regex_grammar
    template_file
    case_sensitive
    boolean
    continue_if_matched
    boolean
    ignore_whitespace
    boolean
    regex_grammar
    what_if
    boolean
    maxscale-tee-filter
    exclude
    regex
    match
    regex
    options
    enum
    service
    source
    sync
    boolean
    target
    user
    maxscale-throttle-filter
    continuous_duration
    duration
    max_qps
    sampling_duration
    duration
    throttling_duration
    duration
    maxscale-top-filter
    count
    exclude
    regex
    filebase
    match
    regex
    options
    enum
    source
    user
    maxscale-workload-capture-and-replay
    capture_dir
    capture_duration
    duration
    capture_size
    size
    start_capture
    boolean
    common-monitor-parameters
    backend_connect_attempts
    backend_connect_timeout
    duration
    backend_read_timeout
    duration
    backend_write_timeout
    duration
    disk_space_check_interval
    duration
    disk_space_threshold
    events
    enum
    journal_max_age
    duration
    module
    monitor_interval
    duration
    password
    primary_state_sql
    replica_state_sql
    role
    script
    script_timeout
    duration
    servers
    user
    galera-monitor
    available_when_donor
    boolean
    disable_master_failback
    boolean
    disable_master_role_setting
    boolean
    root_node_as_master
    boolean
    set_donor_nodes
    boolean
    use_priority
    boolean
    mariadb-monitor
    assume_unique_hostnames
    boolean
    cooperative_monitoring_locks
    enum
    enforce_read_only_servers
    boolean
    enforce_read_only_slaves
    boolean
    enforce_writable_master
    boolean
    failcount
    maintenance_on_low_disk_space
    boolean
    master_conditions
    enum_mask
    script_max_replication_lag
    slave_conditions
    enum_mask
    backup_storage_address
    backup_storage_path
    mariadb_backup_parallel
    mariadb_backup_use_memory
    rebuild_port
    ssh_check_host_key
    boolean
    ssh_keyfile
    ssh_port
    ssh_timeout
    duration
    ssh_user
    auto_failover
    enum
    auto_rejoin
    boolean
    demotion_sql_file
    enforce_simple_topology
    boolean
    failover_timeout
    duration
    handle_events
    boolean
    master_failure_timeout
    duration
    promotion_sql_file
    replication_master_ssl
    boolean
    replication_password
    replication_user
    servers_no_promotion
    boolean
    switchover_timeout
    duration
    verify_master_failure
    boolean
    write_test_fail_action
    enum
    write_test_interval
    duration
    write_test_table
    maxscale-mariadb-protocol-module
    allow_replication
    boolean
    maxscale-nosql-protocol-module
    authentication_db
    authentication_key_id
    authentication_password
    authentication_required
    boolean
    authentication_shared
    boolean
    authentication_user
    authorization_enabled
    boolean
    auto_create_databases
    boolean
    auto_create_tables
    boolean
    cursor_timeout
    duration
    debug
    enum_mask
    host
    id_length
    internal_cache
    log_unknown_command
    boolean
    on_unknown_command
    enum
    ordered_insert_behavior
    enum
    password
    user
    maxscale-filter-resource
    maxscale-listener-resource
    maxscale-monitor-resource
    maxscale-server-resource
    address
    socket
    maxscale-service-resource
    maxscale-binlogrouter
    archivedir
    compression_algorithm
    enum
    datadir
    ddl_only
    boolean
    encryption_cipher
    enum
    encryption_key_id
    expiration_mode
    enum
    expire_log_duration
    duration
    expire_log_minimum_files
    net_timeout
    duration
    number_of_noncompressed_files
    rpl_semi_sync_slave_enabled
    boolean
    select_master
    boolean
    server_id
    maxscale-diff
    explain
    enum
    explain_entries
    explain_period
    duration
    main
    max_request_lag
    on_error
    enum
    percentile
    qps_window
    duration
    report
    enum
    reset_replication
    boolean
    retain_faster_statements
    retain_slower_statements
    samples
    service
    maxscale-exasolrouter
    appearance
    enum
    connection_string
    preprocessor
    preprocessor_script
    maxscale-kafkacdc
    bootstrap_servers
    cooperative_replication
    boolean
    enable_idempotence
    boolean
    exclude
    regex
    gtid
    kafka_sasl_mechanism
    enum
    kafka_sasl_password
    kafka_sasl_user
    kafka_ssl
    boolean
    kafka_ssl_ca
    kafka_ssl_cert
    kafka_ssl_key
    match
    regex
    read_gtid_from_kafka
    boolean
    send_schema
    boolean
    server_id
    timeout
    duration
    topic
    maxscale-kafkaimporter
    batch_size
    bootstrap_servers
    engine
    kafka_sasl_mechanism
    enum
    kafka_sasl_password
    kafka_sasl_user
    kafka_ssl
    boolean
    kafka_ssl_ca
    kafka_ssl_cert
    kafka_ssl_key
    table_name_in
    enum
    timeout
    duration
    topics
    maxscale-mirror
    exporter
    enum
    file
    kafka_broker
    kafka_topic
    main
    on_error
    enum
    report
    enum
    maxscale-readconnroute
    master_accept_reads
    boolean
    max_replication_lag
    duration
    router_options
    enum_mask
    maxscale-readwritesplit
    causal_reads
    enum
    causal_reads_timeout
    duration
    delayed_retry
    boolean
    delayed_retry_timeout
    duration
    lazy_connect
    boolean
    master_accept_reads
    boolean
    master_failure_mode
    enum
    master_reconnection
    boolean
    max_replication_lag
    duration
    max_slave_connections
    retry_failed_reads
    boolean
    slave_connections
    slave_selection_criteria
    enum
    strict_multi_stmt
    boolean
    strict_sp_calls
    boolean
    strict_tmp_tables
    boolean
    sync_transaction
    enum
    sync_transaction_count
    sync_transaction_max_lag
    duration
    sync_transaction_timeout
    duration
    transaction_replay
    boolean
    transaction_replay_attempts
    transaction_replay_checksum
    enum
    transaction_replay_max_size
    size
    transaction_replay_retry_on_deadlock
    boolean
    transaction_replay_retry_on_mismatch
    boolean
    transaction_replay_safe_commit
    boolean
    transaction_replay_timeout
    duration
    use_sql_variables_in
    enum
    maxscale-schemarouter
    allow_duplicates
    boolean
    ignore_tables
    ignore_tables_regex
    regex
    max_staleness
    duration
    refresh_databases
    boolean
    refresh_interval
    duration
    maxscale-smartrouter
    master
    spinner
    cooperative monitoring
    Yes
    Yes
    ssl_ca
    user
    password
    port
    user
    password