AIStor Client Settings

This page covers settings for the AIStor Client mc.

You can establish or modify settings by defining:

an environment variable on the host system prior to starting or restarting the AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO AIStor uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Host credentials

Use this setting to add a temporary alias to use for mc commands. For example, for use with scripting.

MC_HOST_<ALIAS>

Replace <ALIAS> at the end of the environment variable with the alias to set the host for.

This setting does not have a configuration setting option.

The temporary alias uses the AWS s3v4 signature.

Use mc alias set to configure an alias.

Static credentials

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG@play.min.io

Security Token Service (STS) credentials

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io

STS service

Use this setting to add an STS endpoint to use for mc commands.

MC_STS_ENDPOINT_<ALIAS>

Replace <ALIAS> at the end of the environment variable with the alias to set the STS endpoint for.

export MC_STS_ENDPOINT_myalias=https://sts.aistor-operator.svc.cluster.local:4223/sts/ns-1

This setting does not have a configuration setting option.

Web token identity

Use this setting to add a web token identity to use for mc commands.

Supports adding multiple environment variables by alias.

MC_WEB_IDENTITY_TOKEN_FILE_<ALIAS>

Replace <ALIAS> at the end of the environment variable with the alias to set the token for.

export MC_WEB_IDENTITY_TOKEN_FILE_myalias=/var/run/secrets/kubernetes.io/serviceaccount/token

This setting does not have a configuration setting option.

Configuration directory

Specify the path to the configuration folder the AIStor Client should use.

MC_CONFIG_DIR

This setting does not have a configuration setting option.

Progress bar

Disable the AIStor Client progress bar.

MC_QUIET

This setting does not have a configuration setting option.

Disable the pager functionality of the AIStor Client in the CLI. When used, output prints to raw STDOUT instead.

MC_DISABLE_PAGER

This setting does not have a configuration setting option.

Color theme

Disable the color theme used for AIStor Client output.

MC_NO_COLOR

This setting does not have a configuration setting option.

JSON

Enable formatting the output as JSON lines.

MC_JSON

This setting does not have a configuration setting option.

Debug

Enable the debug output.

MC_DEBUG

This setting does not have a configuration setting option.

Disable SSL

Disable SSL certificate verification.

MC_INSECURE

This setting does not have a configuration setting option.

Distributed tracing

Enable OpenTelemetry trace detail for distributed tracing. For more information, see mc support telemetry.

MC_DTRACE

This setting does not have a configuration setting option.

Limit download bandwidth

Limit the download bandwidth the AIStor Client uses for certain commands.

MC_LIMIT_DOWNLOAD

This setting does not have a configuration setting option.

If not specified, the AIStor Client uses all available bandwidth.

Limit client-side download rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. This affects only the download from the local device running the AIStor Client. Valid units include:

B for bytes
K for kilobytes
M for megabytes
G for gigabytes
Ki for kibibytes
Mi for mibibytes
Gi for gibibytes

For example, to limit download rates to no more than 1 GiB/s, use the following on a Linux system:

export MC_LIMIT_DOWNLOAD=1G

Refer to your operating system instructions for equivalent commands on non-Linux systems.

Limit upload bandwidth

Limit the upload bandwidth the AIStor Client uses for certain commands.

MC_LIMIT_UPLOAD

This setting does not have a configuration setting option.

If not specified, the AIStor Client uses all available bandwidth.

Limit client-side upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. This affects only the upload from the local device running the AIStorClient. Valid units include:

B for bytes
K for kilobytes
M for megabytes
G for gigabytes
Ki for kibibytes
Mi for mibibytes
Gi for gibibytes

For example, to limit upload rates to no more than 1 GiB/s, use the following on a Linux system:

export MC_LIMIT_UPLOAD=1G

Refer to your operating system instructions for equivalent commands on non-Linux systems.

SSE-KMS encryption

Encrypt and decrypt options using SSE-KMS with server managed keys.

MC_ENC_KMS

Specify the key with the MC_ENC_KMS environment variable.

This setting does not have a configuration setting option.

SSE-S3 encryption

Encrypt and decrypt options using SSE-S3 with server managed keys.

MC_ENC_S3

Specify the key to use for performing SSE-S3 encryption. The specified value must match the encryption key set in MINIO_KMS_KES_KEY_NAME.

This setting does not have a configuration setting option.

AIStor Client Settings

On this page