Skip to main content

Settings

Most Breeze Agent configuration is file-based and stored in the agent home directory. Use this page as a practical overview, and refer to the Config reference for the complete list of parameters.

Locations

  • Linux/macOS: /opt/breeze-agent
  • Windows: C:\\Program Files\\Breeze

Within the home directory you will typically see:

  • etc/agent.conf — main JSON configuration file.
  • etc/tags — free‑form key=value pairs for classification.
  • app.sh (Linux/macOS)/app.bat (Windows) — launcher scripts used by the scheduler.

Agent Configuration (agent.conf)

  • Path:
    • Linux/macOS: /opt/breeze-agent/etc/agent.conf
    • Windows: C:\\Program Files\\Breeze\\etc\\agent.conf
  • Format: JSON.
  • Core keys (examples):
    • server_url — Breeze Server URL (https://breeze-server.cloudaware.com/).
    • agent_certificate, agent_private_key — paths to the client certificate and key.
    • log_file, log_level — destination and verbosity for logs.
    • lib_dir, plugins_dir — library and plugin directories.
    • Optional tags such as hw_physical, eks.cluster.arn, preferred.descriptor.

For a full description of each key and defaults, see the Config reference.

Tags File

Use the tags file to attach metadata that is not discoverable from the OS or cloud provider APIs:

  • Path:
    • Linux/macOS: /opt/breeze-agent/etc/tags
    • Windows: C:\\Program Files\\Breeze\\etc\\tags

Example:

environment=prod
preferred.descriptor=intune
business_unit=payments

These tags appear in Cloudaware CMDB and can be used for filters, reports, and routing rules.

Scheduler

Breeze is typically not a long‑running daemon; it runs on a schedule:

  • Linux/macOS: systemd timer breeze-agent.timer (or cron file /etc/cron.d/breeze-agent).
  • Windows: Task Scheduler task Breeze Agent.

Changes to configuration take effect on the next scheduled run or when you execute the launcher manually.

Validation

  • Linux/macOS:
    • Run cd /opt/breeze-agent && ./app.sh to validate configuration.
  • Windows:
    • Run the Breeze Agent scheduled task, or start the agent from C:\\Program Files\\Breeze.

In both cases, review logs for parsing or connection errors. See Logging and Troubleshooting for more details.