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.

Configuration Settings

General

Global Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: GET, PUT, POST, PATCH, DELETE, HEAD, OPTIONS, CONNECT, TRACE

  • Default: No exclusions

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

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

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: "127.0.0.1"

  • Type: enum

  • Mandatory: No

  • Dynamic: No

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

  • Default: auto

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: maxscale

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 24h

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • 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: boolean

  • 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

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: No

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

  • Default: MAX

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string list

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

  • Default: No

  • Mandatory: No

  • Dynamic: No

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/cache/maxscale

  • Type: monitor

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: mysql

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5s

  • Type: password

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: OS Dependent

  • Type: boolean

  • Default: true

  • Dynamic: No

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: on_close, on_error, never

  • Default: never

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /usr/bin

  • Type: integer

  • Default: 128

  • Dynamic: Yes

  • Type: enum

  • Dynamic: Yes

  • Values: none, file, kmip, vault

  • Default: none

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale/

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: OS Dependent

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number, duration, duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10, 1000ms, 10000ms

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: boolean

  • 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: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: No

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

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Default: true

  • Dynamic: No

  • Type: path

  • Mandatory: No

  • Dynamic: No

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

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /run/maxscale

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Default: System Dependent

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 1

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 20

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /usr/share/maxscale

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: default, oracle

  • Default: default

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: number or auto

  • Mandatory: No

  • Dynamic: No

  • Default: auto

  • Type: positive integer

  • Default: 256

  • Dynamic: No

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 30s

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Default: 65536

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1024

Listener

  • 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

  • Mandatory: No

  • Type: number

  • Mandatory: Yes, if socket is not provided.

  • Dynamic: No

  • Default: 0

  • Type: protocol

  • Mandatory: No

  • Dynamic: No

  • Default: mariadb

  • Type: service

  • Mandatory: Yes

  • Dynamic: No

  • Type: string

  • Mandatory: Yes, if port is not provided.

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: default, oracle

  • Default: default

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

Server

  • Type: string

  • Mandatory: Yes, if socket is not provided.

  • Dynamic: Yes

  • Default: ""

  • Type: Custom

  • Mandatory: No

  • Dynamic: No

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: duration

  • 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: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: primary, secondary

  • Default: primary

  • Type: string

  • Default: None

  • Dynamic: Yes

  • Type: string

  • Mandatory: Yes, if address is not provided.

  • Dynamic: Yes

  • Default: ""

Service

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: monitor

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 300s

  • Auto tune: Yes

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: filter list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: boolean

  • Mandatory No

  • Dynamic: Yes

  • Default: false

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1s

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 50

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 60s

  • Type: durations

  • Mandatory No

  • Dynamic: Yes

  • Default: 0s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1

  • Type: router

  • Mandatory: Yes

  • Dynamic: No

  • Type: server list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: target list

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: add_when_load_ok, file_only_always

  • Default: add_when_load_ok

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: None

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Auto tune: Yes

Settings for File-based Key Manager

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

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: boolean

  • Default: true

  • Dynamic: Yes

  • Type: password

  • Mandatory: Yes

  • Dynamic: Yes

Settings for KMIP Key Manager

  • Type: path

  • Default: ""

  • Dynamic: Yes

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: integer

  • Mandatory: Yes

  • Dynamic: Yes

Settings for TLS/SSL Encryption

  • Type: boolean

  • 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: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory No

  • Dynamic: Yes

  • Default: false

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: No

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

  • Default: MAX

Authenticators

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 0

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

Settings

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: Kerberos Default

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: mariadb/localhost.localdomain

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

Settings

  • Mandatory: No

  • Dynamic: No

  • Values: none, mariadb

  • Default: none

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: None

  • Mandatory: No

  • Dynamic: No

  • Values: password, password_2FA, suid

  • Default: password

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

Filters

Settings

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: regex

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: regex

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: ignorecase, case, extended

  • Default: ignorecase

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 60s

