client-agent diagnostics

Command: boundary client-agent diagnostics

The client-agent diagnostics command lets you create a diagnostics ZIP bundle from the Client Agent.

Support uses this bundle to investigate and troubleshoot Client Agent connectivity, DNS, and configuration issues when you share the bundle.

You can start a diagnostics run, check its status, and cancel a run that is in progress.

Example

The following command starts a diagnostics run and waits for it to complete:

$ boundary client-agent diagnostics run

Usage

Usage: boundary client-agent diagnostics <subcommand> [options] [args]

  # ...

Subcommands:
    cancel      Cancel a diagnostics run on the Boundary Client Agent
    run         Start a diagnostics run on the Boundary Client Agent
    status      Get the status of a diagnostics run on the Boundary Client Agent

Subcommands

The client-agent diagnostics command has three subcommands: run, status, and cancel.

The client-agent diagnostics run command starts a diagnostics run on the Client Agent and creates a ZIP bundle that you can share with Support to help investigate the issue.

By default, the command runs synchronously. It waits for the run to complete and prints progress updates as they occur. If you interrupt the command before the run finishes, it cancels the run.

Use the async option to start the run and return immediately without waiting for it to complete.

Examples

The following command starts a diagnostics run and waits for it to complete:

$ boundary client-agent diagnostics run

The following command starts a diagnostics run and returns immediately:

$ boundary client-agent diagnostics run -async

The following command saves the diagnostics bundle to a specified path:

$ boundary client-agent diagnostics run -output-path /tmp/diagnostics.zip

Usage

$ boundary client-agent diagnostics run [options] [args]

Command options

async - Returns immediately after starting the diagnostics run without waiting for it to complete.
output-path=<string> - Specifies the absolute path where the Client Agent writes the diagnostics bundle, including the file name and .zip extension. If you omit this option, the Client Agent saves the bundle to your Downloads directory by default.
client-agent-port=<uint> - Specifies the port on which the Client Agent listens. You can also specify the port using the BOUNDARY_CLIENT_AGENT_LISTENING_PORT environment variable.

The client-agent diagnostics status command checks the status of a diagnostics run on the Client Agent. By default, the command checks the status once and returns immediately.

Use the watch option to poll the status until the diagnostics run completes or fails. Interrupting the command while it watches the status only stops the CLI; it does not cancel the run.

Examples

The following command checks the current status of a diagnostics run:

$ boundary client-agent diagnostics status

The following command polls the status until the diagnostics run completes or fails:

$ boundary client-agent diagnostics status -watch

Usage

$ boundary client-agent diagnostics status [options] [args]

Command options

watch - Polls until the diagnostics run completes or fails.
client-agent-port=<uint> - Specifies the port on which the Client Agent listens. You can also specify the port using the BOUNDARY_CLIENT_AGENT_LISTENING_PORT environment variable.

The client-agent diagnostics cancel command cancels an in-progress diagnostics run on the Client Agent.

Example

The following command cancels an in-progress diagnostics run:

$ boundary client-agent diagnostics cancel

Usage

$ boundary client-agent diagnostics cancel [options] [args]

Command options

client-agent-port=<uint> - Specifies the port on which the Client Agent listens. You can also specify the port using the BOUNDARY_CLIENT_AGENT_LISTENING_PORT environment variable.

CLI options

In addition to the command specific options, there are options common to all CLI commands and subcommands: