Breeze 3.0 - Configuration

1 Overview
- 1.1 Linux/macOS
- 1.2 Windows
2 Environment variables
- 2.1 BREEZE_CLIENT_CERTIFICATE
- 2.2 BREEZE_CLIENT_PRIVATE_KEY
- 2.3 BREEZE_COLOR
- 2.4 BREEZE_DEBUG
- 2.5 BREEZE_HOME_DIR
- 2.6 BREEZE_LOCAL_MODE
- 2.7 BREEZE_LOG_FILE
- 2.8 BREEZE_PLUGIN
- 2.9 BREEZE_PREFERRED_DESCRIPTOR
- 2.10 BREEZE_SCHEDULER_USER
- 2.11 BREEZE_SERVER_URL
- 2.12 BREEZE_STATUS_RETRIES
- 2.13 BREEZE_TIMEOUT
- 2.14 BREEZE_VERBOSE
- 2.15 http_proxy
- 2.16 SSL_CERT_FILE

Overview

The configuration file is located in the home directory (see BREEZE_HOME_DIR) of the Breeze agent. Below is a list of environment variables that will be inherited when the agent is started.

Linux/macOS

Filename: etc/env.sh
Format: POSIX-compatible shell (ENV=VALUE without quotes)
Example:
BREEZE_HOME_DIR=/opt/cloudaware/breeze http_proxy=<http://user:password@proxy-host:3128>

Windows

Filename: etc\\env.cmd
Format: Command shell (set ENV=VALUE without quotes)
Example:
set BREEZE_CLIENT_CERTIFICATE=etc\\certificate.crt set BREEZE_CLIENT_PRIVATE_KEY=etc\\private_key.key

Environment variables

BREEZE_CLIENT_CERTIFICATE

Description

Required, String. The path to the client certificate file.

BREEZE_CLIENT_PRIVATE_KEY

Description

Required, String. The path to the client private key file.

BREEZE_COLOR

Description

Optional, Boolean. Color the output of the agent.

Default value

true

BREEZE_DEBUG

Description

Optional, Boolean. Debug mode.

Default value

false

BREEZE_HOME_DIR

Description

Optional, String. The path to the agent's home directory.

Default value

Linux/macOS: /opt/cloudaware/breeze
Windows: C:\\Program Files\\Cloudaware\\Breeze

BREEZE_LOCAL_MODE

Description

Optional, Boolean. For development, run the agent without syncronizing with the Breeze server.

Default value

false

BREEZE_LOG_FILE

Description

Optional, String. The path to the log file. The output will be written to STDOUT by default.

BREEZE_PLUGIN

Description

Optional, String. For development, force the run only the specified plugin.

BREEZE_PREFERRED_DESCRIPTOR

Description

Optional, String. Force the specified instance descriptor to be set if the necessary data for it is available.

Known instance descriptors:

aws - AWS EC2 instance
azure_ss_vm - Azure Scale Set VM
azure_vm - Azure VM
gce - Google Compute Engine instance
intune - Microsoft Intune device
jamf - JAMF device
oracle_iaas_instance - Oracle Cloud Infrastructure instance
physical - Physical device
vmware_vm - VMware VM

BREEZE_SCHEDULER_USER

Description

Optional, String. Specify the user from whom the scheduled task will be launched (Linux/macOS only).

BREEZE_SERVER_URL

Description

Required, String. Breeze server URL.

BREEZE_STATUS_RETRIES

Description

Optional, Integer. The number of attempts to determine the status of the agent with the breeze status command.

Default value

1

BREEZE_TIMEOUT

Description

Optional, Integer. The number of seconds of timeout before the agent starts. Used for a scheduled task.

Default value

Random number from 0 to 30.

BREEZE_VERBOSE

Description

Optional, Boolean. Verbose output mode.

Default value

false

http_proxy

Description

Optional, String. The URL of the proxy server. HTTP_PROXY can be used, but is deprecated.

SSL_CERT_FILE

Description

Optional, String. The path to the custom CA bundle file (can be used with a HTTPS MITM proxies).