Settings

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: never, read_only_transactions, all_transactions

  • Default: all_transactions

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: shared, thread_specific

  • Default: thread_specific

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 0s (no limit)

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: never, current

  • Default: never

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 0 (no limit)

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 0 (no limit)

  • Type: size

  • Mandatory: No

  • Dynamic: No

  • Default: 0 (no limit)

  • Type: size

  • Mandatory: No

  • Dynamic: No

  • Default: 0 (no limit)

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: "" (no rules)

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: assume_cacheable, verify_cacheable

  • Default: assume_cacheable

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 0s (no limit)

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: storage_inmemory

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default:

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 5s

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: mixed, isolated

  • Default: mixed

storage_memcached

  • Type: size

  • 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: boolean

  • 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: ""

Settings

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

Settings

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: s3.amazonaws.com

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Values: 0, 1, 2

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: us-east-1

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

Settings

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignore, abort

  • Default: abort

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: never, always

  • Default: never

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: empty, error, ok

  • Default: empty

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: (no limit)

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Default: 64Ki

Settings

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase, case, extended

  • Default: 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

Settings

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: milliseconds

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

  • Values: service, 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

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

  • Values: session, unified, stdout

  • Default: session

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: " "

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

  • Values: case, ignorecase, extended

  • Default: case

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ","

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Type: bool

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

Settings

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: regex

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase, case, extended

  • Default: ignorecase

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: Native

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

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Default: No default value

Settings per template in the template file

  • Type: boolean

  • Default: From maxscale.cnf

  • Type: string

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

  • Default: From maxscale.cnf

Settings

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignorecase, case, extended

  • Default: ignorecase

  • Type: service

  • Mandatory: No

  • Dynamic: Yes

  • Default: none

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: target

  • Mandatory: No

  • Dynamic: Yes

  • Default: none

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2s

  • Type: number

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 250ms

  • Type: duration

  • Mandatory: Yes

  • Dynamic: Yes

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: ignorecase, case, extended

  • Default: case

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings

  • Type: path

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

  • Mandatory: No

  • Dynamic: No

  • Type: duration

  • Default: 0s

  • Mandatory: No

  • Dynamic: No

  • Type: size

  • Default: 0

  • Mandatory: No

  • Dynamic: No

  • Type: boolean

  • Default: false

  • Mandatory: No

  • Dynamic: No

Monitors

Settings

  • Type: boolean

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Default: false

  • Dynamic: Yes

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: none, majority_of_all, majority_of_running

  • Default: none

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

  • Values: none, connecting_slave, connected_slave, running_slave, primary_monitor_master, disk_space_ok

  • Default: primary_monitor_master, disk_space_ok

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: -1

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

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

  • Default: 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: 4444

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: path

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 22

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

Settings for Cluster manipulation operations

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: true, on, yes, 1, false, off, no, 0, safe

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: boolean

  • 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

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

Settings for Primary server write test

  • Type: enum

  • Default: log

  • Values: log, failover

  • Dynamic: Yes

  • Type: string

  • Dynamic: Yes

  • Default: mxs.maxscale_write_test

Settings

  • Type: number

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 3s

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: master_down, master_up, slave_down, slave_up, server_down, server_up, lost_master, lost_slave, new_master, new_slave

  • Default: All events

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 28800s

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: None

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 90s

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

Protocols

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

Settings

  • Type: string

  • Mandatory: No

  • Default: "NoSQL"

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type: boolean

  • Mandatory: No

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Default: false

  • Type: string

  • Mandatory: Yes, if authentication_shared is true.

  • Type: boolean

  • Mandatory: No

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Default: true

  • Type: enum_mask

  • Mandatory: No

  • Values: none, in, out, back

  • Default: none

  • Type: string

  • Mandatory: No

  • Default: "%"

  • Type: count

  • Mandatory: No

  • Range: [35, 2048]

  • *Default: 35

  • Type: string

  • Mandatory: No

  • Default: ''

  • Type: boolean

  • Mandatory: No

  • Default: false

  • Type: enum

  • Mandatory: No

  • Values: return_error, return_empty

  • Default: return_error

  • Type: enum

  • Mandatory: No

  • Values: atomic, default

  • Default: default

  • Type: string

  • Mandatory: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Default: ""

