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