Breeze Agent 3.x Command Line
Breeze Agent 3.x is managed with a single breeze command.
Load the Agent Environment
The breeze command is not on the system PATH. Before you use it, load the agent environment as root or Administrator. This adds the agent's Ruby to PATH and loads the configuration file.
-
Linux:
sudo -i. /opt/cloudaware/breeze/bin/env.shbreeze help -
Windows (elevated Command Prompt):
call "C:\Program Files\Cloudaware\Breeze\bin\env.cmd"breeze help
In Bash on Linux, loading the environment also enables tab completion for breeze.
Synopsis
breeze <command> [options]
Run breeze help <command> for the options of a command.
| Command | Description |
|---|---|
env | Show the agent's environment variables. |
help | Describe the commands. |
run | Run the agent now. |
scheduler | Enable, disable, or check the scheduled task. |
status | Show whether the agent is running. |
troubleshoot | Diagnose the agent. |
upgrade | Upgrade the agent. |
version | Show the agent version. |
Global Options
These options apply to every command and override the matching configuration variables.
| Option | Description |
|---|---|
-v, --verbose, --no-verbose | Verbose output. |
-d, --debug, --no-debug | Debug output. |
--color, --no-color | Colored output. |
--log-file <file> | Write the log to a file instead of standard output. |
--server-url <url> | Breeze server URL. |
--client-certificate <file> | Path to the client certificate. |
--client-private-key <file> | Path to the client private key. |
env
Shows the environment variables the agent uses: the BREEZE_* variables, the proxy variables, and SSL_CERT_FILE.
breeze env
help
Describes all commands, or one command.
breeze help
breeze help run
run
Runs the agent once, in the foreground. The scheduled task runs the same command every 15 minutes.
| Option | Description |
|---|---|
-t, --timeout [seconds] | Seconds to wait before the run starts. -t without a value starts immediately. Without this option the agent waits a random 0 to 30 seconds. |
-p, --plugin <plugin> | Run only the named plugin. |
Run the agent immediately, with verbose output:
breeze run -vt
Run one plugin immediately, with debug output:
breeze run -dt -p facter3
If the agent is already running, for example from the scheduled task, breeze run exits without starting a second run.
scheduler
Manages the scheduled task that runs the agent every 15 minutes: a systemd timer or cron job on Linux, and the Cloudaware\Breeze task on Windows.
| Command | Description |
|---|---|
breeze scheduler enable | Create the scheduled task. On Linux, -u <user> runs it as that user. |
breeze scheduler disable | Remove the scheduled task. The agent stays installed but stops running. |
breeze scheduler status | Print enabled or disabled. |
Stop the agent from running without uninstalling it:
breeze scheduler disable
Start it again:
breeze scheduler enable
status
Prints running while the agent is running and stopped otherwise.
breeze status
| Option | Description |
|---|---|
--retries <number> | Number of attempts to determine the status. |
troubleshoot
Checks the agent installation and its connection to Cloudaware, and reports the problems it finds. Attach its output when you contact Cloudaware Support.
breeze troubleshoot
breeze troubleshoot -v
upgrade
Upgrades the agent to the latest available version, or to a specific one.
breeze upgrade
breeze upgrade --to-version 3.0.8
| Option | Description |
|---|---|
--to-version <version> | Install this version. |
The agent also upgrades itself when Cloudaware raises the minimum agent version, so you do not normally need this command.
version
Shows the agent version.
breeze version