Initialization

To add the Breeze environment variables to the shell, run the following command as root/Administrator:

• Linux/macOS:

  . /opt/cloudaware/breeze/bin/env.sh
  breeze help

• Windows (Command Prompt):

  call C:\\"Program Files"\\Cloudaware\\Breeze\\bin\\env.cmd
  breeze help

This command will:

1. adds the BREEZE_HOME_DIR environment variable

2. adds the path to the Ruby directory to the PATH environment variable

3. loads the Breeze configuration settings

4. loads Bash completions if enabled (for Bash only)

Synopsis

breeze <subcommand> [options]

Use breeze help <subcommand> for information on a specific subcommand.

Global options

--client-certificate <file> - path to the certificate

--client-private-key <file> - path to the private key

--color, --no-color - colorize log output

-d, --debug, --no-debug - debug mode

--home-dir <directory> - agent home directory

--log-file <file> - path to th log file

--server-url <url> - Breeze server URL

-v, --verbose, --no-verbose - verbose mode

Subcommands

env

Description

Shows Breeze environment variables.

Example

breeze env

help

Description

Describes available commands or one specific command.

Example

breeze help run

run

Description

Runs the Breeze agent.

Options

-l, --local-mode, --no-local-mode - local mode

-p, --plugin <plugin> - run only one plugin

-t, --timeout [seconds] - timeout

Examples

Runs the agent in verbose mode with no timeout:

breeze run -vt

Runs the agent without color output and specified log file:

breeze run --no-color --log-file /path/to/log/file

scheduler

Description

Configure the system scheduler service.

Subcommands

• enable enables Breeze scheduled task

• disable disables Breeze scheduled task

Examples

breeze scheduler enable --verbose

breeze scheduler disable

status

Description

Shows the agent status.

Options

--retries <number> - number of attempts to determine the status of the agent

Example

breeze status

troubleshoot

Description

Troubleshoots the agent.

Examples

breeze troubleshoot

breeze troubleshoot -v

upgrade

Description

Upgrades the agent.

Options

--to-version <version> - upgrade to a specific version

Examples

breeze upgrade

breeze upgrade --to-version 3.0.2

version

Description

Shows the agent version.

Example

breeze version