Breeze Agent 3.x Configuration
Breeze Agent 3.x reads its settings from environment variables. The agent loads them from a configuration file in its directory every time it starts, whether it runs from the scheduler or from the command line.
Configuration File
| Linux | Windows | |
|---|---|---|
| File | /opt/cloudaware/breeze/etc/vars.sh | C:\Program Files\Cloudaware\Breeze\etc\vars.cmd |
| Format | VARIABLE=value, one per line, no quotes | set VARIABLE=value, one per line, no quotes |
The installer writes the agent's server address and certificate paths into this file. Add your own settings on new lines below them.
Linux example:
BREEZE_SERVER_URL=https://...
BREEZE_CLIENT_CERTIFICATE=etc/...
BREEZE_CLIENT_PRIVATE_KEY=etc/...
http_proxy=http://proxy.example.com:3128
BREEZE_PREFERRED_DESCRIPTOR=vmware_vm
Windows example:
set BREEZE_SERVER_URL=https://...
set BREEZE_CLIENT_CERTIFICATE=etc\...
set BREEZE_CLIENT_PRIVATE_KEY=etc\...
set http_proxy=http://proxy.example.com:3128
set BREEZE_PREFERRED_DESCRIPTOR=vmware_vm
Changes apply from the next run. Running the installer again replaces this file, so reapply your changes after a reinstall.
To see the values the agent uses, run breeze env. See Command Line.
Connection
These variables are set by the installer. Do not change them unless Cloudaware Support asks you to.
| Variable | Description |
|---|---|
BREEZE_SERVER_URL | Breeze server URL. |
BREEZE_CLIENT_CERTIFICATE | Path to the agent's client certificate, relative to the agent directory. |
BREEZE_CLIENT_PRIVATE_KEY | Path to the agent's private key, relative to the agent directory. |
Proxy
| Variable | Description |
|---|---|
http_proxy | Proxy URL, for example http://proxy.example.com:3128 or http://user:password@proxy.example.com:3128. HTTP_PROXY also works but is deprecated. |
NO_PROXY | Comma-separated hosts that bypass the proxy. |
On AWS, Azure, Google Cloud, and Oracle Cloud, exclude the instance metadata service from the proxy, so the agent can identify the instance:
http_proxy=http://proxy.example.com:3128
NO_PROXY=localhost,127.0.0.1,169.254.169.254
An installer that Cloudaware built with your proxy already contains both lines.
Custom CA Bundle
| Variable | Description |
|---|---|
SSL_CERT_FILE | Path to a CA bundle file in PEM format. |
Set it when a proxy inspects TLS traffic and presents its own certificate. The bundle must contain your proxy's CA certificate and the public CAs the agent needs, because it replaces the agent's built-in bundle.
Preferred Descriptor
| Variable | Description |
|---|---|
BREEZE_PREFERRED_DESCRIPTOR | The descriptor to register the host with in Cloudaware CMDB. |
The agent chooses a descriptor for each host, and the descriptor decides which CMDB object the host is linked to, for example an AWS EC2 instance or a VMware VM. Set a preferred descriptor when a host matches more than one, and the agent picks the one you do not want.
The setting applies only if the host actually matches the descriptor. Otherwise the agent ignores it and chooses as usual. physical always applies.
| Descriptor | Host |
|---|---|
aws | AWS EC2 instance |
aws_eks_cluster | Amazon EKS cluster |
azure_vm | Azure virtual machine |
azure_ss_vm | Azure Virtual Machine Scale Set instance |
azure_aks_cluster | Azure AKS cluster |
gce | Google Compute Engine instance |
gke_cluster | Google GKE cluster |
kubernetes_cluster | Other Kubernetes cluster |
intune | Microsoft Intune device |
nutanix_vm | Nutanix AHV virtual machine |
oracle_iaas_instance | Oracle Cloud Infrastructure instance |
vmware_vm | VMware virtual machine |
physical | Physical server |
The Kubernetes descriptors apply only to an agent running inside a cluster.
Logging and Output
| Variable | Default | Description |
|---|---|---|
BREEZE_LOG_FILE | none | Path to a log file. Without it, the agent writes to standard output. Scheduled runs always log to var/log/breeze.log. |
BREEZE_VERBOSE | false | Verbose output. |
BREEZE_DEBUG | false | Debug output. Use it when Cloudaware Support asks for a debug log. |
BREEZE_COLOR | true | Colored output. |
Scheduling
| Variable | Default | Description |
|---|---|---|
BREEZE_TIMEOUT | random, 0 to 30 | Seconds to wait before a run starts, so that many hosts do not contact Cloudaware at the same moment. When set, it also overrides breeze run -t. |
BREEZE_SCHEDULER_USER | root | Linux only. The user the scheduled task runs as. The installer sets it when you install with -u. It takes effect when the scheduled task is created, so after changing it run breeze scheduler disable and then breeze scheduler enable. See Run as a Non-Root User. |
BREEZE_STATUS_RETRIES | 1 | Number of attempts breeze status makes to determine the agent status. |