Routers

Settings

  • Type: string

  • Mandatory: Yes

  • Default: No

  • Dynamic: No

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: none, zstandard

  • Default: none

  • Type: path

  • Mandatory: No

  • Dynamic: No

  • Default: /var/lib/maxscale/binlogs

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: enum

  • Mandatory: No

  • Dynamic: No

  • Values: AES_CBC, AES_CTR, AES_GCM

  • Default: AES_GCM

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Dynamic: No

  • Values: purge, archive

  • Default: purge

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 0s

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 2

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 10s

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 2

  • Type: boolean

  • Mandatory: No

  • Default: false

  • Dynamic: Yes

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: count

  • Mandatory: No

  • Dynamic: No

  • Default: 1234

Settings

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: none, other, `both'

  • Default: both

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 2

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 15m

  • Type: server

  • Mandatory: Yes

  • Dynamic: No

  • Type: non-negative integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: close, ignore

  • Default: ignore

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Min: 1

  • Max: 100

  • Default: 99

  • Type: duration

  • Mandatory: No

  • Dynamic: No

  • Default: 15m

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: always, on_discrepancy, never

  • Default: on_discrepancy

  • Type: boolean

  • 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

  • Default: 1000

  • Type: service

  • Mandatory: Yes

  • Dynamic: No

Settings

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: enum

  • Mandatory: No

  • Dynamic: No

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

  • Default: PLAIN

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: boolean

  • 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: regex

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: true

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: number

  • Mandatory: No

  • Dynamic: No

  • Default: 1234

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: string

  • Mandatory: Yes

  • Dynamic: No

Settings

  • Type: count

  • Mandatory: No

  • Dynamic: Yes

  • Default: 100

  • Type: string

  • Mandatory: Yes

  • Dynamic: Yes

  • Type: string

  • Default: InnoDB

  • Mandatory: No

  • Dynamic: Yes

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

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

  • Default: PLAIN

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: string

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: boolean

  • 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: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: topic, key

  • Default: topic

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5000ms

  • Type: stringlist

  • Mandatory: Yes

  • Dynamic: Yes

Settings

  • Type: enum

  • Mandatory: Yes

  • Dynamic: Yes

  • Values: log, file, kafka

  • 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

  • Type: enum

  • Default: ignore

  • Mandatory: No

  • Dynamic: Yes

  • Values: ignore, close

  • Type: enum

  • Default: always

  • Mandatory: No

  • Dynamic: Yes

  • Values: always, on_conflict

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: enum_mask

  • Mandatory: No

  • Dynamic: Yes

  • Values: master, slave, synced, running

  • Default: running

Settings

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

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

  • Default: none

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 10s

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: fail_instantly, fail_on_write, error_on_write

  • Default: fail_on_write (MaxScale 23.08: fail_instantly)

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

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

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 0s

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 255

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 255

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

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

  • Default: least_current_operations

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

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

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: integer

  • Mandatory: No

  • Dynamic: Yes

  • Default: 5

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: full, result_only, no_insert_id

  • Default: full

  • Type: size

  • Mandatory: No

  • Dynamic: Yes

  • Default: 1 MiB

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: true

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

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

  • Type: enum

  • Mandatory: No

  • Dynamic: Yes

  • Values: master, all

  • Default: all

Settings

  • Type: boolean

  • Mandatory: No

  • Dynamic: Yes

  • Default: false

  • Type: stringlist

  • Mandatory: No

  • Dynamic: Yes

  • Default: ""

  • Type: regex

  • Mandatory: No

  • Dynamic: No

  • Default: ""

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 150s

  • Type: boolean

  • Mandatory: No

  • Dynamic: No

  • Default: false

  • Type: duration

  • Mandatory: No

  • Dynamic: Yes

  • Default: 300s

Settings

  • Type: target

  • Mandatory: Yes

  • Dynamic: No

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

Last updated

Was this helpful?